v3

Sanaei
2026-06-03 00:36:10 +02:00
parent fa09b9efb4
commit 204fb51286
+70 -53
@@ -7,123 +7,140 @@
## What's that? ## What's that?
**3X-UI** — advanced, open-source web-based control panel designed for managing Xray-core server. It offers a user-friendly interface for configuring and monitoring various VPN and proxy protocols. **3X-UI** — an advanced, open-source web-based control panel for managing [Xray-core](https://github.com/XTLS/Xray-core) servers. It provides a clean, multi-language interface for deploying, configuring, and monitoring a wide range of proxy and VPN protocols — from a single VPS to multi-node deployments.
> [!IMPORTANT] > [!IMPORTANT]
> This project is only for personal using and communication, please do not use it for illegal purposes, please do not use it in a production environment. > This project is intended for personal use only. Please do not use it for illegal purposes or in a production environment.
As an enhanced fork of the original X-UI project, 3X-UI provides improved stability, broader protocol support, and additional features. Built as an enhanced fork of the original X-UI project, 3X-UI adds broader protocol support, improved stability, per-client traffic accounting, and many quality-of-life features.
## Features ## Features
* System Status Monitoring * System status monitoring
* Search within all inbounds and clients * Search within all inbounds and clients
* Supports multi-user and multi-protocol * Multi-user and multi-protocol support
* Supports protocols, including `VMESS`, `VLESS`, `Trojan`, `Shadowsocks`, `Tunnel`, `Mixed`, `HTTP`, `Wireguard` * Supported protocols: `VLESS`, `VMess`, `Trojan`, `Shadowsocks`, `WireGuard`, `Hysteria2`, `HTTP`, `SOCKS` (Mixed), `Dokodemo-door` / `Tunnel`, and `TUN`
* Supports XTLS native Protocols, including `RPRX-Direct`, `Vision`, `REALITY` * Modern transports — TCP (Raw), mKCP, WebSocket, gRPC, HTTPUpgrade, and XHTTP
* Traffic statistics, traffic limit, expiration time limit * XTLS-native security: `Vision` and `REALITY` (alongside TLS and XTLS)
* Fallbacks — serve multiple protocols on a single port (e.g. VLESS and Trojan on 443)
* Per-client management — traffic quotas, expiry dates, IP limits, live online status
* One-click share links, QR codes, and a built-in subscription server with multiple output formats
* Traffic statistics — per inbound, per client, and per outbound, with reset controls
* Multi-node support — manage and scale across multiple servers from a single panel
* Outbound & routing — WARP, NordVPN, custom routing rules, load balancers, and outbound proxy chaining
* Customizable Xray configuration templates * Customizable Xray configuration templates
* Supports HTTPS access panel (self-provided domain name + SSL certificate) * HTTPS panel access (self-provided domain + SSL certificate)
* Supports One-Click SSL certificate application and automatic renewal * One-click SSL certificate issuance and automatic renewal
* For more advanced configuration items, please refer to the panel * Export / import the database from the panel
* Fixes API routes (user setting will be created with API) * Out-of-the-box geofile (geosite / geoip) updates
* Supports changing configs by different items provided in the panel. * RESTful API with in-panel Swagger documentation
* Supports export/import database from the panel * Flexible storage — SQLite (default) or PostgreSQL
* Supports updating geofiles (geosite's/geoip's) out of the box * Telegram bot for remote monitoring and management
* Provides an opportunity to create a bot in Telegram to control the panel * Fail2ban integration for enforcing per-client IP limits
## Supported OS ## Supported OS
> [!TIP] > [!TIP]
> If you don't have your OS here, you can use Docker > If you don't have your OS here, you can use Docker
At the moment we support major operating systems, here is the list of OS on which we have tested the panel support At the moment we support the major operating systems below, on which the panel has been tested:
| System | System
| - | -
| Ubuntu | Ubuntu
| Debian | Debian
| CentOS
| OpenEuler
| Fedora | Fedora
| CentOS
| RHEL
| AlmaLinux | AlmaLinux
| Rocky Linux | Rocky Linux
| Oracle Linux | Oracle Linux
| Amazon Linux | Amazon Linux
| Virtuozzo Linux | Virtuozzo Linux
| Windows
| Arch Linux | Arch Linux
| Parch Linux
| Manjaro | Manjaro
| Parch Linux
| Armbian | Armbian
| OpenSUSE | openSUSE (Tumbleweed / Leap)
| Alpine Linux
| Windows
## Supported architectures ## Supported architectures
Our platform offers compatibility with a diverse range of architectures and devices, ensuring flexibility across various computing environments. The following are key architectures that we support: Our platform is compatible with a diverse range of architectures and devices, ensuring flexibility across various computing environments:
* `amd64` (recommended): This prevalent architecture is the standard for personal computers and servers, accommodating most modern operating systems seamlessly. * `amd64` (recommended): The standard architecture for personal computers and servers, supported seamlessly by most modern operating systems.
* `x86` / `i386`: Widely adopted in desktop and laptop computers, this architecture enjoys broad support from numerous operating systems and applications, including but not limited to Windows, macOS, and Linux systems. * `386` / `x86` / `i386`: Widely used in older desktop and laptop computers, with broad support across Windows and Linux systems.
* `armv8` / `arm64` / `aarch64`: Tailored for contemporary mobile and embedded devices, such as smartphones and tablets, this architecture is exemplified by devices like Raspberry Pi 4, Raspberry Pi 3, Raspberry Pi Zero 2/Zero 2 W, Orange Pi 3 LTS, and more. * `arm64` / `armv8` / `aarch64`: Tailored for contemporary mobile and embedded devices such as the Raspberry Pi 4, Raspberry Pi 3, Raspberry Pi Zero 2 / Zero 2 W, Orange Pi 3 LTS, and more.
* `armv7` / `arm` / `arm32`: Serving as the architecture for older mobile and embedded devices, it remains widely utilized in devices like Orange Pi Zero LTS, Orange Pi PC Plus, Raspberry Pi 2, among others. * `armv7` / `arm` / `arm32`: The architecture for older mobile and embedded devices, still widely used in boards like the Orange Pi Zero LTS, Orange Pi PC Plus, and Raspberry Pi 2.
* `armv6` / `arm` / `arm32`: Geared towards very old embedded devices, this architecture, while less prevalent, is still in use. Devices such as Raspberry Pi 1, Raspberry Pi Zero/Zero W, rely on this architecture. * `armv6` / `arm` / `arm32`: Geared towards very old embedded devices such as the Raspberry Pi 1 and Raspberry Pi Zero / Zero W.
* `armv5` / `arm` / `arm32`: An older architecture primarily associated with early embedded systems, it is less common today but may still be found in legacy devices like early Raspberry Pi versions and some older smartphones. * `armv5` / `arm` / `arm32`: An older architecture primarily associated with early embedded systems; less common today but still found in legacy devices.
* `s390x`: This architecture is commonly used in IBM mainframe computers and offers high performance and reliability for enterprise workloads. * `s390x`: Commonly used in IBM mainframe computers, offering high performance and reliability for enterprise workloads.
## Supported languages ## Supported languages
We currently support the following languages We currently support the following languages:
| Flag | Languages | | Flag | Language |
| - | - | | - | - |
| ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/sa.svg) | Arabic |
| ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/us.svg) | English | | ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/us.svg) | English |
| ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/ir.svg) | Persian | | ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/ir.svg) | Persian (فارسی) |
| ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/cn.svg) | Traditional Chinese | | ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/sa.svg) | Arabic (العربية) |
| ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/cn.svg) | Simplified Chinese | | ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/cn.svg) | Simplified Chinese (简体中文) |
| ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/jp.svg) | Japanese | | ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/tw.svg) | Traditional Chinese (繁體中文) |
| ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/ru.svg) | Russian | | ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/es.svg) | Spanish (Español) |
| ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/vn.svg) | Vietnamese | | ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/ru.svg) | Russian (Русский) |
| ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/es.svg) | Spanish | | ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/ua.svg) | Ukrainian (Українська) |
| ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/id.svg) | Indonesian | | ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/tr.svg) | Turkish (Türkçe) |
| ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/ua.svg) | Ukrainian | | ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/vn.svg) | Vietnamese (Tiếng Việt) |
| ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/tr.svg) | Turkish | | ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/jp.svg) | Japanese (日本語) |
| ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/id.svg) | Indonesian (Bahasa Indonesia) |
| ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/br.svg) | Português (Brazil) | | ![Flag](https://cdn.jsdelivr.net/gh/hampusborgos/country-flags@main/svg/br.svg) | Português (Brazil) |
## Screenshots ## Screenshots
<picture> <picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/MHSanaei/3x-ui/raw/main/media/01-overview-dark.png"> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/MHSanaei/3x-ui/raw/main/media/01-overview-dark.png">
<img alt="3x-ui" src="https://github.com/MHSanaei/3x-ui/raw/main/media/01-overview-light.png"> <img alt="Overview" src="https://github.com/MHSanaei/3x-ui/raw/main/media/01-overview-light.png">
</picture> </picture>
<picture> <picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/MHSanaei/3x-ui/raw/main/media/02-inbounds-dark.png"> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/MHSanaei/3x-ui/raw/main/media/02-inbounds-dark.png">
<img alt="3x-ui" src="https://github.com/MHSanaei/3x-ui/raw/main/media/02-inbounds-light.png"> <img alt="Inbounds" src="https://github.com/MHSanaei/3x-ui/raw/main/media/02-inbounds-light.png">
</picture> </picture>
<picture> <picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/MHSanaei/3x-ui/raw/main/media/03-add-inbound-dark.png"> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/MHSanaei/3x-ui/raw/main/media/03-client-dark.png">
<img alt="3x-ui" src="https://github.com/MHSanaei/3x-ui/raw/main/media/03-add-inbound-light.png"> <img alt="Client" src="https://github.com/MHSanaei/3x-ui/raw/main/media/03-client-light.png">
</picture> </picture>
<picture> <picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/MHSanaei/3x-ui/raw/main/media/04-add-client-dark.png"> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/MHSanaei/3x-ui/raw/main/media/04-group-dark.png">
<img alt="3x-ui" src="https://github.com/MHSanaei/3x-ui/raw/main/media/04-add-client-light.png"> <img alt="Group" src="https://github.com/MHSanaei/3x-ui/raw/main/media/04-group-light.png">
</picture> </picture>
<picture> <picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/MHSanaei/3x-ui/raw/main/media/05-settings-dark.png"> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/MHSanaei/3x-ui/raw/main/media/05-nodes-dark.png">
<img alt="3x-ui" src="https://github.com/MHSanaei/3x-ui/raw/main/media/05-settings-light.png"> <img alt="Nodes" src="https://github.com/MHSanaei/3x-ui/raw/main/media/05-nodes-light.png">
</picture> </picture>
<picture> <picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/MHSanaei/3x-ui/raw/main/media/06-configs-dark.png"> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/MHSanaei/3x-ui/raw/main/media/06-settings-dark.png">
<img alt="3x-ui" src="https://github.com/MHSanaei/3x-ui/raw/main/media/06-configs-light.png"> <img alt="Settings" src="https://github.com/MHSanaei/3x-ui/raw/main/media/06-settings-light.png">
</picture>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/MHSanaei/3x-ui/raw/main/media/07-configs-dark.png">
<img alt="Configs" src="https://github.com/MHSanaei/3x-ui/raw/main/media/07-configs-light.png">
</picture>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/MHSanaei/3x-ui/raw/main/media/08-api-docs-dark.png">
<img alt="API docs" src="https://github.com/MHSanaei/3x-ui/raw/main/media/08-api-docs-light.png">
</picture> </picture>