Skip to main content

Telegram

The Telegram tab of Settings sets up the three ways b4 carries Telegram traffic and how b4 reaches Telegram's data centres. The guides under Telegram walk through each setup.

The Secrets and Telegram Desktop WEB proxy cards appear while the MTProto proxy is on.

Telegram over WebSocket​

The card turns on Telegram over WebSocket for the whole network, with no set involved.

The Telegram over WebSocket card

FieldWhat it doesDefault
Enable Telegram over WebSocketRelays Telegram from every device behind b4, and from the router itself, through the bridge. Device filtering applies. The MTProto proxy is not needed.Off

The header shows Save to apply until the settings are saved. After that it reads Working, or Not working with the missing part named when the pointer rests on it.

The Bridge status box shows:

ItemShows
Listener portThe bridge's port, 13443, and the address families it listens on, or not running
Active connectionsBridged connections open right now
Telegram rangesHow many address ranges are in use, their source (telegram.org, b4 mirror, saved copy, GeoIP file or built-in list) and when they were updated
Relayed sessionsHow many sessions the bridge relayed, and when the last one was
Counters linePassed on undecoded, data center dial failures and closed without a handshake, shown once one is above zero. See The counters under the bridge status
ButtonWhat it does
Check againRepeats the kernel's TPROXY check, then installs the bridge's firewall rule or moves it back above another program's rule
Refresh addressesDownloads Telegram's address list at once, and reports the number of ranges or the error

Each warning above the box is explained under The Telegram over WebSocket card shows a warning.

MTProto Proxy​

The MTProto proxy that Telegram connects to with a secret. The card's fields are hidden until its switch is on.

FieldWhat it doesDefault
Enable MTProto ProxyStarts the proxy server.Off
Bind AddressThe address the proxy listens on. 0.0.0.0 accepts connections on every address, 127.0.0.1 from this host only.0.0.0.0
PortThe port Telegram connects to.3128
Expose to internetAdds a firewall rule that accepts connections to the port from any address, over IPv4 and IPv6. Off adds no rule and blocks nothing. See Access from the internet.Off
Fake SNI DomainThe domain the proxy's TLS handshake presents, and the site that a connection failing the secret check is passed to. New secrets are generated for it.storage.googleapis.com

Advanced​

FieldWhat it doesDefault
Max ConnectionsThe most client connections open at once, probes included. Each Telegram client uses several. The WEB proxy is not limited by it.2048
TCP User Timeout (sec)Closes a client connection after this long with unacknowledged data, so a phone that left the network is noticed in about two minutes. -1 turns it off.120
Idle Timeout (sec)Closes a relayed session after this long with no traffic in either direction. -1 turns it off.300

In both timeouts, 0 uses the default.

Secrets​

One entry for each person lets access be given and withdrawn one person at a time. The log names the secret each connection used.

FieldWhat it doesDefault
SwitchTurns the entry on or off. A client with a switched-off secret is rejected.On
Name / commentA name for the entry, shown in the log and on the Traffic page.Empty
Max networksRefuses new connections to the secret once it is in use from this many networks at once. Devices behind one internet connection count as one network. 0 means no limit.0
SecretThe secret itself. Generate Secret replaces it with a new one for the current Fake SNI Domain. Only fake-TLS secrets, hexadecimal and starting with ee, are accepted.Generated

Add secret adds an entry with a generated secret. The share button (Share connection link) opens the link and QR code, see Adding the proxy in Telegram. The bin button (Remove secret) deletes the entry.

Telegram Desktop WEB proxy​

The WEB proxy serves the MTProto proxy as an HTTPS site for Telegram Desktop 7.1.1 and later.

FieldWhat it doesDefault
Enable the WEB carrierServes the proxy on the relay hostname.Off
Relay hostnameA public DNS name used only for the relay, with a publicly trusted certificate on port 443. No scheme, port or path; punycode for international names.Empty
Relay portEmpty: the relay is served on the web interface's port, on the relay hostname only. A port: the relay gets a listener of its own, where any other name or IP address gets the placeholder page. Filled with 443 when the carrier is first turned on.Empty
Expose to internetShown while a relay port is set. Opens the relay port to connections from any address. Without a relay port, the relay is reachable from outside only when the web interface is exposed.Off
Certificate for the relay hostnameShown while a relay port is set. Certificate file and Private key file in PEM format, used on the relay port only. Empty: the web server's certificate.Empty
Placeholder pageThe page every visitor other than Telegram sees. An uploaded HTML file of up to 1 MiB replaces the built-in page, and Remove restores it.Built-in

Telegram upstream (shared)​

How b4 reaches Telegram's data centres, for the MTProto proxy and Telegram over WebSocket alike, even while the proxy is off. The routes are explained under Telegram upstream.

FieldWhat it doesDefault
Transport modeHow the MTProto proxy reaches Telegram: Direct TCP, Auto (WebSocket → TCP) or WebSocket only. Telegram over WebSocket always uses Auto.Auto (WebSocket → TCP)
DC Relayhost:port of a VPS that forwards to the data centres, shown for Direct TCP and Auto (WebSocket → TCP). The ? button shows the socat commands. Not used by Telegram over WebSocket. See DC Relay.Empty
Telegram setThe set that carries b4's own connections to Telegram: a set without routing applies its strategy, a set routed through an interface or a proxy carries them on that route. Create a Telegram set adds a set with no targets and routing off, and selects it. See Telegram set.No set
Cloudflare Worker domainOne or more *.workers.dev names, separated by commas. See Cloudflare Worker relay.Empty
Custom WebSocket domainA domain that relays WebSocket traffic to Telegram. b4 adds kws1., kws2. and so on for each data centre.Empty

Test connection tries each configured route to data centre 2 and lists the result of each. Test direct TCP tries data centre 2 over direct TCP, without the DC Relay.

Fallback sources​

FieldWhat it doesDefault
CF proxy fallbackUses a rotating pool of Cloudflare-proxied domains for the data centres that Telegram's own edge does not serve.On
CF proxy domain list URLWhere the pool is refreshed from, hourly.tg-ws-proxy's list
DC list fallback mirrorFetches Telegram's data-centre list from the mirror below when Telegram's own endpoint is unreachable.On
DC list mirror URLThe mirror. The default one is hosted by the b4 author and receives the requesting IP address, nothing else.The b4 author's mirror
Bridge Handshake Wait (sec)How long Telegram over WebSocket waits for a client's first byte before closing the connection. -1 waits indefinitely.180

b4 downloads these lists only while the MTProto proxy, Telegram over WebSocket or an enabled set in its routing mode is on.

Advanced​

The section opens on its own when either field is set.

FieldWhat it doesDefault
Telegram WS edge IPReplaces the address of Telegram's own WebSocket edge.149.154.167.220
Fronting name for Telegram's WS edgeA TLS name, such as sprinthost.ru, tried on Telegram's edge when the handshake under its own names goes unanswered. See Fronting name for the WS edge.Empty (off)

Saving changes​

The tab applies on Save Changes, without restarting the service.

  • A change to Enable MTProto Proxy, Bind Address, Port, Fake SNI Domain, Transport mode, Custom WebSocket domain, the WS edge IP, the fronting name or a CF proxy setting restarts the MTProto proxy.
  • Choosing another set in Telegram set, or changing the chosen set's routing, also closes the open sessions of the MTProto proxy and of Telegram over WebSocket, and the clients reconnect on the new path.
  • Secrets apply without a restart. A secret switched off or removed loses its open connections.
  • The WEB proxy's switch and hostname apply from the next request. A new relay port or certificate restarts only the relay's listener.