Metadata-Version: 2.1
Name: mtprotoproxy
Version: 1.0.0
Summary: Async MTProto Proxy
Home-page: https://github.com/alexbers/mtprotoproxy
Author: Alexander Bersenev
Author-email: bay@hackerdom.ru
Maintainer: Alexander Bersenev
Maintainer-email: bay@hackerdom.ru
License: MIT
Platform: UNKNOWN
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Provides-Extra: uvloop
Requires-Dist: pycryptodome (!=3.6.2,~=3.6)
Provides-Extra: uvloop
Requires-Dist: uvloop (~=0.10.1); extra == 'uvloop'

# Async MTProto Proxy #

Fast and simple to setup mtproto proxy.

## 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 --build -d` (or just `python3 mtprotoproxy.py` if you don't like docker)
4. *(optional, shows telegram link to set the proxy)* `docker-compose logs`

## Channel Advertising ##

To advertise a channel get a tag from **@MTProxybot** and write 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.

## Advanced Usage ##

The proxy can be launched:
- with a custom config: `python3 mtprotoproxy.py [configfile]`
- several times, clients will be automaticaly balanced between instances
- using *PyPy* interprteter
- with runtime statistics exported for [Prometheus](https://prometheus.io/): using [prometheus](https://github.com/alexbers/mtprotoproxy/tree/prometheus) branch

