3x-ui/README.md

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

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/Sora39831/3x-ui/master/install.sh)

For full documentation, please visit the project Wiki.

Building from source

Generate fingerprinted frontend assets before compiling:

go run ./cmd/genassets
go build -ldflags "-w -s" -o build/x-ui main.go

Production builds embed files from web/public/assets and web/public/assets-manifest.json.

Multi-Node Shared Control

• use MariaDB as the shared control database
• keep one master node for shared-account writes
• configure other nodes as worker
• workers rebuild local Xray config from synchronized snapshots
• traffic is flushed back as deltas, not absolute totals

A Special Thanks to

• alireza0

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.

Support project

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

Stargazers over Time