Skip to content

Latest commit

 

History

History
150 lines (94 loc) · 4.18 KB

README.md

File metadata and controls

150 lines (94 loc) · 4.18 KB
Raw

The more recent code is here: https://github.com/PluralityNET/PluralGramServer

OBSOLETE INFO BELOW

nebula-chat's chatengine: i2pgram fork

An open source mtproto server engine implemented in go language with compatible Telegram clients.

Quick start

  1. Run sudo apt install docker docker-compose in your shell;
  2. git clone --recursive [email protected]:i2pgram/chatengine.git && cd chatengine
  3. Edit ./docker-compose.yml: replace timezone with your own. There were reports that having a wrong timezone makes chatengine fail.
  4. Run sudo make command in your shell;
  5. Now, chatengine is running on your host's TCP port 12345;
  6. Use i2pgram clients to connect to nebula-chat chatengine;
  7. Enjoy!

The rest of this README is for developers

Architecture

Architecture

Documents

Diffie–Hellman key exchange

Creating an Authorization Key

Mobile Protocol: Detailed Description (v.1.0, DEPRECATED)

Encrypted CDNs for Speed and Security Translate By @steedfly

Windows-Build By @robinfoxnan

Manual Build and Install

Dependencies

  • redis
  • mysql
  • etcd

Build

  • Get source code　
mkdir -p $GOPATH/src/github.com/nebula-chat/
cd $GOPATH/src/github.com/nebula-chat/
git clone https://github.com/nebula-chat/chatengine.git
  • Build
    build frontend
        cd $GOPATH/src/github.com/nebula-chat/chatengine/access/frontend
        go build
    
    build auth_key
        cd $GOPATH/src/github.com/nebula-chat/chatengine/access/auth_key
        go build

    build auth_session
        cd $GOPATH/src/github.com/nebula-chat/chatengine/service/auth_session
        go build
        
    build sync
        cd $GOPATH/src/github.com/nebula-chat/chatengine/messenger/sync
        go build
    
    build upload
        cd $GOPATH/src/github.com/nebula-chat/chatengine/messenger/upload
        go build
    
    build document
        cd $GOPATH/src/github.com/nebula-chat/chatengine/service/document
        go build

    build biz_server
        cd $GOPATH/src/github.com/nebula-chat/chatengine/messenger/biz_server
        go build
        
    build session
        cd $GOPATH/src/github.com/nebula-chat/chatengine/access/session
        go build
  • Run
    cd $GOPATH/src/github.com/nebula-chat/chatengine/service/auth_session
    ./auth_session
    
    cd $GOPATH/src/github.com/nebula-chat/chatengine/service/document
    ./document

    cd $GOPATH/src/github.com/nebula-chat/chatengine/messenger/sync
    ./sync
    
    cd $GOPATH/src/github.com/nebula-chat/chatengine/messenger/upload
    ./upload

    cd $GOPATH/src/github.com/nebula-chat/chatengine/messenger/biz_server
    ./biz_server

    cd $GOPATH/src/github.com/nebula-chat/chatengine/access/auth_key
    ./auth_key

    cd $GOPATH/src/github.com/nebula-chat/chatengine/access/session
    ./session
    
    cd $GOPATH/src/github.com/nebula-chat/chatengine/access/frontend
    ./frontend

More

Build document

Build script

Prerequisite script

SQL

You need all scripts/*.sql.

Compatible clients

Important: default signIn and signOut verify code is 12345

Android client for NebulaChat

FOSS client for NebulaChat

iOS client for NebulaChat

tdesktop for NebulaChat

Original chatengine author's notes

Chatengine is not a commercial project, only supports mtproto API layer 86, and only supports private chats and small groups.

If need enterprise edition, please PM the author or download clients from nebula.chat (default verify code is: 12345).