README.md

# 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`

![Demo](https://alexbers.com/mtprotoproxy/install_demo_v2.gif)

## 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/)
channel advertising support 2018-06-03 23:14:11 +05:00			`# Async MTProto Proxy #`
init commit 2018-05-27 15:12:17 +05:00
update readme 2019-09-19 00:08:20 +05:00			`Fast and simple to setup MTProto proxy written in Python.`
init commit 2018-05-27 15:12:17 +05:00
channel advertising support 2018-06-03 23:14:11 +05:00			`## Starting Up ##`
init commit 2018-05-27 15:12:17 +05:00
use stable branch in README 2018-06-15 12:15:18 +05:00			1. `git clone -b stable https://github.com/alexbers/mtprotoproxy.git; cd mtprotoproxy`
channel advertising support 2018-06-03 23:14:11 +05:00			`2. (optional, recommended) edit config.py, set PORT, USERS and AD_TAG`
small readme fixes 2019-08-19 19:16:36 +05:00			3. `docker-compose up -d` (or just `python3 mtprotoproxy.py` if you don't like Docker)
change readme 2019-08-21 02:03:55 +05:00			4. (optional, get a link to share the proxy) `docker-compose logs`
channel advertising support 2018-06-03 23:14:11 +05:00
Update README.md 2019-08-21 03:06:20 +05:00			`![Demo](https://alexbers.com/mtprotoproxy/install_demo_v2.gif)`
Update README.md 2019-08-21 02:05:57 +05:00
Readme micropatch 2018-06-03 23:17:00 +05:00			`## Channel Advertising ##`
channel advertising support 2018-06-03 23:14:11 +05:00
change readme 2019-08-21 02:03:55 +05:00			`To advertise a channel get a tag from @MTProxybot and put it to config.py.`
prepare release 2018-06-15 12:08:20 +05:00
			`## Performance ##`

			`The proxy performance should be enough to comfortably serve about 4 000 simultaneous users on`
Add a section about advanced usage 2018-06-27 18:25:40 +05:00			`the VDS instance with 1 CPU core and 1024MB RAM.`

Add wiki links to readme 2019-12-14 14:55:10 +05:00			`## 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)`

Add a section about advanced usage 2018-06-27 18:25:40 +05:00			`## Advanced Usage ##`

			`The proxy can be launched:`
			- with a custom config: `python3 mtprotoproxy.py [configfile]`
			`- several times, clients will be automaticaly balanced between instances`
advice to use uvloop instead of PyPy interpreter. The uvloop gives a better speed and memory consumption 2019-08-25 03:05:45 +05:00			`- with uvloop module to get an extra speed boost`
update readme 2019-09-19 00:08:20 +05:00			`- with runtime statistics exported to [Prometheus](https://prometheus.io/)`