x-ui README

The project's README from github.com/vaxilu/x-ui. As one markdown file: README.md.

x-ui

支持多协议多用户的 xray 面板

功能介绍

安装&升级

bash <(curl -Ls https://raw.githubusercontent.com/vaxilu/x-ui/master/install.sh)

手动安装&升级

  1. 首先从 https://github.com/vaxilu/x-ui/releases 下载最新的压缩包，一般选择 amd64架构
  2. 然后将这个压缩包上传到服务器的 /root/目录下，并使用 root用户登录服务器

如果你的服务器 cpu 架构不是 amd64，自行将命令中的 amd64替换为其他架构

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

使用docker安装

此 docker 教程与 docker 镜像由Chasing66提供

  1. 安装docker
curl -fsSL https://get.docker.com | sh
  1. 安装x-ui
mkdir x-ui && cd x-ui
docker run -itd --network=host \
    -v $PWD/db/:/etc/x-ui/ \
    -v $PWD/cert/:/root/cert/ \
    --name x-ui --restart=unless-stopped \
    enwaiax/x-ui:latest

Build 自己的镜像

docker build -t x-ui .

SSL证书申请

此功能与教程由FranzKafkaYu提供

脚本内置SSL证书申请功能，使用该脚本申请证书，需满足以下条件:

获取Cloudflare Global API Key的方法:

使用时只需输入 域名, 邮箱, API KEY即可，示意图如下：

注意事项:

Tg机器人使用（开发中，暂不可使用）

此功能与教程由FranzKafkaYu提供

X-UI支持通过Tg机器人实现每日流量通知，面板登录提醒等功能，使用Tg机器人，需要自行申请 具体申请教程可以参考博客链接 使用说明:在面板后台设置机器人相关参数，具体包括

参考语法：

TG通知内容：

更多功能规划中...

建议系统

常见问题

从 v2-ui 迁移

首先在安装了 v2-ui 的服务器上安装最新版 x-ui，然后使用以下命令进行迁移，将迁移本机 v2-ui 的 所有 inbound 账号数据至 x-ui，面板设置和用户名密码不会迁移

迁移成功后请 关闭 v2-ui并且 重启 x-ui，否则 v2-ui 的 inbound 会与 x-ui 的 inbound 会产生 端口冲突

x-ui v2-ui

issue 关闭

各种小白问题看得血压很高

Stargazers over time

Stargazers over time

x-ui (vaxilu/x-ui)

Searching Database…

19.1K ·GitHub
X-ui
这是干什么用的？x-ui 是一个自托管的网页面板，用来管理 Xray 代理服务器：支持多用户、多协议的入站配置（vmess、vless、trojan、shadowsocks、dokodemo-door、socks、http），都可以通过浏览器来管理。
所以它装在我的服务器上，我通过浏览器来管理？没错——它运行在你自己的服务器上，而不是客户端设备上：后端用 Go 编写，网页界面用 JavaScript 编写，通过浏览器访问；你的设备则连接到它创建的 Xray 入站。
怎么把它装到我的服务器上？下载最新的发行版压缩包（一般服务器用 amd64 版），上传到 /root/ 并以 root 身份安装。也可以使用 Chasing66 提供的社区 Docker 镜像和安装说明。
我需要什么样的服务器？README 中列出的受支持 Linux 发行版都可以：CentOS 7+、Ubuntu 16+ 或 Debian 8+，并且要有 root 权限。如果想通过 HTTPS 访问面板，还需要有自己的域名和 SSL 证书。
它有什么功能还没做完？Telegram 机器人标注为开发中，目前还不能用；GitHub 的 issue 已经关闭，遇到问题只能自己解决。从 v2-ui 迁移时只迁移入站账号数据——面板设置和密码不会迁移。
我能控制每个用户用多少流量吗？可以——面板会统计每个用户的流量，可以为账号设置流量上限和到期时间。它还能显示系统整体状态，高级用法还可以自定义 xray 配置模板。
一键申请 SSL 证书是怎么工作的？内置脚本通过 Cloudflare DNS API 申请 Let's Encrypt 通配符证书：你需要提供 Cloudflare 邮箱和 Global API Key，域名必须已经通过 Cloudflare 解析，证书会保存到 /root/cert 并自动续期。
我在用 v2-ui，迁移过去麻烦吗？在同一台服务器上安装 x-ui 并执行迁移即可：所有入站账号数据都会迁移过来，但面板设置和用户名/密码不会保留。之后要停掉 v2-ui 并重启 x-ui，否则两者会抢占端口。
What are similar projects?nyx, v2ray-agent, vpn-configs-for-russia, 3X-UI_KIT, CFNext, clash, edgetunnel, V2rayU
Which topics is it in?xray-core, letsencrypt, xray, trojan, v2ray, shadowsocks, admin-dashboard, webui, censorship-circumvention, cloudflare, proxy, monitoring
Creator
vaxilu
Size
15.6 MB
Stars
19.1K
Updated
CommitApr 28Release0.3.2Aug 25
Age
5y
Commits · 90 Days