Unverified Commit e5d31faf authored by vysheng's avatar vysheng Committed by GitHub

Update README

parent cc7b7097
to build simply run 'make'. Your binary will be objs/bin/mtproto-proxy to build, simply run 'make'. Your binary will be objs/bin/mtproto-proxy
to run mtproto-proxy: to run mtproto-proxy:
1. Obtain secret, which is used to connect to telegram servers. 1. Obtain a secret, used to connect to telegram servers.
curl -s https://digitalresistance.dog/getSecret -o proxy-secret curl -s https://digitalresistance.dog/getSecret -o proxy-secret
2. Obtail current telegram configuration. It can (rarely) change, so we encourage you to update it once per day. 2. Obtail current telegram configuration. It can change (occasionally), so we encourage you to update it once per day.
curl -s https://digitalresistance.dog/getConfig -o proxy-multi.conf curl -s https://digitalresistance.dog/getConfig -o proxy-multi.conf
3. Generate secret, which is used by users to connect to proxy 3. Generate a secret to be used by users to connect to your proxy
head -c 16 /dev/urandom | xxd -ps head -c 16 /dev/urandom | xxd -ps
4. Run mtproto-proxy 4. Run mtproto-proxy
mtproto-proxy -u nobody -p 8888 -H 443 -S <secret> --aes-pwd proxy-secret proxy-multi.conf -M 1 mtproto-proxy -u nobody -p 8888 -H 443 -S <secret> --aes-pwd proxy-secret proxy-multi.conf -M 1
where: where:
- nobody is user name. mtproto-proxy calls setuid() to drop privilegies - nobody is the user name. mtproto-proxy calls setuid() to drop privilegies
- 443 is port, used by clients to connect to proxy - 443 is the port, used by clients to connect to the proxy
- 8888 is local port. You can use it to get statistics from mtproto. Like wget localhost:8888/stats - 8888 is the local port. You can use it to get statistics from mtproto. Like wget localhost:8888/stats
You can only get this stat via loopback You can only get this stat via loopback
- <secret> is secret generated on step 3. - <secret> is the secret generated at step 3.
- proxy-secret and proxy-multi.conf are obtains on steps 1 and 2 - proxy-secret and proxy-multi.conf are obtained at steps 1 and 2
- 1 is number of workers. You can increase number of workers, if you have powerful server - 1 is the number of workers. You can increase the number of workers, if you have a powerful server
- also feel free to look on other options in mtproto-prodxy help - also feel free to check out other options using mtproto-prodxy help
5. generate link tg://proxy?server=SERVER_NAME&port=443&secret=SECRET 5. generate the link tg://proxy?server=SERVER_NAME&port=443&secret=SECRET
6. enjoy 6. register your proxy with @MTProxybot on Telegram.
7. enjoy
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment