mirror of https://github.com/telemt/telemt.git
80 lines
2.8 KiB
Markdown
80 lines
2.8 KiB
Markdown
# Telemt - MTProxy on Rust + Tokio
|
|
|
|
***Löst Probleme, bevor andere überhaupt wissen, dass sie existieren*** / ***It solves problems before others even realize they exist***
|
|
|
|
> [!NOTE]
|
|
>
|
|
> Fixed TLS ClientHello is now available in official clients for Desktop / Android / iOS
|
|
>
|
|
> To work with EE-MTProxy, please update your client!
|
|
|
|
<p align="center">
|
|
<a href="https://t.me/telemtrs">
|
|
<img src="/docs/assets/telegram_button.svg" width="200"/>
|
|
</a>
|
|
</p>
|
|
|
|
**Telemt** is a fast, secure, and feature-rich server written in Rust: it fully implements the official Telegram proxy algo and adds many production-ready improvements
|
|
|
|
### One-command Install and Update
|
|
```bash
|
|
curl -fsSL https://raw.githubusercontent.com/telemt/telemt/main/install.sh | sh
|
|
```
|
|
- [Quick Start Guide](docs/Quick_start/QUICK_START_GUIDE.en.md)
|
|
- [Инструкция по быстрому запуску](docs/Quick_start/QUICK_START_GUIDE.ru.md)
|
|
|
|
Our implementation of **TLS-fronting** is one of the most deeply debugged, focused, advanced and *almost* **"behaviorally consistent to real"**: we are confident we have it right - [see evidence on our validation and traces](docs/FAQ.en.md#recognizability-for-dpi-and-crawler)
|
|
|
|
Our ***Middle-End Pool*** is fastest by design in standard scenarios, compared to other implementations of connecting to the Middle-End Proxy: non dramatically, but usual
|
|
|
|
- Full support for all official MTProto proxy modes:
|
|
- Classic;
|
|
- Secure - with `dd` prefix;
|
|
- Fake TLS - with `ee` prefix + SNI fronting;
|
|
- Replay attack protection;
|
|
- Optional traffic masking: forward unrecognized connections to a real web server, e.g. GitHub 🤪;
|
|
- Configurable keepalives + timeouts + IPv6 and "Fast Mode";
|
|
- Graceful shutdown on Ctrl+C;
|
|
- Extensive logging via `trace` and `debug` with `RUST_LOG` method.
|
|
|
|
## FAQ
|
|
- [FAQ RU](docs/FAQ.ru.md)
|
|
- [FAQ EN](docs/FAQ.en.md)
|
|
|
|
# Learn more about Telemt
|
|
- [Our Architecture](docs/Architecture)
|
|
- [All Config Options](docs/Config_params)
|
|
- [How to build your own Telemt?](#build)
|
|
- [Running on BSD](docs/Quick_start/OPENBSD_QUICK_START_GUIDE.en.md)
|
|
- [Why Rust?](#why-rust)
|
|
|
|
## Build
|
|
```bash
|
|
# Cloning repo
|
|
git clone https://github.com/telemt/telemt
|
|
# Changing Directory to telemt
|
|
cd telemt
|
|
# Starting Release Build
|
|
cargo build --release
|
|
|
|
# Low-RAM devices (1 GB, e.g. NanoPi Neo3 / Raspberry Pi Zero 2):
|
|
# release profile uses lto = "thin" to reduce peak linker memory.
|
|
# If your custom toolchain overrides profiles, avoid enabling fat LTO.
|
|
|
|
# Move to /bin
|
|
mv ./target/release/telemt /bin
|
|
# Make executable
|
|
chmod +x /bin/telemt
|
|
# Lets go!
|
|
telemt config.toml
|
|
```
|
|
|
|
## Why Rust?
|
|
- Long-running reliability and idempotent behavior
|
|
- Rust's deterministic resource management - RAII
|
|
- No garbage collector
|
|
- Memory safety and reduced attack surface
|
|
- Tokio's asynchronous architecture
|
|
|
|
|