mirror of
https://github.com/alexbers/mtprotoproxy.git
synced 2026-03-13 23:03:09 +00:00
35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
# Async MTProto Proxy #
|
|
|
|
Fast and simple to setup MTProto proxy written in Python.
|
|
|
|
## Starting Up ##
|
|
|
|
1. `git clone -b stable https://github.com/alexbers/mtprotoproxy.git; cd mtprotoproxy`
|
|
2. *(optional, recommended)* edit *config.py*, set **PORT**, **USERS** and **AD_TAG**
|
|
3. `docker-compose up -d` (or just `python3 mtprotoproxy.py` if you don't like Docker)
|
|
4. *(optional, get a link to share the proxy)* `docker-compose logs`
|
|
|
|
|
|
|
|
## Channel Advertising ##
|
|
|
|
To advertise a channel get a tag from **@MTProxybot** and put it to *config.py*.
|
|
|
|
## Performance ##
|
|
|
|
The proxy performance should be enough to comfortably serve about 4 000 simultaneous users on
|
|
the VDS instance with 1 CPU core and 1024MB RAM.
|
|
|
|
## More Instructions ##
|
|
|
|
- [Running without Docker](https://github.com/alexbers/mtprotoproxy/wiki/Running-Without-Docker)
|
|
- [Optimization and fine tuning](https://github.com/alexbers/mtprotoproxy/wiki/Optimization-and-Fine-Tuning)
|
|
|
|
## Advanced Usage ##
|
|
|
|
The proxy can be launched:
|
|
- with a custom config: `python3 mtprotoproxy.py [configfile]`
|
|
- several times, clients will be automaticaly balanced between instances
|
|
- with uvloop module to get an extra speed boost
|
|
- with runtime statistics exported to [Prometheus](https://prometheus.io/)
|