Xray panel supporting multi-protocol multi-user expire day & traffic & ip limit (Vmess & Vless & Trojan & ShadowSocks & Wireguard)
Find a file
MHSanaei e70f0e5e5c
feat(sub): usage summary card + remark-email on QR popover labels
SubPage now opens with a clear quota panel directly under the info
table: large `used / total` numbers, gradient progress bar (green ≤
75%, orange to 90%, red above), `remained` and `%` on the foot, plus
a Tag chip for unlimited subscriptions and a coloured chip for days
left until expiry (blue >3d, orange ≤3d, red on expiry). Driven
entirely off existing subData fields — no backend changes.

While the row title in the link list stays email-stripped (default
remark model omits email now), the QR popover label folds it back
in so the rendered QR card identifies the client unambiguously. Tag
content becomes `<rowTitle>-<email>` in both SubPage and
ClientInfoModal — the encoded link itself is unchanged.

SubPage section order is now: info table → usage summary → SUB /
JSON / CLASH endpoints → per-protocol Copy URL rows → apps row, so
the most-glanceable status sits above the fold.
2026-05-27 04:23:28 +02:00
.github chore(frontend): enforce no-explicit-any: error + add typecheck/test to CI 2026-05-26 12:31:01 +02:00
.vscode Feat/multi inbound clients (#4469) 2026-05-19 12:20:24 +02:00
config v3.1.0 2026-05-23 19:53:15 +02:00
database fix(xray): heal shadowsocks per-client method across all start paths 2026-05-27 03:11:51 +02:00
frontend feat(sub): usage summary card + remark-email on QR popover labels 2026-05-27 04:23:28 +02:00
logger add log rotate to 3xui.log file to avoid disk space consumption (#4277) 2026-05-13 17:03:56 +02:00
media donate: nowpayments 2025-09-18 20:14:10 +02:00
sub feat(settings): drop email leg from default remark model 2026-05-27 04:23:09 +02:00
tools/openapigen refactor(backend): retire hysteria2 as a top-level protocol 2026-05-27 00:58:37 +02:00
util Feat/multi inbound clients (#4469) 2026-05-19 12:20:24 +02:00
web feat(settings): drop email leg from default remark model 2026-05-27 04:23:09 +02:00
windows_files Update OpenSSL installer to version 3.6.0 2026-01-05 18:49:30 +01:00
xray refactor(backend): retire hysteria2 as a top-level protocol 2026-05-27 00:58:37 +02:00
.env.example fix: display of outbound traffic (#3604) 2025-12-23 15:43:25 +01:00
.gitignore Frontend rewrite: React + TypeScript with AntD v6 (#4498) 2026-05-23 15:21:45 +02:00
.nvmrc Security hardening: sessions, SSRF, CSP nonce, CSRF logout, trusted proxies (#4275) 2026-05-13 12:52:52 +02:00
CONTRIBUTING.md Frontend rewrite: React + TypeScript with AntD v6 (#4498) 2026-05-23 15:21:45 +02:00
docker-compose.yml Feat/multi inbound clients (#4469) 2026-05-19 12:20:24 +02:00
DockerEntrypoint.sh fix(fail2ban): escape percent signs in 3x-ipl datepattern (#4328) 2026-05-13 01:49:09 +02:00
Dockerfile Feat/multi inbound clients (#4469) 2026-05-19 12:20:24 +02:00
DockerInit.sh Frontend rewrite: React + TypeScript with AntD v6 (#4498) 2026-05-23 15:21:45 +02:00
go.mod feat(backend): gate request bodies with go-playground/validator 2026-05-25 19:17:54 +02:00
go.sum Frontend rewrite: React + TypeScript with AntD v6 (#4498) 2026-05-23 15:21:45 +02:00
install.sh feat(bash): prompt for PostgreSQL (#4472) 2026-05-23 19:52:37 +02:00
LICENSE 3x-ui 2023-02-09 22:48:06 +03:30
main.go Feat/multi inbound clients (#4469) 2026-05-19 12:20:24 +02:00
README.ar_EG.md docs(readme): add Community Tools section (#4114) 2026-05-14 15:54:52 +02:00
README.es_ES.md docs(readme): add Community Tools section (#4114) 2026-05-14 15:54:52 +02:00
README.fa_IR.md docs(readme): add Community Tools section (#4114) 2026-05-14 15:54:52 +02:00
README.md Feat/multi inbound clients (#4469) 2026-05-19 12:20:24 +02:00
README.ru_RU.md docs(readme): add Community Tools section (#4114) 2026-05-14 15:54:52 +02:00
README.zh_CN.md docs(readme): add Community Tools section (#4114) 2026-05-14 15:54:52 +02:00
update.sh feat(bash): prompt for PostgreSQL (#4472) 2026-05-23 19:52:37 +02:00
x-ui.rc fix(alpine): restart_xray uses rc-service; OpenRC reload reads pidfile contents 2026-05-11 09:05:36 +02:00
x-ui.service.arch fix(arch): correct x-ui service path (#4213) 2026-05-10 17:17:33 +02:00
x-ui.service.debian [feat] restart xray-core from cli #3825 2026-02-20 00:03:16 +01:00
x-ui.service.rhel [feat] restart xray-core from cli #3825 2026-02-20 00:03:16 +01:00
x-ui.sh feat(bash): prompt for PostgreSQL (#4472) 2026-05-23 19:52:37 +02:00

English | فارسی | العربية | 中文 | Español | Русский

3x-ui

Release Build GO Version Downloads License Go Reference Go Report Card

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.

Important

This project is only for personal usage, please do not use it for illegal purposes, and please do not use it 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.

Quick Start

bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh)

For full documentation, please visit the project Wiki.

Database Options

3X-UI supports two backends, chosen during the install:

  • SQLite (default) — a single file at /etc/x-ui/x-ui.db. Zero setup, ideal for small/medium deployments.
  • PostgreSQL — recommended for high client counts or multi-node setups. The installer can install PostgreSQL locally for you, or accept a DSN to an existing server.

At runtime the backend is selected via env vars (the installer writes these to /etc/default/x-ui for you):

XUI_DB_TYPE=postgres
XUI_DB_DSN=postgres://xui:password@127.0.0.1:5432/xui?sslmode=disable

Migrating an existing SQLite install to PostgreSQL

x-ui migrate-db --dsn "postgres://xui:password@127.0.0.1:5432/xui?sslmode=disable"
# then set XUI_DB_TYPE and XUI_DB_DSN in /etc/default/x-ui and restart:
systemctl restart x-ui

The source SQLite file is left untouched; remove it manually once you have verified the new backend.

Docker

The default docker compose up -d keeps using SQLite. To run with the bundled PostgreSQL service, uncomment the two XUI_DB_* env lines in docker-compose.yml and start with the profile:

docker compose --profile postgres up -d

A Special Thanks to

Acknowledgment

  • Iran v2ray rules (License: GPL-3.0): Enhanced v2ray/xray and v2ray/xray-clients routing rules with built-in Iranian domains and a focus on security and adblocking.
  • Russia v2ray rules (License: GPL-3.0): This repository contains automatically updated V2Ray routing rules based on data on blocked domains and addresses in Russia.

Community Tools

Tools and integrations built by the community around 3x-ui.

  • terraform-provider-3x-ui (License: MIT): Manage inbounds, clients, panel settings, and Xray configuration as code with Terraform / OpenTofu.

Support project

If this project is helpful to you, you may wish to give it a🌟

Buy Me A Coffee
Crypto donation button by NOWPayments

Stargazers over Time

Stargazers over time