纯IPV6网络无法访问api.github.com，可以配置dns64服务临时增加IPV4站点访问能力。

命令：

sudo tee /etc/resolv.conf <<EOF
nameserver 2a00:1098:2b::1
nameserver 2a00:1098:2c::1
nameserver 2a01:4f9:c010:3f02::1
nameserver 2a01:4f8:c2c:123f::1
EOF

1. 国内安装docker

bash <(curl -sSL https://gitee.com/SuperManito/LinuxMirrors/raw/main/DockerInstallation.sh)

2. 运行3x-ui镜像

docker run -itd \
   -e XRAY_VMESS_AEAD_FORCED=false \
   -v $PWD/db/:/etc/x-ui/ \
   -v $PWD/cert/:/root/cert/ \
   --network=host \
   --restart=always \
   --name 3x-ui \
   ghcr.nju.edu.cn/admin8800/3x-ui

然后使用默认信息访问面板

查看面板信息

/app/x-ui setting -show true

修改用户名和密码

/app/x-ui setting -username 用户名 -password 密码

修改面板路径

/app/x-ui setting -webBasePath "admin"

修改面板端口

/app/x-ui setting -port 端口

清除安全令牌

/app/x-ui setting -remove_secret

重置面板所有设置为默认值（用户名和密码除外）

/app/x-ui setting -reset

重启容器

docker restart 3x-ui

使用ACME管理SSL证书：

1. 确保您的域名正确解析到服务器。

2. 在终端中运行 x-ui 命令，然后选择 SSL证书管理。

3. 您将看到以下选项：

   • Get SSL: 获取SSL证书。
   • Revoke: 吊销现有的SSL证书。
   • Force Renew: 强制更新SSL证书。
   • Show Existing Domains: 显示服务器上所有可用的域证书。
   • Set Certificate Paths for the Panel: 指定用于面板的域证书。

安装并使用Certbot：

apt-get install certbot -y
certbot certonly --standalone --agree-tos --register-unsafely-without-email -d yourdomain.com
certbot renew --dry-run

管理脚本内置了Cloudflare的SSL证书申请。要使用此脚本申请证书，您需要以下信息：

• Cloudflare注册的电子邮件
• Cloudflare全局API密钥
• 域名必须通过Cloudflare解析到当前服务器

如何获取Cloudflare全局API密钥：

1. 在终端中运行 x-ui 命令，然后选择 Cloudflare SSL证书。
2. 访问链接：Cloudflare API Tokens。
3. 点击“查看全局API密钥”（参见下图）：
4. 您可能需要重新验证您的账户。之后将显示API密钥（参见下图）：

使用时，只需输入您的 域名、电子邮件 和 API密钥。如下图所示：

下载压缩包(下载地址) 到本地，下载对应系统架构的，以常见的amd64为例：

将压缩包上传到服务器的root目录

然后依次执行以下命令，一行一个命令

cd /root
rm x-ui/ /usr/local/x-ui/ /usr/bin/x-ui -rf
tar zxvf x-ui-linux-amd64.tar.gz
chmod +x x-ui/x-ui x-ui/bin/xray-linux-* x-ui/x-ui.sh
cp x-ui/x-ui.sh /usr/bin/x-ui
cp -f x-ui/x-ui.service /etc/systemd/system/
mv x-ui/ /usr/local/
systemctl daemon-reload
systemctl enable x-ui
systemctl restart x-ui
x-ui

然后使用默认信息访问面板

1. 安装Docker：

   bash <(curl -sSL https://get.docker.com)

2. 运行服务：

   docker run -itd \
      -e XRAY_VMESS_AEAD_FORCED=false \
      -v $PWD/db/:/etc/x-ui/ \
      -v $PWD/cert/:/root/cert/ \
      --network=host \
      --restart=always \
      --name 3x-ui \
      ghcr.io/admin8800/3x-ui

然后使用默认信息访问面板

从Docker中删除3x-ui

 docker stop 3x-ui
 docker rm 3x-ui

查看面板信息

/app/x-ui setting -show true

修改用户名和密码

/app/x-ui setting -username 用户名 -password 密码

修改面板路径

/app/x-ui setting -webBasePath "admin"

修改面板端口

/app/x-ui setting -port 端口

清除安全令牌

/app/x-ui setting -remove_secret

重置面板所有设置为默认值（用户名和密码除外）

/app/x-ui setting -reset

重启容器

docker restart 3x-ui

1. 下载windows系统压缩包
2. 解压文件
3. 双击运行x-ui.exe程序
4. 使用默认信息登录面板
5. 如果需要后台运行请谷歌搜索Windows任务调度器使用教程

location / {
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header Host $http_host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header Range $http_range;
    proxy_set_header If-Range $http_if_range; 
    proxy_redirect off;
    proxy_pass http://127.0.0.1:2053;
}

• 确保 /sub 面板设置中的"面板url根路径"一致
• 面板设置中的 url 需要以 / 结尾

location /sub {
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header Host $http_host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header Range $http_range;
    proxy_set_header If-Range $http_if_range; 
    proxy_redirect off;
    proxy_pass http://127.0.0.1:2053;
}

我们的平台提供与各种架构和设备的兼容性，确保在各种计算环境中的灵活性。以下是我们支持的关键架构：

• amd64: 这种流行的架构是个人计算机和服务器的标准，可以无缝地适应大多数现代操作系统。

• x86 / i386: 这种架构在台式机和笔记本电脑中被广泛采用，得到了众多操作系统和应用程序的广泛支持，包括但不限于 Windows、macOS 和 Linux 系统。

• armv8 / arm64 / aarch64: 这种架构专为智能手机和平板电脑等当代移动和嵌入式设备量身定制，以 Raspberry Pi 4、Raspberry Pi 3、Raspberry Pi Zero 2/Zero 2 W、Orange Pi 3 LTS 等设备为例。

• armv7 / arm / arm32: 作为较旧的移动和嵌入式设备的架构，它仍然广泛用于Orange Pi Zero LTS、Orange Pi PC Plus、Raspberry Pi 2等设备。

• armv6 / arm / arm32: 这种架构面向非常老旧的嵌入式设备，虽然不太普遍，但仍在使用中。Raspberry Pi 1、Raspberry Pi Zero/Zero W 等设备都依赖于这种架构。

• armv5 / arm / arm32: 它是一种主要与早期嵌入式系统相关的旧架构，目前不太常见，但仍可能出现在早期 Raspberry Pi 版本和一些旧智能手机等传统设备中。

如果您选择不修改这些设置，它们将随机生成（Docker部署不会生成路径）。

Docker 的默认设置：

• 用户名： admin
• 密码： admin
• 端口： 2053

您可以直接在面板中方便地进行数据库备份和还原。

• 数据库路径:
  • /etc/x-ui/x-ui.db

1. 重置 Web 基础路径:

   • 打开终端。
   • 运行 x-ui 命令。
   • 选择 重置 Web 基础路径 选项。

2. 生成或自定义路径:

   • 路径将会随机生成，或者您可以输入自定义路径。

3. 查看当前设置:

   • 要查看当前设置，请在终端中使用 x-ui settings 命令，或在 x-ui 面板中点击 查看当前设置。

• 为了提高安全性，建议在URL结构中使用一个长的随机词。

示例：

• http://ip:port/*webbasepath*/panel
• http://domain:port/*webbasepath*/panel

对于 v2.1.0 及之后的版本：

WARP 已内置，无需额外安装。只需在面板中开启相关配置即可。

注意: 当使用 IP 隧道时，IP 限制将无法正常工作。

要启用 IP 限制功能，您需要安装 fail2ban 及其所需的文件，步骤如下：

1. 在终端中运行 x-ui 命令，然后选择 IP 限制管理。

2. 您将看到以下选项：

   • 更改封禁时长: 调整封禁时长。
   • 解除所有封禁: 解除当前的所有封禁。
   • 查看日志: 查看日志。
   • Fail2ban 状态: 检查 fail2ban 的状态。
   • 重启 Fail2ban: 重启 fail2ban 服务。
   • 卸载 Fail2ban: 卸载带有配置的 Fail2ban。

3. 在面板中通过设置 Xray 配置/log/访问日志 为 ./access.log 添加访问日志路径，然后保存并重启 Xray。

Web 面板通过 Telegram Bot 支持每日流量、面板登录、数据库备份、系统状态、客户端信息等通知和功能。要使用机器人，您需要在面板中设置机器人相关参数，包括：

• 电报令牌
• 管理员聊天 ID
• 通知时间（cron 语法）
• 到期日期通知
• 流量上限通知
• 数据库备份
• CPU 负载通知

参考：

• 30 \* \* \* \* \* - 在每个点的 30 秒处通知
• 0 \*/10 \* \* \* \* - 每 10 分钟的第一秒通知
• @hourly - 每小时通知
• @daily - 每天通知 (00:00)
• @weekly - 每周通知
• @every 8h - 每8小时通知

• 定期报告
• 登录通知
• CPU 阈值通知
• 提前报告的过期时间和流量阈值
• 如果将客户的电报用户名添加到用户的配置中，则支持客户端报告菜单
• 支持使用UUID（VMESS/VLESS）或密码（TROJAN）搜索报文流量报告 - 匿名
• 基于菜单的机器人
• 通过电子邮件搜索客户端（仅限管理员）
• 检查所有入库
• 检查服务器状态
• 检查耗尽的用户
• 根据请求和定期报告接收备份
• 多语言机器人

• 与 Botfather 对话：

• 使用 /newbot 创建新机器人：你需要提供机器人名称以及用户名，注意名称中末尾要包含“bot”

• 启动您刚刚创建的机器人。可以在此处找到机器人的链接。

• 输入您的面板并配置 Telegram 机器人设置，如下所示：

在输入字段编号 3 中输入机器人令牌。 在输入字段编号 4 中输入用户 ID。具有此 id 的 Telegram 帐户将是机器人管理员。 （您可以输入多个，只需将它们用“ ，”分开即可）

• 如何获取TG ID? 使用 bot， 启动机器人，它会给你 Telegram 用户 ID。

• API 文档
• /login 使用 POST 用户名称 & 密码： {username: '', password: ''} 登录
• /panel/api/inbounds 以下操作的基础：

*- clientId 项应该使用下列数据

• client.id VMESS and VLESS

• client.password TROJAN

• client.email Shadowsocks

• 

例子：

XUI_BIN_FOLDER="bin" XUI_DB_FOLDER="/etc/x-ui" go build main.go