mtprotoproxy Documentation

To deploy the MTProto proxy, clone the stable branch, configure your settings, and run it using Docker or Python.

1. Clone the repository:

   git clone -b stable https://github.com/alexbers/mtprotoproxy.git; cd mtprotoproxy

2. (Optional but recommended) Edit config.py to set your PORT, USERS, and AD_TAG.
3. Start the proxy:
   • Using Docker: docker-compose up -d
   • Using Python: python3 mtprotoproxy.py
4. (Optional) Retrieve the proxy link to share with users by checking the logs: docker-compose logs.

git clone -b stable https://github.com/alexbers/mtprotoproxy.git; cd mtprotoproxy
# Edit config.py then:
docker-compose up -d

You can advertise a Telegram channel through the proxy. To do this:

1. Obtain an advertising tag from the @MTProxybot on Telegram.
2. Add this tag to the AD_TAG field in config.py.

You can deploy the MTProto Proxy using a docker-compose.yml file. The configuration uses network_mode: "host" to allow the proxy to bind directly to host ports, which is often necessary for MTProto traffic.

To run the service, ensure you have the required configuration and source files in the same directory as the compose file, as they are mounted as volumes.

version: '2.0'
services:
  mtprotoproxy:
    build: .
    restart: unless-stopped
    network_mode: "host"
    volumes:
        - ./config.py:/home/tgproxy/config.py
        - ./mtprotoproxy.py:/home/tgproxy/mtprotoproxy.py
        - /etc/localtime:/etc/localtime:ro
    logging:
        driver: "json-file"
        options:
            max-file: "10"
            max-size: "10m"

The Docker Compose setup requires specific files to be mounted into the container to function correctly. The following volume mappings are used:

• ./config.py must be mapped to /home/tgproxy/config.py (contains proxy settings).
• ./mtprotoproxy.py must be mapped to /home/tgproxy/mtprotoproxy.py (the application logic).
• /etc/localtime is mapped as read-only (ro) to ensure the container uses the host's system time.

The proxy script supports several advanced execution modes:

• Custom Configuration: Pass a specific configuration file as an argument.
• Load Balancing: You can run multiple instances of the proxy; clients will be automatically balanced between them.
• Performance Boost: Use the uvloop module to increase execution speed.
• Monitoring: The proxy supports exporting runtime statistics to Prometheus.

python3 mtprotoproxy.py [configfile]