X-UI English 项目安装与使用指南

X-UI English 项目安装与使用指南

x-ui-english English Version of X-UI, A Multi-protocol & Multi-user Xray Panel with a Web UI and a TG Bot 项目地址: https://gitcode.com/gh_mirrors/xu/x-ui-english

1. 项目目录结构及介绍

X-UI English 项目的目录结构如下：

x-ui-english/
├── config/
│   └── ...
├── database/
│   └── ...
├── logger/
│   └── ...
├── media/
│   └── ...
├── util/
│   └── ...
├── v2ui/
│   └── ...
├── web/
│   └── ...
├── xray/
│   └── ...
├── Dockerfile
├── LICENSE
├── README-fa.md
├── README.md
├── acme.sh
├── docker-compose.yml
├── go.mod
├── go.sum
├── install.sh
├── main.go
├── x-ui.service
└── x-ui.sh

目录介绍

• config/: 存放项目的配置文件。
• database/: 存放数据库相关文件。
• logger/: 存放日志记录相关文件。
• media/: 存放媒体文件。
• util/: 存放工具类文件。
• v2ui/: 存放与 V2UI 相关的文件。
• web/: 存放 Web 界面相关文件。
• xray/: 存放 Xray 核心文件。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证文件。
• README-fa.md: 波斯语版本的 README 文件。
• README.md: 英文版本的 README 文件。
• acme.sh: SSL 证书申请脚本。
• docker-compose.yml: Docker Compose 配置文件。
• go.mod: Go 模块依赖文件。
• go.sum: Go 模块依赖校验文件。
• install.sh: 安装脚本。
• main.go: 项目主入口文件。
• x-ui.service: 系统服务配置文件。
• x-ui.sh: X-UI 启动脚本。

2. 项目启动文件介绍

主入口文件

• main.go: 这是项目的启动文件，包含了项目的初始化逻辑和主要功能入口。通过运行 go run main.go 可以启动项目。

启动脚本

• x-ui.sh: 这是一个启动脚本，用于启动 X-UI 服务。可以通过运行 ./x-ui.sh 来启动服务。

系统服务配置

• x-ui.service: 这是一个系统服务配置文件，用于将 X-UI 作为系统服务运行。可以通过 systemctl 命令来管理服务，例如 systemctl start x-ui。

3. 项目配置文件介绍

配置文件目录

• config/: 这个目录下存放了项目的各种配置文件，包括数据库配置、日志配置、Web 界面配置等。

主要配置文件

• config.yaml: 这是项目的主要配置文件，包含了数据库连接信息、日志级别、Web 界面设置等。
• xray.json: 这是 Xray 核心的配置文件，定义了 Xray 的各种协议和传输配置。

其他配置文件

• acme.sh: 这是一个用于申请 SSL 证书的脚本，配置了证书申请的相关参数。
• docker-compose.yml: 这是 Docker Compose 的配置文件，定义了 Docker 容器的启动参数和依赖关系。

通过以上介绍，您可以更好地理解和使用 X-UI English 项目。

x-ui-english English Version of X-UI, A Multi-protocol & Multi-user Xray Panel with a Web UI and a TG Bot 项目地址: https://gitcode.com/gh_mirrors/xu/x-ui-english