MHSanaei/3x-ui
Open-source web control panel for deploying and managing Xray-core proxy and VPN servers with multi-protocol, multi-user support.
- Stars
- 49,429
- Forks
- 12,670
- Open issues
- 239
- Last commit
- 21 hours ago
What is it?
3X-UI is a web control panel for running Xray-core servers. It lets you create inbounds for protocols such as VLESS, VMess, Trojan, Shadowsocks, WireGuard, Hysteria2, TUIC v5, MTProto and SOCKS, then add clients to each one with traffic quotas, expiry dates and IP limits. Instead of editing Xray JSON configs by hand, operators manage everything from a browser UI.
The panel covers day-to-day operations: per-inbound, per-client and per-outbound traffic statistics, share links, QR codes and a built-in subscription server that returns raw, JSON or Clash output. It can manage several servers from one panel, offers routing rules and outbound chaining, and includes Telegram and Discord bots plus a scoped REST API. Storage is SQLite by default, with PostgreSQL as an option.
The project is a fork of the original X-UI and targets personal use. Installation is a single shell script that supports a long list of Linux distributions and Windows.
Key features
- 01Supports many inbound protocols including VLESS, VMess, Trojan, Shadowsocks, WireGuard, Hysteria2 and MTProto.
- 02Per-client traffic quotas, expiry dates, IP limits and device limits.
- 03Traffic statistics broken down by inbound, client and outbound.
- 04Built-in subscription server with raw, JSON and Clash output.
- 05Manage multiple nodes from a single panel.
- 06Telegram and Discord bots and a RESTful API with scoped tokens.
- 07Choice of SQLite or PostgreSQL storage.
Use cases
- Running a personal VPN or proxy server on a single VPS.
- Managing several proxy nodes across different regions from one dashboard.
- Issuing subscription links so clients can import configs automatically.
- Enforcing per-user traffic and expiry limits on a shared server.
Quick start
- 1
Run the official install script from the README (downloads and runs a shell script; check it first)
- 2
Open the management menu after installation
x-ui
Things to know
- The README says it is intended for personal use only and should not be used in production.
- Licensed under GPL-3.0, a copyleft license that requires derivative works to remain open source.
- Installation relies on a remote shell script that runs with system-level access.
In collections
Topics
FAQ
- What is 3x-ui?
- Open-source web control panel for deploying and managing Xray-core proxy and VPN servers with multi-protocol, multi-user support. 3X-UI is a web control panel for running Xray-core servers. It lets you create inbounds for protocols such as VLESS, VMess, Trojan, Shadowsocks, WireGuard, Hysteria2, TUIC v5, MTProto and SOCKS, then add clients to each one with traffic quotas, expiry dates and IP limits. Instead of editing Xray JSON configs by hand, operators manage everything from a browser UI.
- Is 3x-ui free to use? What license does it have?
- 3x-ui is open source under the GPL-3.0 license. Check the license terms before using it in commercial products.
- Is 3x-ui still maintained?
- Actively maintained. The last commit to 3x-ui was on Nov 6, 2026.
- What can I use 3x-ui for?
- Running a personal VPN or proxy server on a single VPS. Managing several proxy nodes across different regions from one dashboard. Issuing subscription links so clients can import configs automatically. Enforcing per-user traffic and expiry limits on a shared server.
- How do I install 3x-ui?
- Run the official install script from the README (downloads and runs a shell script; check it first) Open the management menu after installation: x-ui
- Where can I get 3x-ui?
- The source code and installation instructions are on GitHub: https://github.com/MHSanaei/3x-ui
Summary generated by AI from the project's README. GitHub stats refresh daily.
Related projects
An Android client for the V2Ray proxy platform, supporting both Xray core and v2fly core.
An Android app that combines many VPN and proxy engines, including Xray, WARP, Psiphon, Tor, and WireGuard, with per-app routing and a serverless messenger.
A Prometheus exporter that probes external VPN services over VMESS, VLESS, Trojan, WireGuard, AmneziaWG, Shadowsocks and Hysteria2 to report their availability.
A multi-platform proxy client built on the mihomo (Clash.Meta) core for Android, Windows, macOS and Linux.
A Go network platform and proxy core supporting protocols such as VLESS, VMess, Trojan, Shadowsocks, WireGuard, and REALITY.