# Docs

- [3x-ui Documentation](/docs): Official documentation for 3x-ui — an advanced web panel for managing Xray-core servers, proxies, clients, and subscriptions.
- Getting Started
  - [Meet 3x-ui](/docs/guide): A web panel for Xray-core — manage inbounds, protocols, clients, and subscriptions from your browser instead of editing JSON by hand.
  - [Installation](/docs/guide/installation): Install 3x-ui via the official script (stable, pinned, or dev-latest), unattended/cloud-init, or Docker — and choose SQLite or PostgreSQL.
  - [First Login](/docs/guide/first-login): Find your generated 3x-ui credentials, reach the panel, enable two-factor auth, and harden it before exposing anything.
  - [Update & Uninstall](/docs/guide/update-uninstall): Manage 3x-ui with the x-ui menu and CLI — update (stable, dev, or legacy), change settings, and uninstall cleanly.
- Configuration
  - [Panel Settings](/docs/config/panel): Every 3x-ui panel setting — web server, TLS, display, security, and notifications — with defaults from the source.
  - [SSL Certificates](/docs/config/ssl-certificates): Get and renew TLS certificates for the 3x-ui panel and inbounds — with the x-ui ACME menu (domain or bare IP), a Cloudflare DNS-01 wildcard, or manual Certbot.
  - [Inbounds & Protocols](/docs/config/inbounds): Create inbounds in 3x-ui — protocols, transports, traffic reset and expiry, and fallbacks that serve multiple protocols on one port.
  - [REALITY](/docs/config/reality): Set up a VLESS + REALITY inbound with XTLS-Vision in 3x-ui — keys, short IDs, SNI, fingerprints, and common pitfalls.
  - [AmneziaWG](/docs/config/amneziawg): Set up an AmneziaWG inbound in 3x-ui — obfuscation parameters, native IPv6, per-client port-forwarding, and routing client traffic through Xray.
  - [TUIC](/docs/config/tuic): Set up a TUIC inbound in 3x-ui — QUIC congestion control, 0-RTT handshakes, and multi-user authentication.
  - [Transports & Security](/docs/config/transports): Every transport 3x-ui exposes — TCP, mKCP, WebSocket, gRPC, HTTPUpgrade, XHTTP, Hysteria — with their settings, plus FinalMask obfuscation, sockopt, TLS/REALITY, XTLS-Vision, and VLESS encryption.
  - [Clients](/docs/config/clients): Manage 3x-ui clients — credentials, traffic and expiry limits, IP limits, groups, bulk actions, external links, and online status.
  - [Subscription](/docs/config/subscription): Run the 3x-ui subscription server — base64/JSON/Clash formats, ports and paths, TLS, response headers, and custom templates.
  - [Share Links](/docs/config/share-links): 3x-ui share-link formats (vless, vmess, trojan, ss, hysteria2, mtproto), the remark template variables, and an in-browser link inspector.
- Operations
  - [Reverse Proxy](/docs/operations/reverse-proxy): Put the 3x-ui panel and subscription behind Nginx or Caddy with Let's Encrypt TLS.
  - [Multi-node & Managed Hosts](/docs/operations/multi-node): Manage multiple 3x-ui panels from one master, with API-token or mTLS trust, heartbeats, and per-inbound host overrides for subscriptions.
  - [Outbounds & Routing](/docs/operations/outbounds-routing): Shape egress in 3x-ui — WARP, NordVPN, PIA WireGuard, outbound subscriptions, routing rules, and load balancers.
  - [Backup & Restore](/docs/operations/backup-restore): Back up and restore your 3x-ui database and certificates, manually or via the Telegram bot.
  - [Telegram Bot](/docs/operations/telegram-bot): Connect a Telegram bot to 3x-ui for commands, periodic reports, event alerts (login, CPU, node up/down), backups, and client self-service.
  - [Discord Bot](/docs/operations/discord-bot): Connect a Discord bot to 3x-ui to receive real-time Embed notifications in a channel for panel events (service crashes, node status, CPU/RAM load, and login attempts).
  - [Security](/docs/operations/security): Harden 3x-ui — panel auth and 2FA, Fail2ban IP limits, firewall rules, BBR, and staying current.
