Complete reference for rldp-http-proxy. Deployment walkthroughs live in How to set up a forward proxy and How to set up a reverse proxy.
ADNL addresses must be passed in hex encoding (64 hex characters, lowercase).
| Flag | Long form | Default | Description |
|---|
-p <PORT> | --port | | HTTP listening port for browser connections |
-c <PORT> | --client-port | | UDP port for client ADNL queries |
-C <FILE> | --global-config | | Path to the TON global network config file |
-P <YES|NO> | --proxy-all | NO | Proxy all HTTP requests, not only .ton, .adnl, .bag |
-S <ADNL_ADDRESS> | --storage-gateway | | ADNL address of a TON Storage gateway for .bag resolution |
-D <PATH> | --db | | Database root path |
-d | --daemonize | off | Daemonize the process |
-l <FILE> | --logname | | Log file path |
-v <LEVEL> | --verbosity | | Set verbosity level |
-V | --version | | Print build information and exit |
-h | --help | | Print help message and exit |
| Flag | Description |
|---|
-a <IP>:<PORT> | Public IP and UDP port for inbound ADNL connections (published to the TON DHT) |
-A <ADNL_ADDRESS> | ADNL address for the site |
-L <HOSTNAME>[:<PORTS>] | Forward requests for <HOSTNAME> to 127.0.0.1 (default ports: 80, 443) |
-R <HOSTNAME>[:<PORTS>]@<IP>:<PORT> | Forward requests for <HOSTNAME> to a remote HTTP server |
-C <FILE> | Path to the TON global network configuration file |
-D <PATH> | Database root path |
-d | Daemonize the process |
-l <FILE> | Log file path |
-v <LEVEL> | Set verbosity level (--verbosity) |
-V | Print build information and exit (--version) |
-h | Print help message and exit (--help) |
| Header | Added by | Value format |
|---|
Ton-Proxy-Site-Version | Reverse proxy (server-side) | Commit: <SHA>, Date: <DATE> |
Ton-Proxy-Entry-Version | Forward proxy (client-side) | Commit: <SHA>, Date: <DATE> |
The proxy supports the HTTP CONNECT method for WebSocket and TCP-based protocol tunneling over ADNL.
| Field | Default | Description |
|---|
TunnelSectionsNum | 1 | Number of relay hops |
MaxPricePerPacket | 0 | Maximum nanoTON per packet, 0 = no limit |
NodesPoolConfigPath | empty | Path to a JSON file pinning specific relays |
| Rebuild timeout | 45 s | Tunnel rebuilds automatically after 45 seconds of inactivity |
