xinyin025/3x-ui
1
0
Fork 0
mirror of https://github.com/MHSanaei/3x-ui.git synced 2026-09-16 15:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add TUIC v5 to READMEs, guides, and protocol references (#6511)

Browse Source 
* docs: add TUIC v5 to READMEs, guides, and protocol references

* docs: address review feedback on TUIC architecture, external links, and i18n parity

* docs(tuic): drop the Xray-routing claim and qualify Limit IP for TUIC

The README feature bullet in all seven locales credited the TUIC sidecar
with "seamless Xray routing". A TUIC inbound never enters the Xray config
(internal/web/service/xray.go skips model.TUIC) and the generated
tuic-server config carries no forwarding target, so decrypted TUIC
traffic egresses from the sidecar directly and Xray routing rules never
see it; docs/architecture.md in this same branch already says so. An
operator reading the bullet would expect geo blocking and outbound
selection to cover TUIC clients.

The client field table marks Total (GB) as inbound-level for TUIC but
left Limit IP at "all". The IP-limit job's only data source is Xray's
online-stats API (internal/web/job/check_client_ip_job.go), which TUIC
clients never reach, so a Limit IP set on a TUIC client is silently
unenforced. Qualify that row the same way in en, fa, ru and zh.

---------

Co-authored-by: Sanaei <ho3ein.sanaei@gmail.com>
This commit is contained in:
Egor
2026-09-14 14:36:59 +05:00
committed by GitHub
parent cfd4f64a79
commit 2d7c8c77f7
28 changed files with 65 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/docs/en/config/clients.mdx
+4 -4
View File
@@ -13,12 +13,12 @@ inbounds** at once, with per-client traffic accounting.
| Field | Applies to | Meaning |
| -------------- | --------------------- | ------------------------------------------------------------------ |
| **Email** | all | Unique identifier used for accounting and lookups. |
| **ID (UUID)** | VLESS, VMess | The client credential. |
| **Password** | Trojan, Shadowsocks | The client credential. |
| **ID (UUID)** | VLESS, VMess, TUIC | The client credential. |
| **Password** | Trojan, Shadowsocks, TUIC | The client credential. |
| **Auth** | Hysteria2 | The client credential. |
| **Flow** | VLESS | XTLS flow, e.g. `xtls-rprx-vision`. |
| **Limit IP** | all | Max simultaneous source IPs (enforced via Fail2ban). |
| **Total (GB)** | all | Traffic quota; the client is disabled when exhausted. |
| **Limit IP** | all (except TUIC) | Max simultaneous source IPs (enforced via Fail2ban). |
| **Total (GB)** | all (except TUIC) | Traffic quota; the client is disabled when exhausted (for TUIC, limits are set at the inbound level). |
| **Expiry** | all | Date after which the client stops working. |
| **Reset** | all | Auto-renew period in **days** (rolls the quota over). |
| **Telegram ID**| all | Links the client to a Telegram user for self-service/notifications.|
docs/content/docs/en/config/subscription.mdx
+2 -2
View File
@@ -50,8 +50,8 @@ The **format is chosen by path**, each with its own enable toggle:
| **Mihomo (explicit)** | `/mihomo/` | `subClashEnable` | Alias for the full `subClashPath` profile. |
| **Clash for Windows (legacy)** | `/clash-legacy/` | `subClashEnable` | YAML limited to proxy types, transports, and ciphers supported by the legacy Clash core. |
Only enabled inbounds using **VLESS, VMess, Trojan, Shadowsocks, or Hysteria2**
appear in a subscription, ordered by their sub-sort index. Requesting `subPath`
Only enabled inbounds using **VLESS, VMess, Trojan, Shadowsocks, WireGuard, AmneziaWG, MTProto, TUIC, or Hysteria2**
appear in a subscription, ordered by their sub-sort index (TUIC and AmneziaWG are included in raw links and Clash/Mihomo profiles, but omitted from JSON endpoints; MTProto is included in raw links). Requesting `subPath`
with an `Accept: text/html` header (or `?html=1`) returns a human-readable info
page instead of the raw body.
docs/content/docs/en/guide/index.mdx
+1 -1
View File
@@ -34,7 +34,7 @@ flowchart LR
## What it gives you
- A dashboard for **inbounds** across every major protocol — VLESS, VMess,
Trojan, Shadowsocks, WireGuard, Hysteria2, SOCKS, HTTP, and Dokodemo-door.
Trojan, Shadowsocks, WireGuard, AmneziaWG, TUIC v5, Hysteria2, SOCKS, HTTP, and Dokodemo-door.
- First-class **REALITY** and **XTLS-Vision** support for stealthy, fast
transports.
- **Per-client** traffic quotas, expiry dates, IP limits, online status, and
docs/content/docs/en/index.mdx
+1 -1
View File
@@ -41,7 +41,7 @@ leaves the page.
## Highlights
- **Every major protocol** — VLESS, VMess, Trojan, Shadowsocks, WireGuard,
Hysteria2, SOCKS, HTTP, and Dokodemo-door.
AmneziaWG, TUIC v5, Hysteria2, SOCKS, HTTP, and Dokodemo-door.
- **REALITY & XTLS-Vision** — modern, censorship-resistant transports.
- **Per-client controls** — traffic quotas, expiry dates, IP limits, share
links, and QR codes.
docs/content/docs/fa/config/clients.mdx
+4 -4
View File
@@ -13,12 +13,12 @@ icon: Users
| فیلد | اعمال بر | معنی |
| -------------- | --------------------- | ------------------------------------------------------------------ |
| **Email** | همه | شناسه‌ی یکتا که برای حساب‌داری و جست‌وجوها استفاده می‌شود. |
| **ID (UUID)** | VLESS, VMess | اعتبارنامه‌ی کلاینت. |
| **Password** | Trojan, Shadowsocks | اعتبارنامه‌ی کلاینت. |
| **ID (UUID)** | VLESS, VMess, TUIC | اعتبارنامه‌ی کلاینت. |
| **Password** | Trojan, Shadowsocks, TUIC | اعتبارنامه‌ی کلاینت. |
| **Auth** | Hysteria2 | اعتبارنامه‌ی کلاینت. |
| **Flow** | VLESS | جریان XTLS، برای مثال `xtls-rprx-vision`. |
| **Limit IP** | همه | بیشینه‌ی تعداد IPهای مبدأ هم‌زمان (با Fail2ban اعمال می‌شود). |
| **Total (GB)** | همه | سهمیه‌ی ترافیک؛ هنگام اتمام، کلاینت غیرفعال می‌شود. |
| **Limit IP** | همه (به‌جز TUIC) | بیشینه‌ی تعداد IPهای مبدأ هم‌زمان (با Fail2ban اعمال می‌شود). |
| **Total (GB)** | همه (به‌جز TUIC) | سهمیه‌ی ترافیک؛ هنگام اتمام، کلاینت غیرفعال می‌شود (برای TUIC محدودیت در سطح ورودی تعیین می‌شود). |
| **Expiry** | همه | تاریخی که پس از آن کلاینت از کار می‌افتد. |
| **Reset** | همه | دوره‌ی تمدید خودکار به **روز** (سهمیه را از نو می‌چرخاند). |
| **Telegram ID**| همه | کلاینت را به یک کاربر Telegram برای سلف‌سرویس/اعلان‌ها پیوند می‌دهد.|
docs/content/docs/fa/config/inbounds.mdx
+2
View File
@@ -58,11 +58,13 @@ TLS یا REALITY) را انتخاب کنید. به [انتقال‌ها](/docs/c
| **Trojan** | مبتنی بر TLS؛ از XTLS و fallback پشتیبانی می‌کند. |
| **Shadowsocks** | شامل رمزهای Shadowsocks-2022 (`2022-blake3-*`). |
| **WireGuard** | تونل مدرن. |
| **AmneziaWG** | نسخه مبهم‌شده فورک WireGuard که در فرایند پنل تعبیه شده است. مشاهده [AmneziaWG](/docs/config/amneziawg). |
| **Hysteria2** | با عنوان `hysteria` انتخاب می‌شود؛ پنل لینک‌های `hysteria2://` تولید می‌کند. |
| **HTTP** | پراکسی HTTP. |
| **Mixed (SOCKS/HTTP)** | یک شنونده ترکیبی SOCKS + HTTP. |
| **Dokodemo-door / Tunnel** | فورواردینگ پورت / هدایت ترافیک. |
| **MTProto** | پراکسی MTProto تلگرام که توسط یک فرایند همراه `mtg` سرویس می‌شود (نه Xray). |
| **TUIC** | پروتکل پراکسی مبتنی بر QUIC نسخه ۵ که توسط فرایند `tuic-server` ارائه می‌شود. مشاهده [TUIC](/docs/config/tuic). |
<Callout type="info">
Hysteria2 در سطح داخلی یک پروتکل جداگانه نیست — همان پروتکل `hysteria` است که
docs/content/docs/fa/config/subscription.mdx
+2 -3
View File
@@ -48,9 +48,8 @@ https://<sub-host>:<sub-port>/<sub-path>/<sub-id>
| **JSON** | `subJsonPath` | `subJsonEnable` | پیکربندی(های) کامل کلاینت Xray. |
| **Clash / Mihomo** | `subClashPath` | `subClashEnable` | پروفایل YAML. |
فقط ورودی‌های فعالی که از **VLESS، VMess، Trojan، Shadowsocks یا Hysteria2**
استفاده می‌کنند در یک اشتراک ظاهر می‌شوند و بر اساس شاخص sub-sort آن‌ها مرتب می‌شوند.
درخواست `subPath` همراه با هدر `Accept: text/html` (یا `?html=1`) به‌جای بدنه‌ی خام،
فقط ورودی‌های فعالی که از **VLESS، VMess، Trojan، Shadowsocks، WireGuard، AmneziaWG، MTProto، TUIC یا Hysteria2**
استفاده می‌کنند در یک اشتراک ظاهر می‌شوند و بر اساس شاخص sub-sort آن‌ها مرتب می‌شوند (TUIC و AmneziaWG در لینک‌های خام و پروفایل‌های Clash/Mihomo گنجانده می‌شوند اما از اندپوینت‌های JSON حذف می‌شوند؛ MTProto در لینک‌های خام گنجانده می‌شود). درخواست `subPath` همراه با هدر `Accept: text/html` (یا `?html=1`) به‌جای بدنه‌ی خام،
یک صفحه‌ی اطلاعات خوانا برای انسان برمی‌گرداند.
### Base64 vs JSON
docs/content/docs/fa/guide/index.mdx
+1 -1
View File
@@ -35,7 +35,7 @@ flowchart LR
## چه چیزی در اختیار شما می‌گذارد
- داشبوردی برای **ورودی‌ها** در تمام پروتکل‌های اصلی — VLESS، VMess،
Trojan، Shadowsocks، WireGuard، Hysteria2، SOCKS، HTTP و Dokodemo-door.
Trojan، Shadowsocks، WireGuard، AmneziaWG، TUIC v5، Hysteria2، SOCKS، HTTP و Dokodemo-door.
- پشتیبانی درجه‌یک از **REALITY** و **XTLS-Vision** برای ترانسپورت‌های مخفی
و سریع.
- سهمیه‌های ترافیک **به‌ازای هر کلاینت**، تاریخ‌های انقضا، محدودیت‌های IP،
docs/content/docs/fa/index.mdx
+1 -1
View File
@@ -41,7 +41,7 @@ icon: House
## ویژگی‌های شاخص
- **همه پروتکل‌های اصلی** — VLESS، VMess، Trojan، Shadowsocks، WireGuard،
Hysteria2، SOCKS، HTTP و Dokodemo-door.
AmneziaWG، TUIC v5، Hysteria2، SOCKS، HTTP و Dokodemo-door.
- **REALITY و XTLS-Vision** — ترنسپورت‌های مدرن و مقاوم در برابر سانسور.
- **کنترل‌های اختصاصی هر کلاینت** — سهمیه ترافیک، تاریخ انقضا، محدودیت IP، لینک‌های
اشتراک‌گذاری و کدهای QR.
docs/content/docs/ru/config/clients.mdx
+4 -4
View File
@@ -14,12 +14,12 @@ icon: Users
| Поле | Применяется к | Значение |
| -------------- | --------------------- | ------------------------------------------------------------------ |
| **Email** | все | Уникальный идентификатор для учёта трафика и поиска. |
| **ID (UUID)** | VLESS, VMess | Учётные данные клиента. |
| **Password** | Trojan, Shadowsocks | Учётные данные клиента. |
| **ID (UUID)** | VLESS, VMess, TUIC | Учётные данные клиента. |
| **Password** | Trojan, Shadowsocks, TUIC | Учётные данные клиента. |
| **Auth** | Hysteria2 | Учётные данные клиента. |
| **Flow** | VLESS | Поток XTLS, например `xtls-rprx-vision`. |
| **Limit IP** | все | Максимум одновременных IP-адресов источника (контролируется через Fail2ban). |
| **Total (GB)** | все | Квота трафика; при исчерпании клиент отключается. |
| **Limit IP** | все (кроме TUIC) | Максимум одновременных IP-адресов источника (контролируется через Fail2ban). |
| **Total (GB)** | все (кроме TUIC) | Квота трафика; при исчерпании клиент отключается (для TUIC лимит задаётся на уровне инбаунда). |
| **Expiry** | все | Дата, после которой клиент перестаёт работать. |
| **Reset** | все | Период автопродления в **днях** (обнуляет квоту). |
| **Telegram ID**| все | Привязывает клиента к пользователю Telegram для самообслуживания/уведомлений.|
docs/content/docs/ru/config/inbounds.mdx
+1
View File
@@ -59,6 +59,7 @@ icon: ArrowDownToLine
| **Trojan** | На основе TLS; поддерживает XTLS и fallback-правила. |
| **Shadowsocks** | Включает шифры Shadowsocks-2022 (`2022-blake3-*`). |
| **WireGuard** | Современный туннель. |
| **AmneziaWG** | Форк WireGuard с обфускацией, встроенный в процесс панели. См. [AmneziaWG](/docs/config/amneziawg). |
| **Hysteria2** | Выбирается как `hysteria`; панель создаёт ссылки `hysteria2://`. |
| **HTTP** | HTTP-прокси. |
| **Mixed (SOCKS/HTTP)** | Совмещённый слушатель SOCKS + HTTP. |
docs/content/docs/ru/config/subscription.mdx
+2 -2
View File
@@ -49,8 +49,8 @@ https://<sub-host>:<sub-port>/<sub-path>/<sub-id>
| **Clash / Mihomo** | `subClashPath` | `subClashEnable` | YAML-профиль. |
В подписке появляются только включённые входящие соединения, использующие
**VLESS, VMess, Trojan, Shadowsocks или Hysteria2**, упорядоченные по их индексу
сортировки подписки. Запрос `subPath` с заголовком `Accept: text/html` (или
**VLESS, VMess, Trojan, Shadowsocks, WireGuard, AmneziaWG, MTProto, TUIC или Hysteria2**, упорядоченные по их индексу
сортировки подписки (TUIC и AmneziaWG включаются в raw-ссылки и профили Clash/Mihomo, но исключаются из JSON-конфигов; MTProto включается в raw-ссылки). Запрос `subPath` с заголовком `Accept: text/html` (или
`?html=1`) возвращает удобочитаемую информационную страницу вместо
необработанного тела.
docs/content/docs/ru/guide/index.mdx
+1 -1
View File
@@ -34,7 +34,7 @@ flowchart LR
## Что она вам даёт
- Панель управления **входящими подключениями** по всем основным протоколам — VLESS, VMess,
Trojan, Shadowsocks, WireGuard, Hysteria2, SOCKS, HTTP и Dokodemo-door.
Trojan, Shadowsocks, WireGuard, AmneziaWG, TUIC v5, Hysteria2, SOCKS, HTTP и Dokodemo-door.
- Полноценная поддержка **REALITY** и **XTLS-Vision** для скрытных и быстрых
транспортов.
- **Поклиентские** квоты трафика, даты истечения, ограничения по IP, статус «онлайн» и
docs/content/docs/ru/index.mdx
+1 -1
View File
@@ -41,7 +41,7 @@ icon: House
## Ключевые возможности
- **Все основные протоколы** — VLESS, VMess, Trojan, Shadowsocks, WireGuard,
Hysteria2, SOCKS, HTTP и Dokodemo-door.
AmneziaWG, TUIC v5, Hysteria2, SOCKS, HTTP и Dokodemo-door.
- **REALITY и XTLS-Vision** — современные транспорты, устойчивые к цензуре.
- **Управление каждым клиентом** — квоты трафика, даты истечения, ограничения по IP, ссылки
для подключения и QR-коды.
docs/content/docs/zh/config/clients.mdx
+4 -4
View File
@@ -12,12 +12,12 @@ icon: Users
| 字段 | 适用于 | 含义 |
| -------------- | --------------------- | ------------------------------------------------------------------ |
| **Email** | 全部 | 用于统计和查询的唯一标识符。 |
| **ID (UUID)** | VLESS、VMess | 客户端凭据。 |
| **Password** | Trojan、Shadowsocks | 客户端凭据。 |
| **ID (UUID)** | VLESS、VMess、TUIC | 客户端凭据。 |
| **Password** | Trojan、Shadowsocks、TUIC | 客户端凭据。 |
| **Auth** | Hysteria2 | 客户端凭据。 |
| **Flow** | VLESS | XTLS 流控，例如 `xtls-rprx-vision`。 |
| **Limit IP** | 全部 | 最大同时连接的源 IP 数量（通过 Fail2ban 强制执行）。 |
| **Total (GB)** | 全部 | 流量配额；用尽后客户端将被禁用。 |
| **Limit IP** | 全部（TUIC 除外） | 最大同时连接的源 IP 数量（通过 Fail2ban 强制执行）。 |
| **Total (GB)** | 全部（TUIC 除外） | 流量配额；用尽后客户端将被禁用（对于 TUIC，限制在入站级别设置）。 |
| **Expiry** | 全部 | 该日期之后客户端停止工作。 |
| **Reset** | 全部 | 以**天**为单位的自动续期周期（滚动重置配额）。 |
| **Telegram ID**| 全部 | 将客户端关联到 Telegram 用户，用于自助服务/通知。 |
docs/content/docs/zh/config/inbounds.mdx
+2
View File
@@ -55,11 +55,13 @@ icon: ArrowDownToLine
| **Trojan** | 基于 TLS；支持 XTLS 和回落。 |
| **Shadowsocks** | 包含 Shadowsocks-2022（`2022-blake3-*`）加密方式。 |
| **WireGuard** | 现代隧道协议。 |
| **AmneziaWG** | 混淆版 WireGuard 分支，直接内置在面板进程中。参见 [AmneziaWG](/docs/config/amneziawg)。 |
| **Hysteria2** | 选择为 `hysteria`；面板生成 `hysteria2://` 链接。 |
| **HTTP** | HTTP 代理。 |
| **Mixed (SOCKS/HTTP)** | SOCKS + HTTP 的组合监听器。 |
| **Dokodemo-door / Tunnel** | 端口转发 / 流量重定向。 |
| **MTProto** | Telegram MTProto 代理，由内置的 `mtg` 进程提供（而非 Xray）。 |
| **TUIC** | 基于 QUIC 的代理协议（v5），由内置的 `tuic-server` 进程提供。参见 [TUIC](/docs/config/tuic)。 |
<Callout type="info">
在内部，Hysteria2 并不是一个独立的协议——它是把传输版本设为 2 的 `hysteria`
docs/content/docs/zh/config/subscription.mdx
+1 -1
View File
@@ -44,7 +44,7 @@ https://<sub-host>:<sub-port>/<sub-path>/<sub-id>
| **Mihomo（明确端点）** | `/mihomo/` | `subClashEnable` | 完整 `subClashPath` 配置的别名。 |
| **Clash for Windows（旧版）** | `/clash-legacy/` | `subClashEnable` | 仅包含旧 Clash 内核支持的代理类型、传输方式和加密算法。 |
只有使用 **VLESS、VMess、Trojan、Shadowsocks 或 Hysteria2** 的已启用入站才会出现在订阅中，并按其订阅排序索引排列。使用 `Accept: text/html` 头（或 `?html=1`）请求 `subPath` 会返回一个人类可读的信息页面，而非原始内容。
只有使用 **VLESS、VMess、Trojan、Shadowsocks、WireGuard、AmneziaWG、MTProto、TUIC 或 Hysteria2** 的已启用入站才会出现在订阅中，并按其订阅排序索引排列（TUIC 和 AmneziaWG 包含在原始链接和 Clash/Mihomo 配置中，但在 JSON 端点中被省略；MTProto 包含在原始链接中）。使用 `Accept: text/html` 头（或 `?html=1`）请求 `subPath` 会返回一个人类可读的信息页面，而非原始内容。
Clash Verge Rev、Mihomo 及其他仍在维护的 Mihomo 客户端应使用
`/mihomo/<sub-id>`。已经停止维护的 Clash for Windows 应使用
docs/content/docs/zh/guide/index.mdx
+1 -1
View File
@@ -27,7 +27,7 @@ flowchart LR
## 它为你提供什么
- 一个面向所有主流协议的**入站**仪表盘——VLESS、VMess、Trojan、Shadowsocks、WireGuard、Hysteria2、SOCKS、HTTP 以及 Dokodemo-door。
- 一个面向所有主流协议的**入站**仪表盘——VLESS、VMess、Trojan、Shadowsocks、WireGuard、AmneziaWG、TUIC v5、Hysteria2、SOCKS、HTTP 以及 Dokodemo-door。
- 一流的 **REALITY** 与 **XTLS-Vision** 支持，带来隐蔽、快速的传输方式。
- **按客户端**设置的流量配额、到期日期、IP 限制、在线状态，以及一键生成分享链接 / 二维码。
- 支持 VLESS、Clash/Mihomo 和 JSON 格式的**订阅**。
docs/content/docs/zh/index.mdx
+1 -1
View File
@@ -38,7 +38,7 @@ icon: House
## 亮点
- **覆盖所有主流协议** —— VLESS、VMess、Trojan、Shadowsocks、WireGuard、
Hysteria2、SOCKS、HTTP 以及 Dokodemo-door。
AmneziaWG、TUIC v5、Hysteria2、SOCKS、HTTP 以及 Dokodemo-door。
- **REALITY 与 XTLS-Vision** —— 现代化、抗审查的传输方式。
- **细粒度的客户端管理** —— 流量配额、到期日期、IP 限制、分享
链接以及 QR 码。