From 1ecfb9f2e6c918b4eaab921ca5da3854ceada792 Mon Sep 17 00:00:00 2001 From: SamNet-dev Date: Wed, 18 Feb 2026 12:50:46 -0600 Subject: [PATCH] Redesign README with badges, emojis, and collapsible sections --- README.md | 363 +++++++++++++++++++++++++++--------------------------- 1 file changed, 181 insertions(+), 182 deletions(-) diff --git a/README.md b/README.md index 44afbfb..ba7f62f 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,19 @@ One script. Full control. Zero hassle.

- Quick Start • - Features • - Comparison • - Telegram Bot • - CLI Reference + Version + License + Engine + Platform + Bash + Docker +

+

+ Quick Start • + Features • + Comparison • + Telegram Bot • + CLI Reference

@@ -23,21 +31,23 @@ MTProxyMax is a full-featured Telegram MTProto proxy manager powered by the **te sudo bash -c "$(curl -fsSL https://raw.githubusercontent.com/SamNet-dev/MTProxyMax/main/install.sh)" ``` +--- + ## Why MTProxyMax? Most MTProxy tools give you a proxy and a link. That's it. MTProxyMax gives you a **full management platform**: -- **Multi-user secrets** with individual bandwidth quotas, device limits, and expiry dates -- **Telegram bot** with 17 commands — manage everything from your phone -- **Interactive TUI** — no need to memorize commands, menu-driven setup -- **Prometheus metrics** — real per-user traffic stats, not just iptables guesses -- **Proxy chaining** — route through SOCKS5 upstreams for extra privacy -- **Auto-recovery** — detects downtime, restarts automatically, alerts you on Telegram -- **Pre-built Docker images** — installs in seconds, not minutes +- 🔐 **Multi-user secrets** with individual bandwidth quotas, device limits, and expiry dates +- 🤖 **Telegram bot** with 17 commands — manage everything from your phone +- 🖥️ **Interactive TUI** — no need to memorize commands, menu-driven setup +- 📊 **Prometheus metrics** — real per-user traffic stats, not just iptables guesses +- 🔗 **Proxy chaining** — route through SOCKS5 upstreams for extra privacy +- 🔄 **Auto-recovery** — detects downtime, restarts automatically, alerts you on Telegram +- 🐳 **Pre-built Docker images** — installs in seconds, not minutes --- -## Quick Start +## 🚀 Quick Start ### One-Line Install @@ -58,32 +68,34 @@ sudo ./mtproxymax install ### After Install ```bash -mtproxymax menu # Open interactive TUI -mtproxymax secret list # See your users -mtproxymax status # Check proxy health +mtproxymax # Open interactive TUI +mtproxymax status # Check proxy health ``` --- -## Features +## ✨ Features -### FakeTLS Obfuscation +### 🛡️ FakeTLS Obfuscation -MTProxyMax uses **FakeTLS (TLS 1.3)** by default. Your proxy traffic looks identical to normal HTTPS traffic to any network observer or DPI system. The TLS handshake SNI points to a cover domain (e.g., `cloudflare.com`), making it indistinguishable from regular web browsing. +Your proxy traffic looks identical to normal HTTPS traffic. The TLS handshake SNI points to a cover domain (e.g., `cloudflare.com`), making it indistinguishable from regular web browsing to any DPI system. -**Traffic masking** goes further: when a non-Telegram client connects (e.g., a censor probing your server), the connection is seamlessly forwarded to the real cover domain. Your server responds exactly like cloudflare.com would — because it's actually proxying to it. +**Traffic masking** goes further — when a non-Telegram client probes your server, the connection is forwarded to the real cover domain. Your server responds exactly like cloudflare.com would. -### Multi-User Secret Management +--- -Each user gets their own **secret key** with a human-readable label. You can: +### 👥 Multi-User Secret Management + +Each user gets their own **secret key** with a human-readable label: - **Add/remove** users instantly — config regenerates and proxy hot-reloads - **Enable/disable** access without deleting the key - **Rotate** a user's secret — new key, same label, old link stops working -- **Generate links** — both `tg://` and `https://t.me/proxy` formats -- **QR codes** — scannable directly in Telegram settings +- **QR codes** — scannable directly in Telegram -### Per-User Access Control +--- + +### 🔒 Per-User Access Control Fine-grained limits enforced at the engine level: @@ -95,25 +107,27 @@ Fine-grained limits enforced at the engine level: | **Expiry Date** | Auto-disable after date | `2026-12-31` | ```bash -mtproxymax secret setlimit alice 100 5 10G 2026-12-31 +mtproxymax secret setlimits alice 100 5 10G 2026-12-31 ``` -This means: Alice can use up to 100 simultaneous connections from max 5 devices, with 10GB total bandwidth, expiring Dec 31, 2026. +--- -### User Management Recipes +### 📋 User Management Recipes -#### Prevent Key Sharing - -By default a secret key is unlimited — anyone who has the link can use it from any device or IP. To lock it to one person: +
+Prevent Key Sharing ```bash -mtproxymax secret setlimit alice ips 1 # Alice only, no sharing possible +mtproxymax secret setlimit alice ips 1 # Single person only mtproxymax secret setlimit family ips 5 # Family of up to 5 devices ``` -If someone with `ips 1` shares their link, the second IP that tries to connect gets rejected by the engine automatically. +If someone with `ips 1` shares their link, the second device gets rejected automatically. -#### IP Limit Tiers +
+ +
+IP Limit Tiers | Scenario | `max_ips` | |----------|-----------| @@ -123,55 +137,53 @@ If someone with `ips 1` shares their link, the second IP that tries to connect g | Small group / office | `20-30` | | Public/open link | `0` (unlimited) | -#### Create a Time-Limited Sharing Link +
+ +
+Time-Limited Sharing Link ```bash -# Public link: 50 simultaneous connections, 30 unique IPs, 10GB cap, expires June 1st mtproxymax secret add shared-link mtproxymax secret setlimits shared-link 50 30 10G 2026-06-01 ``` -When the expiry date hits, the link stops working automatically. No manual cleanup needed. +When the expiry date hits, the link stops working automatically. -#### Per-Person Keys (Recommended for Control) +
+ +
+Per-Person Keys (Recommended) ```bash mtproxymax secret add alice mtproxymax secret add bob mtproxymax secret add charlie -# Each person gets their own link — revoke individually without affecting others +# Each person gets their own link — revoke individually mtproxymax secret setlimit alice ips 2 mtproxymax secret setlimit bob ips 1 mtproxymax secret setlimit charlie ips 3 ``` -#### Temporarily Cut Someone Off +
+ +
+Disable, Rotate, Remove ```bash -mtproxymax secret disable bob # Bob can't connect, link preserved -mtproxymax secret enable bob # Bob is back, same link works +mtproxymax secret disable bob # Temporarily cut off +mtproxymax secret enable bob # Restore access + +mtproxymax secret rotate alice # New key, old link dies instantly + +mtproxymax secret remove bob # Permanent removal ``` -#### Revoke a Leaked Link - -```bash -mtproxymax secret rotate alice # New key generated, old link dies immediately -``` - -Alice gets a new link. Anyone who had the old link is disconnected and can't reconnect. - -#### Full Cleanup - -```bash -mtproxymax secret remove bob # Permanent — key gone, link dead forever -``` - -All other users are completely unaffected since each secret is independent. +
--- -### Telegram Bot (17 Commands) +### 🤖 Telegram Bot (17 Commands) Full proxy management from your phone. Setup takes 60 seconds: @@ -183,8 +195,8 @@ mtproxymax telegram setup |---------|-------------| | `/mp_status` | Proxy status, uptime, connections | | `/mp_secrets` | List all users with active connections | -| `/mp_link` | Get proxy links + QR code image | -| `/mp_add