Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@loyldg
loyldg committed Feb 23, 2024
1 parent 94f416e commit f7030f7
Showing 1 changed file with 43 additions and 208 deletions.
251 changes: 43 additions & 208 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,31 +1,37 @@
# MyTelegram
[![API Layer](https://img.shields.io/badge/API_Layer-170-blueviolet)](https://corefork.telegram.org/methods)

[![API Layer](https://img.shields.io/badge/API_Layer-173-blueviolet)](https://corefork.telegram.org/methods)
[![MTProto](https://img.shields.io/badge/MTProto_Protocol-2.0-green)](https://corefork.telegram.org/mtproto/)
[![Support Chat](https://img.shields.io/badge/Chat_with_us-on_Telegram-0088cc)](https://t.me/+S-aNBoRvCRpPyXrR)

MyTelegram is [Telegram server side api](https://core.telegram.org/api) implementation written in c#,support private deployment

## Features
* API Layer: **`170`**
* [MTProto transports](https://corefork.telegram.org/mtproto/mtproto-transports): **`Abridged`**,**`Intermediate`**
* Private chat
* Group chat
* Supergroup chat
* Channel
* End-to-end-encryption chat(Pro version)
* Voice/video call(Pro version)
* Bot(Partial support,Pro version)
* 2FA(Pro version)
* Stickers(Pro version)
* Reactions(Pro version)
* ForumTopics(Pro version)

- API Layer: **`173`**
- [MTProto transports](https://corefork.telegram.org/mtproto/mtproto-transports): **`Abridged`**,**`Intermediate`**
- Private chat
- Group chat
- Supergroup chat
- Channel
- End-to-end-encryption chat(Pro version)
- Voice/video call(Pro version)
- Bot(Partial support,Pro version)
- 2FA(Pro version)
- Stickers(Pro version)
- Reactions(Pro version)
- ForumTopics(Pro version)

## Build MyTelegram Server

1. Install [.NET SDK 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
2. Run `build/build.ps1` ([PowerShell7+](https://github.com/PowerShell/PowerShell))
3. Build output folder is `out/{version}`

## Build docker images

Run the following scripts

```
build\docker\1.build-messenger-command-server.sh
build\docker\2.build-messenger-query-server.sh
Expand All @@ -34,223 +40,52 @@ build\docker\4.build-sms-sender.sh
build\docker\5.build-gateway-server.sh
```


## Run MyTelegram server

- ### Run MyTelegram server with docker

1. Download docker-compose configuration files
```
https://github.com/loyldg/mytelegram/blob/dev/docker/compose/docker-compose.yml
https://github.com/loyldg/mytelegram/blob/dev/docker/compose/.env
```
2. Change the IP address configuration in **.env**,replace `192.168.1.100` with the IP address of gateway server
```
https://github.com/loyldg/mytelegram/blob/dev/docker/compose/docker-compose.yml
https://github.com/loyldg/mytelegram/blob/dev/docker/compose/.env
```
2. Change the IP address in **.env**,replace `192.168.1.100` with the IP address of gateway server
3. Run the following command in the directory where the docker-compose.yml file is located
```
docker compose up
```
```
docker compose up
```

- ### Run MyTelegram manually

1. Download mytelegram server from [https://github.com/loyldg/mytelegram/releases](https://github.com/loyldg/mytelegram/releases)
2. Install Redis
3. Install MongoDB
4. Intall RabbitMQ
5. Install Minio
6. Modify server configuration in `start-all.bat`/`start-all.sh`,replace `192.168.1.100` with the IP address of gateway server
7. Run `start-all.bat`/`start-all.sh`
- ### Test with compiled client
1. Download [TDesktop client(v4.14)](https://github.com/loyldg/mytelegram/releases/download/v0.16.109/Telegram-4.14-x64.zip)
2. Add the IP address of the gateway server to hosts file(`%SystemRoot%/system32/drivers/etc/hosts`),for example, the IP address of the gateway server is `192.168.1.100`,add the following line to hosts file
```
192.168.1.100 demos2.mytelegram.top
```
3. Run Telegram.exe
8. Run telegram client
4. Default verification code is `22222`

## Build Telegram client
For all clients,only need to replace server address and RSA public key,and then follow the offical documents to build it
> Tips:The default TCP port is 20443,default HTTPS port is 30443,default HTTP port is 30444,you need this port when compile the clients,Tdesktop client/Android client/iOS client use tcp port 20443,Web client use 30443(HTTPS)/30444(HTTP)
Public key:
```
-----BEGIN RSA PUBLIC KEY-----
MIIBCgKCAQEAu+3tvscWDAlEvVylTeMr5FpU2AjgqzoQHPjzp69r0YAtq0a8rX0M
Ue78F/FRAqBaEbZW6WBzF3AjOlNYpOtvvwGhl9rGCgziunbd9nwcKJBMDWS9O7Mz
/8xjz/swIB4V56XcjOhrjUHJ/GniFKoum00xeEcYnr5xnLesvpVMq97Ga6b+xt3H
RftHY/Zy1dG5zs8upuiAOlEiKilhu1IthfMjFG3NF6TiGrO9YU3YixFbJy67jtHk
v5FarscM2fC5iWQ2eP1y6jXR64sGU3QjncvozYOePrH9jGcnmzUmj42x/H28IjJQ
9EjEc22sPOuauK0IF2QiCGh+TfsKCK189wIDAQAB
-----END RSA PUBLIC KEY-----
```
PKCS#1 format
```
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAu+3tvscWDAlEvVylTeMr
5FpU2AjgqzoQHPjzp69r0YAtq0a8rX0MUe78F/FRAqBaEbZW6WBzF3AjOlNYpOtv
vwGhl9rGCgziunbd9nwcKJBMDWS9O7Mz/8xjz/swIB4V56XcjOhrjUHJ/GniFKou
m00xeEcYnr5xnLesvpVMq97Ga6b+xt3HRftHY/Zy1dG5zs8upuiAOlEiKilhu1It
hfMjFG3NF6TiGrO9YU3YixFbJy67jtHkv5FarscM2fC5iWQ2eP1y6jXR64sGU3Qj
ncvozYOePrH9jGcnmzUmj42x/H28IjJQ9EjEc22sPOuauK0IF2QiCGh+TfsKCK18
9wIDAQAB
-----END PUBLIC KEY-----
```
The default fingerprint of the public key is **`0xce27f5081215bda4`**(Android client need calculate fingerprint and replace it using this value),
if you want to use your own public key,replace `private.pkcs8.key` in auth folder
- ### Build [Tdesktop client](https://github.com/telegramdesktop/tdesktop)
1. Switch to the branch which the layer is 170(version 4.14.x+)
2. Replace server addresses,port and RSA public key in **Telegram/SourceFiles/mtproto/mtproto_dc_options.cpp**
- ### Build [Android client](https://github.com/DrKLO/Telegram)
1. Switch to the branch which the layer is **170**
2. **Telegram\TMessagesProj\src\main\java\org\telegram\ui\Components\StickerEmptyView.java** Mytelegram not support Stickers in current version,need comment the following code in method `setSticker`
``` java
MediaDataController.getInstance(currentAccount).loadStickersByEmojiOrName(AndroidUtilities.STICKERS_PLACEHOLDER_PACK_NAME, false, set == null);
stickerView.getImageReceiver().clearImage();
```
3. **Telegram\TMessagesProj\jni\tgnet\ConnectionsManager.cpp** Replace server ip address and port using gateway server's ip and port
4. **Telegram\TMessagesProj\jni\tgnet\Datacenter.cpp** Replace RSA public key in method `decodeSimpleConfig`
5. **Telegram\TMessagesProj\jni\tgnet\Handshake.cpp** Replace RSA public key and fingerprint in method `processHandshakeResponse`
## MyTelegram clients
[TDesktop for mytelegram](https://github.com/loyldg/mytelegram-tdesktop)

- ### Build [iOS client](https://github.com/TelegramMessenger/Telegram-iOS)
Coming soon
- ### Build [Telegram Web K](https://github.com/morethanwords/tweb)
1. Make sure the client layer is 170,check it in **src\scripts\out\schema.json**
2. **src\lib\mtproto\rsaKeysManager.ts** Replace **modulus** with the following value
```
bbededbec7160c0944bd5ca54de32be45a54d808e0ab3a101cf8f3a7af6bd1802dab46bcad7d0c51eefc17f15102a05a11b656e960731770233a5358a4eb6fbf01a197dac60a0ce2ba76ddf67c1c28904c0d64bd3bb333ffcc63cffb30201e15e7a5dc8ce86b8d41c9fc69e214aa2e9b4d317847189ebe719cb7acbe954cabdec66ba6fec6ddc745fb4763f672d5d1b9cecf2ea6e8803a51222a2961bb522d85f323146dcd17a4e21ab3bd614dd88b115b272ebb8ed1e4bf915aaec70cd9f0b989643678fd72ea35d1eb8b065374239dcbe8cd839e3eb1fd8c67279b35268f8db1fc7dbc223250f448c4736dac3ceb9ab8ad0817642208687e4dfb0a08ad7cf7
```
3. **src\config\modes.ts**
Line 18 change `ssl: true` to `ssl: false`
4. **src\lib\mtproto\dcConfigurator.ts**
Line 52:
```
export function constructTelegramWebSocketUrl(dcId: DcId, connectionType: ConnectionType, premium?: boolean) {
const suffix = getTelegramConnectionSuffix(connectionType);
const path = connectionType !== 'client' ? 'apiws' + TEST_SUFFIX + (premium ? PREMIUM_SUFFIX : '') : ('apiws' + TEST_SUFFIX);
const chosenServer = `wss://${App.suffix.toLowerCase()}ws${dcId}${suffix}.web.telegram.org/${path}`;
[Android client for mytelegram](https://github.com/loyldg/mytelegram-android)

return chosenServer;
}
```
replace with:
```
export function constructTelegramWebSocketUrl(dcId: DcId, connectionType: ConnectionType, premium?: boolean) {
return 'ws://The IPAddress of your gateway server:30444/apiws';
}
```
Line 64:
replace the IPAddress and port
5. **src\lib\appManagers\appEmojiManager.ts**
Line 254: add `docIds=docIds.filter(p=>p!=undefined);`
[iOS client for mytelegram](https://github.com/loyldg/mytelegram-iOS)

- ### Build [Telegram Web A](https://github.com/Ajaxy/telegram-tt)
1. Make sure the client layer is **170**,check it in **src\lib\gramjs\tl\AllTLObjects.js**
2. **src\api\gramjs\gramjsBuilders\index.ts**
Line 39:
`const CHANNEL_ID_MIN_LENGTH = 11; ` to `const CHANNEL_ID_MIN_LENGTH = 13; `
Line 42:
`return id.startsWith('-100')` to `return id.startsWith('-800')`
3. **src\api\gramjs\methods\client.ts**
Line 89: `useWSS: true,` to `useWSS: false,`
[WebK for mytelegram](https://github.com/loyldg/mytelegram-webk)

4. **src\api\gramjs\methods\calls.ts**
Line 307: `userId: buildInputPeer(user.id, user.accessHash),`
to `userId: new GramJs.InputUser({ userId: BigInt(user.id), accessHash: BigInt(user.accessHash!) }),`
[WebA for mytelegram](https://github.com/loyldg/mytelegram-weba)

5. **src\api\gramjs\methods\users.ts**
Line 159:
```
const result = await invokeRequest(new GramJs.users.GetUsers({
id: users.map(({ id, accessHash }) => buildInputPeer(id, accessHash)),
}));
```
to
```
const result = await invokeRequest(new GramJs.users.GetUsers({
id: users.map(({ id, accessHash }) => new GramJs.InputUser({ userId: BigInt(id), accessHash: BigInt(accessHash!) })),
}));
```
6. **src\lib\gramjs\Utils.js**
Line 644:
to
```
return { id: 2, ipAddress: 'Your Server IP', port: 30444 };
```
7. **src\lib\gramjs\client\TelegramClient.js**
Line 255:
to
```
this.session.setDC(this.defaultDcId, DC.ipAddress, this._args.useWSS ? 30443 : 30444);
```
8. **src\lib\gramjs\crypto\RSA.ts**
Replace SERVER_KEYS with the following code
```typescript
export const SERVER_KEYS = [
{
fingerprint: bigInt('-3591632762792723036'),
n: bigInt('bbededbec7160c0944bd5ca54de32be45a54d808e0ab3a101cf8f3a7af6bd1802dab46bcad7d0c51eefc17f15102a05a11b656e960731770233a5358a4eb6fbf01a197dac60a0ce2ba76ddf67c1c28904c0d64bd3bb333ffcc63cffb30201e15e7a5dc8ce86b8d41c9fc69e214aa2e9b4d317847189ebe719cb7acbe954cabdec66ba6fec6ddc745fb4763f672d5d1b9cecf2ea6e8803a51222a2961bb522d85f323146dcd17a4e21ab3bd614dd88b115b272ebb8ed1e4bf915aaec70cd9f0b989643678fd72ea35d1eb8b065374239dcbe8cd839e3eb1fd8c67279b35268f8db1fc7dbc223250f448c4736dac3ceb9ab8ad0817642208687e4dfb0a08ad7cf7',16),
e: 65537
}
].reduce((acc, { fingerprint, ...keyInfo }) => {
acc.set(fingerprint.toString(), keyInfo);
return acc;
}, new Map<string, { n: bigInt.BigInteger; e: number }>());
```
9. **src\lib\gramjs\extensions\PromisedWebSockets.js**
Line 67:
```
getWebSocketLink(ip, port, testServers, isPremium) {
if (port === 443) {
return `wss://${ip}:${port}/apiws${testServers ? '_test' : ''}${isPremium ? '_premium' : ''}`;
} else {
return `ws://${ip}:${port}/apiws${testServers ? '_test' : ''}${isPremium ? '_premium' : ''}`;
}
}
```
to
```
getWebSocketLink(ip, port, testServers, isPremium) {
if (port === 30443) {
return `wss://${ip}:${port}/apiws${testServers ? '_test' : ''}${isPremium ? '' : ''}`;
} else {
return `ws://${ip}:${port}/apiws${testServers ? '_test' : ''}${isPremium ? '' : ''}`;
}
}
```
10. **src\lib\gramjs\network\Authenticator.ts**
Line 47:
```typescript
const pqInnerData = new Api.PQInnerData({
pq: Helpers.getByteArray(pq), // unsigned
p: pBuffer,
q: qBuffer,
nonce: resPQ.nonce,
serverNonce: resPQ.serverNonce,
newNonce,
}).getBytes();
```
to
```typescript
const pqInnerData = new Api.PQInnerDataDc({
pq: Helpers.getByteArray(pq), // unsigned
p: pBuffer,
q: qBuffer,
nonce: resPQ.nonce,
serverNonce: resPQ.serverNonce,
newNonce,
dc: 2
}).getBytes();
```
11. **\webpack.config.ts**
Line 43:
```
connect-src 'self' wss://*.web.telegram.org blob: http: https: ${APP_ENV === 'development' ? 'wss:' : ''};
```
Replace **wss://*.web.telegram.org** with your server address(ws://192.168.1.100)
1. Git clone the client source code
2. Replace `192.168.1.100` with your server IP

## Support MyTelegram

Love MyTelegram? Please give a star to this repository ⭐

## Feedback

Contact author:[https://t.me/mytelegram666](https://t.me/mytelegram666)
Join telegram group:[https://t.me/+S-aNBoRvCRpPyXrR](https://t.me/+S-aNBoRvCRpPyXrR)
Join telegram group:[https://t.me/+S-aNBoRvCRpPyXrR](https://t.me/+S-aNBoRvCRpPyXrR)

0 comments on commit f7030f7

Please sign in to comment.