x-ui 项目使用教程

1. 项目的目录结构及介绍

x-ui 项目的目录结构如下：

x-ui/
├── bin/
├── config/
├── database/
├── logger/
├── media/
├── util/
├── v2ui/
├── web/
├── xray/
├── .gitignore
├── Dockerfile
├── LICENSE
├── README.md
├── README_EN.md
├── go.mod
├── go.sum
├── install.sh
├── install_en.sh
├── main.go
├── x-ui.service
├── x-ui.sh
├── x-ui_en.sh

目录介绍

• bin/: 存放编译后的二进制文件。
• config/: 存放项目的配置文件。
• database/: 存放数据库相关的文件。
• logger/: 存放日志相关的文件。
• media/: 存放媒体文件。
• util/: 存放工具类文件。
• v2ui/: 存放 v2ui 相关的文件。
• web/: 存放 Web 界面相关的文件。
• xray/: 存放 xray 相关的文件。
• .gitignore: Git 忽略文件配置。
• Dockerfile: Docker 镜像构建文件。
• LICENSE: 项目许可证。
• README.md: 项目中文介绍文档。
• README_EN.md: 项目英文介绍文档。
• go.mod: Go 模块文件。
• go.sum: Go 模块校验文件。
• install.sh: 安装脚本。
• install_en.sh: 英文安装脚本。
• main.go: 项目主入口文件。
• x-ui.service: 系统服务配置文件。
• x-ui.sh: 启动脚本。
• x-ui_en.sh: 英文启动脚本。

2. 项目的启动文件介绍

主入口文件

main.go 是项目的主入口文件，负责初始化和启动整个应用程序。

启动脚本

x-ui.sh 是项目的启动脚本，可以通过该脚本启动、停止、重启和管理 x-ui 服务。

# 启动 x-ui 服务
./x-ui.sh start

# 停止 x-ui 服务
./x-ui.sh stop

# 重启 x-ui 服务
./x-ui.sh restart

# 查看 x-ui 服务状态
./x-ui.sh status

3. 项目的配置文件介绍

配置文件目录

config/ 目录下存放了项目的配置文件，主要包括以下文件：

• config.json: 主配置文件，包含面板的各项设置。
• database.json: 数据库配置文件，包含数据库连接信息。
• logger.json: 日志配置文件，包含日志级别和输出路径等设置。

主配置文件

config.json 文件示例如下：

{
  "port": 54321,
  "username": "admin",
  "password": "admin",
  "database": {
    "type": "sqlite",
    "host": "localhost",
    "port": 3306,
    "user": "root",
    "password": "root",
    "db_name": "x-ui"
  },
  "log": {
    "level": "info",
    "output": "log/x-ui.log"
  }
}

数据库配置文件

database.json 文件示例如下：

{
  "type": "sqlite",
  "host": "localhost",
  "port": 3306,
  "user": "root",
  "password": "root",
  "db_name": "x-ui"
}

日志配置文件

logger.json 文件示例如下：

{
  "level": "info",
  "output": "log/x-ui.log"
}

通过以上配置文件，可以灵活地调整 x-ui 项目的运行参数和行为。