- Reference
  - [Environment Variables](/docs/reference/env-vars): Complete reference for 3x-ui's XUI_* environment variables — database, panel, logging, memory, node token encryption, and the tunnel health monitor.
  - [Database](/docs/reference/database): 3x-ui storage backends — SQLite (default) and PostgreSQL — the database path, connection pool, and SQLite-to-PostgreSQL migration.
  - [Ports & Firewall](/docs/reference/ports-firewall): The ports 3x-ui uses by default and ready-made ufw / nftables rules to open them.
  - API Reference
    - [API Reference](/docs/reference/api): The 3x-ui panel REST API — authentication, inbounds, clients, server stats, and more, generated from the OpenAPI spec.
    - [Authentication](/docs/reference/api/authentication): Two authentication modes are supported. UI sessions use a cookie set by the login endpoint. Programmatic clients (bots, scripts, remote panels) authenticate with a Bearer token taken from Settings → Security → API Token. Both work for every endpoint under /panel/api/*.
    - [API Tokens](/docs/reference/api/api-tokens): Manage scoped Bearer tokens for programmatic auth. Tokens grant admin, monitor, or node-sync access, may expire, and are stored as SHA-256 hashes. The plaintext is returned only once at creation.
    - [Inbounds](/docs/reference/api/inbounds): Manage inbound configurations and their clients. All endpoints live under /panel/api/inbounds and require a logged-in session or Bearer token. Link-generating endpoints honour forwarded headers only when the request comes from a configured trusted proxy.
    - [Clients](/docs/reference/api/clients): Manage clients as first-class entities that can be attached to one or more inbounds. A single client row drives the settings.clients entry in every inbound it belongs to. Endpoints live under /panel/api/clients.
    - [Server](/docs/reference/api/server): System status, log retrieval, certificate generators, Xray binary management, and backup/restore. All under /panel/api/server.
    - [Settings](/docs/reference/api/settings): Panel configuration and user credentials. All endpoints live under /panel/api/setting and require a logged-in session or Bearer token.
    - [Xray Settings](/docs/reference/api/xray-settings): Xray configuration template, outbound management, Warp/Nord/PIA integration, and config testing. All endpoints under /panel/api/xray.
    - [Subscription Server](/docs/reference/api/subscription-server): A separate HTTP/HTTPS server that serves proxy subscription links (standard, JSON, and Clash) to clients. The server listens on its own port (default 2096) and is configured in Settings → Subscription. Fresh panels generate random path prefixes for each format; all paths remain configurable. Every subscription endpoint sets response headers for client apps to read traffic/expiry info.
    - [Subscription Balancers](/docs/reference/api/subscription-balancers): Client-side balancers for the JSON subscription: each enabled balancer is emitted as one extra config document whose members are the proxy outbounds of the selected inbounds (routing.balancers + burstObservatory). Managed in Settings → Sub Balancers.
    - [Hosts](/docs/reference/api/hosts): Per-inbound override endpoints. Each enabled host renders one extra subscription link/proxy with its own address/port/TLS, superseding the legacy externalProxy array. All endpoints under /panel/api/hosts.
    - [Nodes](/docs/reference/api/nodes): Manage remote 3x-ui panels acting as nodes for a central panel. All endpoints under /panel/api/nodes.
    - [Backup](/docs/reference/api/backup): Operations that interact with the configured Telegram bot.
    - [WebSocket](/docs/reference/api/websocket): Real-time status updates via WebSocket. Connect once at <code>ws://<panel>/ws</code> to receive a stream of JSON messages without polling. Requires an authenticated session cookie (Bearer token auth is not supported). Each message has a <code>type</code> field that identifies the payload shape.
- Help
  - [Troubleshooting](/docs/help/troubleshooting): Fix common 3x-ui problems — the panel won't start, 502 errors, certificate issues, and clients that can't connect.
  - [FAQ](/docs/help/faq): Frequently asked questions about 3x-ui — licensing, supported systems, databases, and clients.
  - [Migration](/docs/help/migration): Migrate to 3x-ui from x-ui, between servers, or between 3x-ui versions.
  - [Contributing](/docs/help/contributing): How to contribute to 3x-ui and to translate this documentation.

# Docs

- [مستندات 3x-ui](/fa/docs): مستندات رسمی 3x-ui — یک پنل وب پیشرفته برای مدیریت سرورهای Xray-core، پروکسی‌ها، کلاینت‌ها و سابسکریپشن‌ها.
- شروع به کار
  - [آشنایی با 3x-ui](/fa/docs/guide): یک پنل تحت وب برای Xray-core — ورودی‌ها، پروتکل‌ها، کلاینت‌ها و اشتراک‌ها را به‌جای ویرایش دستی JSON، از مرورگر خود مدیریت کنید.
  - [نصب](/fa/docs/guide/installation): نصب 3x-ui با اسکریپت رسمی (نسخهٔ پایدار، نسخهٔ مشخص یا dev-latest)، نصب خودکار/cloud-init یا Docker — و انتخاب میان SQLite و PostgreSQL.
  - [نخستین ورود](/fa/docs/guide/first-login): مشخصات ورود تولیدشدهٔ 3x-ui را بیابید، به پنل دسترسی پیدا کنید، احراز هویت دومرحله‌ای را فعال کنید و پیش از در معرض قرار دادن هر چیزی، پنل را ایمن‌سازی کنید.
  - [به‌روزرسانی و حذف](/fa/docs/guide/update-uninstall): مدیریت 3x-ui با منوی x-ui و خط فرمان — به‌روزرسانی (پایدار، dev یا نسخه‌های قدیمی)، تغییر تنظیمات و حذف تمیز و کامل.
- پیکربندی
  - [تنظیمات پنل](/fa/docs/config/panel): تمام تنظیمات پنل 3x-ui — وب‌سرور، TLS، نمایش، امنیت و اعلان‌ها — همراه با مقادیر پیش‌فرض برگرفته از سورس.
  - [گواهی‌های SSL](/fa/docs/config/ssl-certificates): دریافت و تمدید گواهی‌های TLS برای پنل و ورودی‌های 3x-ui — با منوی ACME در x-ui (دامنه یا IP خام)، گواهی wildcard از طریق Cloudflare DNS-01، یا Certbot دستی.
  - [ورودی‌ها و پروتکل‌ها](/fa/docs/config/inbounds): ساخت ورودی‌ها در 3x-ui — پروتکل‌ها، انتقال‌ها، بازنشانی و انقضای ترافیک، و fallbackهایی که چند پروتکل را روی یک پورت سرویس می‌دهند.
  - [REALITY](/fa/docs/config/reality): راه‌اندازی یک ورودی VLESS + REALITY همراه با XTLS-Vision در 3x-ui — کلیدها، short IDها، SNI، اثرانگشت‌ها و اشتباهات رایج.
  - [انتقال‌ها و امنیت](/fa/docs/config/transports): هر انتقالی که 3x-ui ارائه می‌دهد — TCP، mKCP، WebSocket، gRPC، HTTPUpgrade، XHTTP، Hysteria — به‌همراه تنظیماتشان، و نیز مبهم‌سازی FinalMask، sockopt، TLS/REALITY، XTLS-Vision و رمزنگاری VLESS.
  - [کلاینت‌ها](/fa/docs/config/clients): مدیریت کلاینت‌های 3x-ui — اعتبارنامه‌ها، محدودیت ترافیک و انقضا، محدودیت IP، گروه‌ها، اقدامات گروهی، لینک‌های خارجی و وضعیت آنلاین.
  - [Subscription](/fa/docs/config/subscription): راه‌اندازی سرور اشتراک 3x-ui — قالب‌های base64/JSON/Clash، پورت‌ها و مسیرها، TLS، هدرهای پاسخ و قالب‌های سفارشی.
  - [لینک‌های اشتراک‌گذاری](/fa/docs/config/share-links): قالب‌های لینک اشتراک‌گذاری 3x-ui (vless، vmess، trojan، ss، hysteria2، mtproto)، متغیرهای قالب توضیحات، و بازرس لینک درون‌مرورگری.
- عملیات
  - [پراکسی معکوس](/fa/docs/operations/reverse-proxy): قرار دادن پنل و اشتراک 3x-ui پشت Nginx یا Caddy همراه با TLS از Let's Encrypt.
  - [چندنودی و میزبان‌های مدیریت‌شده](/fa/docs/operations/multi-node): مدیریت چند پنل 3x-ui از یک مستر، با اعتماد مبتنی بر توکن API یا mTLS، ضربان قلب، و بازنویسی میزبان برای هر inbound جهت اشتراک‌ها.
  - [خروجی‌ها و مسیریابی](/fa/docs/operations/outbounds-routing): مدیریت ترافیک خروجی در 3x-ui — خروجی‌های WARP، NordVPN، WireGuard PIA، اشتراک‌های خروجی (مجموعه سرورها)، قواعد مسیریابی و متعادل‌کننده‌های بار.
  - [پشتیبان‌گیری و بازیابی](/fa/docs/operations/backup-restore): از پایگاه‌داده و گواهی‌های 3x-ui خود به‌صورت دستی یا از طریق ربات Telegram پشتیبان بگیرید و آن‌ها را بازیابی کنید.
  - [ربات Telegram](/fa/docs/operations/telegram-bot): یک ربات Telegram را به 3x-ui متصل کنید تا فرمان‌ها، گزارش‌های دوره‌ای، هشدارهای رویداد (ورود، CPU، بالا/پایین شدن نود)، پشتیبان‌گیری و سلف‌سرویس کلاینت‌ها را در اختیار داشته باشید.
  - [ربات Discord](/fa/docs/operations/discord-bot): یک ربات Discord را به 3x-ui متصل کنید تا اعلان‌های بی‌درنگ Embed، گزارش‌های دوره‌ای همراه با نسخه پشتیبان پایگاه‌داده و فرمان‌های تعاملی را در یک کانال دریافت کنید.
  - [امنیت](/fa/docs/operations/security): سخت‌سازی 3x-ui — احراز هویت پنل و 2FA، محدودیت IP با Fail2ban، قوانین فایروال، BBR و به‌روز ماندن.
- مرجع
  - [متغیرهای محیطی](/fa/docs/reference/env-vars): مرجع کامل متغیرهای محیطی ‎`XUI_*`‎ در 3x-ui — پایگاه‌داده، پنل، لاگ‌گیری، حافظه، رمزگذاری توکن نود و پایشگر سلامت تونل.
  - [پایگاه داده](/fa/docs/reference/database): بک‌اندهای ذخیره‌سازی 3x-ui — SQLite (پیش‌فرض) و PostgreSQL — مسیر پایگاه داده، استخر اتصال و مهاجرت از SQLite به PostgreSQL.
  - [پورت‌ها و فایروال](/fa/docs/reference/ports-firewall): پورت‌هایی که 3x-ui به‌صورت پیش‌فرض استفاده می‌کند و قواعد آماده ufw / nftables برای باز کردن آن‌ها.
  - مرجع API
    - [مرجع API](/fa/docs/reference/api): REST API پنل 3x-ui — احراز هویت، inboundها، کلاینت‌ها، آمار سرور و موارد دیگر، تولیدشده از مشخصات OpenAPI.
    - [احراز هویت](/fa/docs/reference/api/authentication): دو حالت احراز هویت پشتیبانی می‌شود. نشست‌های UI از یک کوکی استفاده می‌کنند که توسط نقطه‌پایانی ورود تنظیم می‌شود. کلاینت‌های برنامه‌نویسی‌شده (ربات‌ها، اسکریپت‌ها، پنل‌های راه دور) با یک توکن Bearer که از مسیر Settings → Security → API Token گرفته می‌شود احراز هویت می‌کنند. هر دو روش برای همهٔ نقاط‌پایانی زیر /panel/api/* کار می‌کنند.
    - [توکن‌های API](/fa/docs/reference/api/api-tokens): مدیریت توکن‌های Bearer برای احراز هویت برنامه‌نویسی‌شده (ربات‌ها، پنل‌های مرکزی که از طرف این نود عمل می‌کنند، CI). هر توکن یک نام یکتا و یک پرچم فعال‌سازی دارد — برای لغو بدون حذف، آن را غیرفعال کنید و برای لغو دائمی، آن را حذف کنید. توکن‌ها به صورت هش SHA-256 ذخیره می‌شوند و متن خام تنها یک‌بار، در پاسخ ایجاد، بازگردانده می‌شود — پس از آن قابل بازیابی نیست، بنابراین همان موقع آن را کپی کنید. برای هر درخواست /panel/api/* یکی را به صورت <code>Authorization: Bearer &lt;token&gt;</code> ارسال کنید — این توکن یک اعتبارنامهٔ مدیر کامل است.
    - [ورودی‌ها](/fa/docs/reference/api/inbounds): مدیریت پیکربندی‌های ورودی و کلاینت‌های آن‌ها. همهٔ endpointها زیر /panel/api/inbounds قرار دارند و به یک نشست واردشده یا توکن Bearer نیاز دارند. endpointهای تولیدکنندهٔ لینک تنها زمانی به هدرهای forwarded اعتنا می‌کنند که درخواست از یک پراکسی مورد اعتماد پیکربندی‌شده برسد.
    - [کلاینت‌ها](/fa/docs/reference/api/clients): کلاینت‌ها را به‌عنوان موجودیت‌های مستقل مدیریت کنید که می‌توانند به یک یا چند inbound متصل شوند. هر رکورد کلاینت، ورودی settings.clients را در تمام inboundهایی که به آن‌ها تعلق دارد هدایت می‌کند. این endpointها زیر مسیر /panel/api/clients قرار دارند.
    - [سرور](/fa/docs/reference/api/server): وضعیت سیستم، دریافت لاگ، تولیدکننده‌های گواهی، مدیریت باینری Xray و پشتیبان‌گیری/بازیابی. همگی زیرمجموعهٔ /panel/api/server.
    - [تنظیمات](/fa/docs/reference/api/settings): پیکربندی پنل و اطلاعات ورود کاربر. همه‌ی نقاط پایانی زیر /panel/api/setting قرار دارند و به یک نشست واردشده یا توکن Bearer نیاز دارند.
    - [تنظیمات Xray](/fa/docs/reference/api/xray-settings): قالب پیکربندی Xray، مدیریت outboundها، یکپارچه‌سازی Warp/Nord و آزمایش پیکربندی. همه‌ی نقاط پایانی زیر /panel/api/xray قرار دارند.
    - [سرور اشتراک](/fa/docs/reference/api/subscription-server): یک سرور HTTP/HTTPS جداگانه که لینک‌های اشتراک پراکسی (استاندارد، JSON و Clash) را به کلاینت‌ها ارائه می‌دهد. این سرور روی پورت اختصاصی خودش (به‌صورت پیش‌فرض 2096) گوش می‌دهد و در بخش Settings ← Subscription پیکربندی می‌شود. پنل‌های جدید برای هر قالب پیشوند مسیر تصادفی تولید می‌کنند و همه‌ی مسیرها قابل پیکربندی می‌مانند. همه‌ی نقاط پایانی اشتراک، هدرهای پاسخ را برای خواندن اطلاعات ترافیک/انقضا توسط برنامه‌های کلاینت تنظیم می‌کنند.
    - [هاست‌ها](/fa/docs/reference/api/hosts): نقاط پایانی بازنویسی به ازای هر inbound. هر host فعال یک لینک اشتراک/پراکسی اضافی با آدرس/پورت/TLS مخصوص خودش ارائه می‌دهد و جایگزین آرایه‌ی قدیمی externalProxy می‌شود. همه‌ی نقاط پایانی زیر /panel/api/hosts قرار دارند.
    - [نودها](/fa/docs/reference/api/nodes): مدیریت پنل‌های راه‌دور 3x-ui که به‌عنوان نود برای یک پنل مرکزی عمل می‌کنند. همهٔ اندپوینت‌ها زیر مسیر /panel/api/nodes.
    - [پشتیبان‌گیری](/fa/docs/reference/api/backup): عملیات‌هایی که با ربات Telegram پیکربندی‌شده تعامل دارند.
    - [WebSocket](/fa/docs/reference/api/websocket): دریافت به‌روزرسانی‌های وضعیت در لحظه از طریق WebSocket. تنها یک‌بار به <code>ws://<panel>/ws</code> متصل شوید تا بدون نیاز به polling، جریانی از پیام‌های JSON دریافت کنید. به یک کوکی نشست احرازهویت‌شده نیاز دارد (احرازهویت با توکن Bearer پشتیبانی نمی‌شود). هر پیام دارای یک فیلد <code>type</code> است که شکل داده‌ی آن را مشخص می‌کند.
- راهنما
  - [عیب‌یابی](/fa/docs/help/troubleshooting): رفع مشکلات رایج 3x-ui — اجرا نشدن پنل، خطاهای 502، مشکلات گواهی و کلاینت‌هایی که نمی‌توانند متصل شوند.
  - [سؤالات متداول](/fa/docs/help/faq): پرسش‌های پرتکرار درباره 3x-ui — مجوز، سیستم‌های پشتیبانی‌شده، پایگاه‌های داده و کلاینت‌ها.
  - [مهاجرت](/fa/docs/help/migration): مهاجرت به 3x-ui از x-ui، بین سرورها یا بین نسخه‌های 3x-ui.
  - [مشارکت](/fa/docs/help/contributing): چگونه در توسعه 3x-ui مشارکت کنید و این مستندات را ترجمه کنید.

# Docs

- [Документация 3x-ui](/ru/docs): Официальная документация по 3x-ui — продвинутой веб-панели для управления серверами Xray-core, прокси, клиентами и подписками.
- Начало работы
  - [Знакомство с 3x-ui](/ru/docs/guide): Веб-панель для Xray-core — управляйте входящими подключениями, протоколами, клиентами и подписками из браузера, не редактируя JSON вручную.
  - [Установка](/ru/docs/guide/installation): Установите 3x-ui с помощью официального скрипта (стабильная, фиксированная или dev-сборка), в автоматическом режиме / через cloud-init либо в Docker — и выберите SQLite или PostgreSQL.
  - [Первый вход](/ru/docs/guide/first-login): Найдите сгенерированные учётные данные 3x-ui, откройте панель, включите двухфакторную аутентификацию и защитите её, прежде чем открывать доступ извне.
  - [Обновление и удаление](/ru/docs/guide/update-uninstall): Управляйте 3x-ui через меню и CLI x-ui — обновляйте (стабильная, dev- или старая версия), меняйте настройки и удаляйте панель без остатков.
- Конфигурация
  - [Настройки панели](/ru/docs/config/panel): Все настройки панели 3x-ui — веб-сервер, TLS, отображение, безопасность и уведомления — со значениями по умолчанию из исходного кода.
  - [SSL-сертификаты](/ru/docs/config/ssl-certificates): Получение и продление TLS-сертификатов для панели и входящих подключений 3x-ui — через меню ACME в x-ui (домен или голый IP), wildcard через Cloudflare DNS-01 или вручную с помощью Certbot.
  - [Входящие подключения и протоколы](/ru/docs/config/inbounds): Создание входящих подключений в 3x-ui — протоколы, транспорты, сброс трафика и срок действия, а также fallback-правила, обслуживающие несколько протоколов на одном порту.
  - [REALITY](/ru/docs/config/reality): Настройка входящего подключения VLESS + REALITY с XTLS-Vision в 3x-ui — ключи, short ID, SNI, отпечатки и типичные ошибки.
  - [TUIC](/ru/docs/config/tuic): Настройка входящего подключения TUIC в 3x-ui — параметры перегрузок QUIC, 0-RTT рукопожатия и многопользовательская аутентификация.
  - [Транспорты и безопасность](/ru/docs/config/transports): Все транспорты, которые предоставляет 3x-ui — TCP, mKCP, WebSocket, gRPC, HTTPUpgrade, XHTTP, Hysteria — с их настройками, а также обфускация FinalMask, sockopt, TLS/REALITY, XTLS-Vision и шифрование VLESS.
  - [Клиенты](/ru/docs/config/clients): Управление клиентами 3x-ui — учётные данные, лимиты трафика и срока действия, ограничения по IP, группы, массовые операции, внешние ссылки и статус онлайн.
  - [Подписка](/ru/docs/config/subscription): Запуск сервера подписок 3x-ui — форматы base64/JSON/Clash, порты и пути, TLS, заголовки ответа и пользовательские шаблоны.
  - [Ссылки для обмена](/ru/docs/config/share-links): Форматы ссылок для обмена в 3x-ui (vless, vmess, trojan, ss, hysteria2, mtproto), переменные шаблона примечания и инспектор ссылок в браузере.
- Эксплуатация
  - [Обратный прокси](/ru/docs/operations/reverse-proxy): Разместите панель 3x-ui и подписку за Nginx или Caddy с TLS от Let's Encrypt.
  - [Несколько узлов и управляемые хосты](/ru/docs/operations/multi-node): Управляйте несколькими панелями 3x-ui из одной главной панели — с доверием на основе API-токена или mTLS, heartbeat-сигналами и переопределением хостов для отдельных inbound-соединений в подписках.
  - [Исходящие соединения и маршрутизация](/ru/docs/operations/outbounds-routing): Управляйте исходящим трафиком в 3x-ui — WARP, NordVPN, PIA WireGuard, подписки на исходящие соединения (пулы серверов), правила маршрутизации и балансировщики нагрузки.
  - [Резервное копирование и восстановление](/ru/docs/operations/backup-restore): Создавайте резервные копии базы данных и сертификатов 3x-ui и восстанавливайте их вручную или через Telegram-бота.
  - [Telegram-бот](/ru/docs/operations/telegram-bot): Подключите Telegram-бота к 3x-ui для выполнения команд, периодических отчётов, оповещений о событиях (вход, CPU, доступность узлов), резервных копий и самообслуживания клиентов.
  - [Discord-бот](/ru/docs/operations/discord-bot): Подключите Discord-бота к 3x-ui для получения оповещений о событиях панели (сбои сервисов, доступность узлов, нагрузка CPU/RAM и попытки входа) прямо в канал Discord.
  - [Безопасность](/ru/docs/operations/security): Усиление защиты 3x-ui — аутентификация панели и 2FA, ограничение IP через Fail2ban, правила брандмауэра, BBR и поддержание актуальности.
- Справочник
  - [Переменные окружения](/ru/docs/reference/env-vars): Полный справочник по переменным окружения XUI_* в 3x-ui — база данных, панель, логирование, память, шифрование токенов узлов и монитор работоспособности туннеля.
  - [База данных](/ru/docs/reference/database): Хранилища данных 3x-ui — SQLite (по умолчанию) и PostgreSQL — путь к базе данных, пул соединений и миграция с SQLite на PostgreSQL.
  - [Порты и брандмауэр](/ru/docs/reference/ports-firewall): Порты, которые 3x-ui использует по умолчанию, и готовые правила ufw / nftables для их открытия.
  - Справочник по API
    - [Справочник по API](/ru/docs/reference/api): REST API панели 3x-ui — аутентификация, входящие подключения, клиенты, статистика сервера и многое другое, сгенерировано из спецификации OpenAPI.
    - [Аутентификация](/ru/docs/reference/api/authentication): Поддерживаются два режима аутентификации. Сессии веб-интерфейса используют cookie, устанавливаемый эндпоинтом входа. Программные клиенты (боты, скрипты, удалённые панели) аутентифицируются с помощью Bearer-токена, взятого из Settings → Security → API Token. Оба способа работают для всех эндпоинтов под /panel/api/*.
    - [Токены API](/ru/docs/reference/api/api-tokens): Управление токенами Bearer для программной аутентификации (боты, центральные панели, действующие от имени этого узла, CI). У каждого токена есть уникальное имя и флаг активности — отключите токен, чтобы отозвать его без удаления, либо удалите, чтобы отозвать окончательно. Токены хранятся в виде хешей SHA-256, а открытый текст возвращается лишь один раз, в ответе на создание — впоследствии получить его нельзя, поэтому скопируйте его сразу. Передавайте токен как <code>Authorization: Bearer &lt;token&gt;</code> в любом запросе /panel/api/* — такой токен даёт полные права администратора.
    - [Входящие подключения](/ru/docs/reference/api/inbounds): Управление конфигурациями входящих подключений и их клиентами. Все эндпоинты находятся в /panel/api/inbounds и требуют активной сессии входа или Bearer-токена. Эндпоинты, генерирующие ссылки, учитывают перенаправленные заголовки только тогда, когда запрос приходит от настроенного доверенного прокси.
    - [Клиенты](/ru/docs/reference/api/clients): Управление клиентами как самостоятельными сущностями, которые можно привязать к одному или нескольким входящим подключениям. Одна запись клиента формирует элемент settings.clients в каждом входящем подключении, к которому он привязан. Эндпоинты находятся в /panel/api/clients.
    - [Сервер](/ru/docs/reference/api/server): Состояние системы, получение логов, генераторы сертификатов, управление бинарным файлом Xray, а также резервное копирование и восстановление. Все эндпоинты находятся в /panel/api/server.
    - [Настройки](/ru/docs/reference/api/settings): Конфигурация панели и учётные данные пользователя. Все эндпоинты находятся под /panel/api/setting и требуют активной сессии или токена Bearer.
    - [Настройки Xray](/ru/docs/reference/api/xray-settings): Шаблон конфигурации Xray, управление исходящими подключениями, интеграция с Warp/Nord и тестирование конфигурации. Все эндпоинты находятся в /panel/api/xray.
    - [Сервер подписок](/ru/docs/reference/api/subscription-server): Отдельный HTTP/HTTPS-сервер, который отдаёт клиентам ссылки на подписки прокси (стандартные, JSON и Clash). Сервер слушает на собственном порту (по умолчанию 2096) и настраивается в разделе Settings → Subscription. Новые панели генерируют случайные префиксы путей для каждого формата; все пути можно изменить. Все конечные точки подписок устанавливают заголовки ответа, по которым клиентские приложения считывают информацию о трафике и сроке действия.
    - [Хосты](/ru/docs/reference/api/hosts): Эндпоинты переопределений на уровне отдельного входящего подключения. Каждый включённый хост добавляет одну дополнительную ссылку подписки/прокси с собственными адресом/портом/TLS, заменяя устаревший массив externalProxy. Все эндпоинты находятся в /panel/api/hosts.
    - [Узлы](/ru/docs/reference/api/nodes): Управление удалёнными панелями 3x-ui, выступающими в роли узлов центральной панели. Все эндпоинты находятся в /panel/api/nodes.
    - [Резервное копирование](/ru/docs/reference/api/backup): Операции, взаимодействующие с настроенным ботом Telegram.
    - [WebSocket](/ru/docs/reference/api/websocket): Обновления статуса в реальном времени через WebSocket. Подключитесь один раз к <code>ws://<panel>/ws</code>, чтобы получать поток JSON-сообщений без опроса. Требуется аутентифицированный сессионный cookie (авторизация по токену Bearer не поддерживается). У каждого сообщения есть поле <code>type</code>, которое определяет структуру полезной нагрузки.
- Помощь
  - [Устранение неполадок](/ru/docs/help/troubleshooting): Решение типичных проблем 3x-ui — панель не запускается, ошибки 502, проблемы с сертификатами и клиенты, которые не могут подключиться.
  - [Частые вопросы](/ru/docs/help/faq): Часто задаваемые вопросы о 3x-ui — лицензирование, поддерживаемые системы, базы данных и клиенты.
  - [Миграция](/ru/docs/help/migration): Перенесите данные на 3x-ui с x-ui, между серверами или между версиями 3x-ui.
  - [Участие в проекте](/ru/docs/help/contributing): Как внести вклад в 3x-ui и помочь с переводом этой документации.

# Docs

- [3x-ui 文档](/zh/docs): 3x-ui 官方文档 —— 用于管理 Xray-core 服务器、代理、客户端与订阅的高级 Web 面板。
- 快速开始
  - [认识 3x-ui](/zh/docs/guide): 面向 Xray-core 的 Web 面板——在浏览器中管理入站、协议、客户端与订阅，无需手动编辑 JSON。
  - [安装](/zh/docs/guide/installation): 通过官方脚本（稳定版、指定版本或开发最新版）、无人值守 / cloud-init 或 Docker 安装 3x-ui，并选择 SQLite 或 PostgreSQL。
  - [首次登录](/zh/docs/guide/first-login): 找到自动生成的 3x-ui 登录凭据，进入面板，启用双因素认证，并在对外暴露任何内容之前完成安全加固。
  - [更新与卸载](/zh/docs/guide/update-uninstall): 使用 x-ui 菜单和命令行管理 3x-ui——更新（稳定版、开发版或指定旧版本）、修改设置，以及干净地卸载。
- 配置
  - [面板设置](/zh/docs/config/panel): 全部 3x-ui 面板设置——Web 服务器、TLS、显示、安全与通知——并附上源码中的默认值。
  - [SSL 证书](/zh/docs/config/ssl-certificates): 为 3x-ui 面板和入站获取并续期 TLS 证书——可使用 x-ui 的 ACME 菜单（域名或裸 IP）、Cloudflare DNS-01 通配符，或手动 Certbot。
  - [入站与协议](/zh/docs/config/inbounds): 在 3x-ui 中创建入站——协议、传输方式、流量重置与到期，以及在同一端口上服务多种协议的回落（fallback）。
  - [REALITY](/zh/docs/config/reality): 在 3x-ui 中配合 XTLS-Vision 搭建 VLESS + REALITY 入站——密钥、short ID、SNI、指纹以及常见陷阱。
  - [传输方式与安全层](/zh/docs/config/transports): 3x-ui 提供的每一种传输方式——TCP、mKCP、WebSocket、gRPC、HTTPUpgrade、XHTTP、Hysteria——及其设置项，外加 FinalMask 混淆、sockopt、TLS/REALITY、XTLS-Vision 以及 VLESS 加密。
  - [客户端](/zh/docs/config/clients): 管理 3x-ui 客户端——凭据、流量与到期限制、IP 限制、分组、批量操作、外部链接以及在线状态。
  - [订阅](/zh/docs/config/subscription): 运行 3x-ui 订阅服务器 —— base64/JSON/Clash 格式、端口与路径、TLS、响应头以及自定义模板。
  - [分享链接](/zh/docs/config/share-links): 3x-ui 的分享链接格式（vless、vmess、trojan、ss、hysteria2、mtproto）、备注模板变量，以及一个浏览器内的链接检查器。
- 运维
  - [反向代理](/zh/docs/operations/reverse-proxy): 通过 Nginx 或 Caddy 为 3x-ui 面板和订阅提供 Let's Encrypt TLS 保护。
  - [多节点与受管主机](/zh/docs/operations/multi-node): 通过 API 令牌或 mTLS 信任、心跳检测以及针对每个入站的主机覆盖，从一个主控面板统一管理多个 3x-ui 面板并定制订阅。
  - [出站与路由](/zh/docs/operations/outbounds-routing): 在 3x-ui 中调整出口流量——WARP、NordVPN、PIA WireGuard、出站订阅（服务器池）、路由规则以及负载均衡器。
  - [备份与恢复](/zh/docs/operations/backup-restore): 手动或通过 Telegram 机器人备份并恢复你的 3x-ui 数据库与证书。
  - [Telegram 机器人](/zh/docs/operations/telegram-bot): 将 Telegram 机器人接入 3x-ui，实现命令交互、周期性报告、事件告警（登录、CPU、节点上线/下线）、备份以及客户端自助服务。
  - [Discord 机器人](/zh/docs/operations/discord-bot): 将 Discord 机器人接入 3x-ui，在指定频道接收实时的面板事件 Embed 告警、周期性健康报告（含数据库备份）以及执行交互式控制命令。
  - [安全加固](/zh/docs/operations/security): 加固 3x-ui——面板认证与 2FA、Fail2ban IP 限制、防火墙规则、BBR，以及保持更新。
- 参考
  - [环境变量](/zh/docs/reference/env-vars): 3x-ui 的 XUI_* 环境变量完整参考——涵盖数据库、面板、日志、内存、节点令牌加密以及隧道健康监测器。
  - [数据库](/zh/docs/reference/database): 3x-ui 的存储后端——SQLite（默认）与 PostgreSQL——涵盖数据库路径、连接池以及从 SQLite 到 PostgreSQL 的迁移。
  - [端口与防火墙](/zh/docs/reference/ports-firewall): 3x-ui 默认使用的端口，以及用于开放这些端口的现成 ufw / nftables 规则。
  - API 参考
    - [API 参考](/zh/docs/reference/api): 3x-ui 面板的 REST API —— 涵盖认证、入站、客户端、服务器状态等，依据 OpenAPI 规范自动生成。
    - [身份验证](/zh/docs/reference/api/authentication): 支持两种身份验证模式。UI 会话使用登录端点设置的 Cookie。程序化客户端（机器人、脚本、远程面板）则使用从“设置 → 安全 → API Token”获取的 Bearer token 进行身份验证。两者都适用于 /panel/api/* 下的所有端点。
    - [API 令牌](/zh/docs/reference/api/api-tokens): 管理用于程序化认证的 Bearer 令牌（机器人、代表本节点操作的中心面板、CI）。每个令牌都有唯一的名称和一个启用标志——禁用即可在不删除的情况下吊销，删除则为永久吊销。令牌以 SHA-256 哈希形式存储，明文仅在创建响应中返回一次——此后无法再次获取，因此请当场复制保存。在任意 /panel/api/* 请求中以 <code>Authorization: Bearer &lt;token&gt;</code> 的形式发送令牌——该令牌是一份完全管理员凭据。
    - [入站](/zh/docs/reference/api/inbounds): 管理入站配置及其客户端。所有端点均位于 /panel/api/inbounds 下，需要已登录的会话或 Bearer 令牌。生成链接的端点仅在请求来自已配置的受信任代理时，才会采信转发请求头。
    - [客户端](/zh/docs/reference/api/clients): 将客户端作为一等实体进行管理，可将其挂载到一个或多个入站。单条客户端记录会驱动其所属 每个入站中的 settings.clients 条目。相关端点位于 /panel/api/clients 之下。
    - [服务器](/zh/docs/reference/api/server): 系统状态、日志获取、证书生成器、Xray 二进制文件管理以及备份/恢复。所有接口均位于 /panel/api/server 下。
    - [设置](/zh/docs/reference/api/settings): 面板配置与用户凭据。所有端点均位于 /panel/api/setting 之下，需要已登录的会话或 Bearer 令牌。
    - [Xray 设置](/zh/docs/reference/api/xray-settings): Xray 配置模板、出站管理、Warp/Nord 集成以及配置测试。所有端点均位于 /panel/api/xray 下。
    - [订阅服务器](/zh/docs/reference/api/subscription-server): 一个独立的 HTTP/HTTPS 服务器，用于向客户端提供代理订阅链接（标准、JSON 和 Clash）。该服务器监听自己的端口（默认 2096），并在“设置 → 订阅”中进行配置。新面板会为每种格式生成随机路径前缀，所有路径仍可自定义。所有订阅端点都会设置响应头，供客户端应用读取流量/到期信息。
    - [主机](/zh/docs/reference/api/hosts): 按入站逐项覆盖的端点。每个启用的主机都会额外生成一条订阅链接/代理，可拥有独立的 地址/端口/TLS，从而取代已弃用的 externalProxy 数组。所有端点均位于 /panel/api/hosts 之下。
    - [节点](/zh/docs/reference/api/nodes): 管理作为中心面板节点的远程 3x-ui 面板。所有端点均位于 /panel/api/nodes 之下。
    - [备份](/zh/docs/reference/api/backup): 与已配置的 Telegram 机器人进行交互的操作。
    - [WebSocket](/zh/docs/reference/api/websocket): 通过 WebSocket 获取实时状态更新。只需在 <code>ws://<panel>/ws</code> 建立一次连接，即可接收 JSON 消息流，无需轮询。需要经过身份验证的会话 Cookie（不支持 Bearer token 身份验证）。每条消息都带有一个 <code>type</code> 字段，用于标识其载荷结构。
- 帮助
  - [故障排查](/zh/docs/help/troubleshooting): 解决 3x-ui 常见问题——面板无法启动、502 错误、证书问题，以及客户端无法连接。
  - [常见问题](/zh/docs/help/faq): 关于 3x-ui 的常见问题 —— 许可协议、受支持的系统、数据库以及客户端。
  - [迁移](/zh/docs/help/migration): 从 x-ui 迁移到 3x-ui、在服务器之间迁移，或在不同 3x-ui 版本之间迁移。
  - [参与贡献](/zh/docs/help/contributing): 如何为 3x-ui 贡献代码并翻译本文档。