1. 项目定位与用途
3x-ui 是一个开源的、基于 Web 的 Xray-core 服务器管理控制台。作为 X-UI 项目的增强分支，它专注于提供稳定、功能丰富的图形化界面，用于配置和管理多种代理协议。其核心用途是让个人用户能够通过浏览器轻松创建入站连接、管理客户端用户、设置流量和 IP 限制、定义过期时间，并实时监控服务器状态，从而降低 Xray 服务器的运维门槛。
项目档案应用项目
3x-ui 开源 Xray 管理面板安装使用教程 - 多协议多用户代理服务控制台
3x-ui 是基于 Web 的 Xray-core 管理面板，适用于个人搭建代理/VPN 服务。支持多种协议、多用户管理、流量/IP 限制及过期设置。本文详细介绍其项目定位、安装步骤、使用方式及技术架构，帮助读者快速部署和使用这一开源工具。
AI 总结
3x-ui 是一款开源的基于 Web 的 Xray-core 服务器管理面板，支持 Vmess、Vless、Trojan 等多种协议，提供多用户、流量限制和过期管理功能，简化代理服务的配置与监控。
中文项目介绍
3x-ui 是专为 Xray-core 设计的先进 Web 管理面板，旨在解决手动命令行配置的复杂性。
它提供直观的图形界面，用于配置和监控多种 VPN/代理协议，包括 Vmess、Vless、Trojan、Shadowsocks、Wireguard 等。
主要解决个人用户管理多用户代理服务时的配置繁琐、权限控制、流量统计和过期管理问题。
适用场景包括个人搭建代理/VPN 服务、为多个用户分配不同协议与配额、实时监控服务器状态与连接信息。
技术特征：基于 Go 语言与 Gin 框架开发，使用 GORM 和 SQLite 进行数据持久化，支持热重启与 Xray 核心重载，集成 Telegram 机器人用于备份和通知，并提供 Docker 部署支持。
详细信息与使用说明
2. 解决的问题
传统 Xray 配置依赖手动编辑 JSON 文件和使用命令行工具，过程复杂且易错。3x-ui 通过统一的 Web 面板将所有这些操作可视化，解决了配置繁琐、多用户权限管理困难、流量统计不直观、过期处理手动化等问题。同时，它内置订阅服务与 Telegram 机器人集成，进一步自动化了备份和通知流程，提升了个人运维效率。
3. 适用场景
本项目主要适用于个人或小规模代理服务搭建者：需要为自身或少数朋友分配不同协议（如 Vmess、Vless、Trojan）的代理账号；希望按用户设置流量配额、限制并发 IP 或设定服务有效期；希望通过 Web 界面实时查看连接数、流量使用情况；以及需要生成订阅链接或通过 Telegram 接收服务器通知的场景。注意，项目声明仅限个人使用，不建议用于生产环境或非法用途。
4. 安装方式
仓库提供两种主要安装方式。其一是一键脚本安装：在终端执行 bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh)，脚本会自动检测操作系统与 CPU 架构，安装必要依赖（如 curl、tar、socat 等），检查端口占用，并部署 3x-ui 服务。其二是 Docker 部署：项目根目录包含 Dockerfile 和 docker-compose.yml 文件，用户可按照 Docker 标准流程构建和运行容器。环境变量配置参考 .env.example 文件。
5. 使用方式
安装完成后，通过浏览器访问面板 Web 界面（默认端口 54321）进行登录。在面板中，用户可以添加和管理 Inbound（入站连接），选择协议类型并配置端口、网络等；创建 Client（客户端）并分配流量、过期时间、IP 限制等；修改 Xray 核心设置与系统设置；生成和订阅配置（sub）；以及配置 Telegram 机器人以发送备份和接收通知。所有操作均通过直观的 Vue + Ant Design 前端完成，后端提供 RESTful API 和 WebSocket 支持。
6. 补充说明与实现特点
从代码结构可见，项目采用模块化设计：main.go 作为入口初始化数据库、Web 服务器和订阅服务，并通过 Unix 信号实现热重启与 Xray 重载；web 目录基于 Gin 框架实现 API 路由和会话管理，前端资源内置；database 层使用 GORM 操作 SQLite，定义用户、入站等模型；sub 包独立处理订阅生成与编码；util 提供加密、系统监控（psutil）、LDAP 等工具。此外，集成 Telegram 机器人服务，并在重启时协调停止以避免端口冲突。项目遵循 GPL V3 许可证，持续更新以支持最新 Xray 核心。
思维导图
3x-ui
Web 界面与 API
Gin HTTP 服务器
Vue + Ant Design 前端
RESTful API 控制器
WebSocket 实时通信
数据持久层
GORM ORM
SQLite 数据库
用户与入站模型
流量与订阅记录
订阅服务
订阅链接生成
多协议编码
JSON 服务接口
配置与工具
环境配置加载
加密工具
系统监控 (psutil)
LDAP 集成
Telegram 机器人
备份发送
通知管理
机器人协调停止
部署与安装
install.sh 脚本
Dockerfile / Compose
多系统架构支持
常见问题
3x-ui 的主要功能是什么？
3x-ui 提供 Web 界面来管理 Xray-core 服务器，支持多协议（Vmess、Vless、Trojan 等）配置、多用户管理、流量和 IP 限制、过期时间设置、实时监控以及订阅生成和 Telegram 机器人集成。
如何安装 3x-ui？
可以通过一键脚本安装：运行 bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh)，脚本支持多种 Linux 发行版和 CPU 架构；也可以使用 Docker 部署，项目根目录提供 Dockerfile 和 docker-compose.yml 文件。
3x-ui 支持哪些代理协议？
根据项目描述，3x-ui 支持 Vmess、Vless、Trojan、Shadowsocks、Wireguard、Tunnel、Mixed、HTTP、Tun 等多种协议，具体可用协议以面板内选项为准。
3x-ui 可以用于生产环境吗？
不可以。项目 README 明确声明该项目仅限个人使用，不得用于非法目的，也不建议在生产环境中使用。
3x-ui 使用什么数据库？
3x-ui 使用 SQLite 数据库，通过 GORM ORM 框架进行数据持久化，数据库文件默认存储在配置指定的文件夹中。