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
What is this?x-ui is a self-hosted web panel for managing an Xray proxy server: multi-user, multi-protocol inbounds (vmess, vless, trojan, shadowsocks, dokodemo-door, socks, http) administered from a browser.
So it lives on my server and I manage it from a browser?Right — it runs on your own server, not on client devices: a Go backend with a JavaScript web UI you reach through a browser, while your devices connect to the Xray inbounds it creates.
How do I get it onto my server?Download the latest release archive (amd64 on typical servers), upload it to /root/ and install as root. Alternatively use the community Docker image and instructions provided by Chasing66.
What kind of server do I need for this?Any Linux distribution the README lists as supported: CentOS 7+, Ubuntu 16+ or Debian 8+, with root access. For HTTPS access to the panel you also want your own domain plus an SSL certificate.
Is anything in it still half-finished?The Telegram bot is marked in development and not usable yet, and GitHub issues are closed, so support is DIY. Migration from v2-ui carries inbound accounts only — not panel settings or passwords.
Can I control how much traffic each user burns?Yes — the panel tracks per-user traffic and lets you cap traffic and set expiry dates for accounts. It also shows overall system status, and you can plug in a custom xray config template for advanced setups.
How does the one-click SSL certificate work?A built-in script requests wildcard Let's Encrypt certificates through the Cloudflare DNS API: you supply your Cloudflare email and Global API Key, the domain must already resolve via Cloudflare, and certs land in /root/cert with auto-renewal.
I'm on v2-ui — how painful is switching?Install x-ui on the same server and run the migration: it moves all inbound account data, but panel settings and the username/password stay behind. Afterwards stop v2-ui and restart x-ui, or the two will clash on ports.
Creator
vaxilu
Size
15.6 MB
Stars
19.1K
Age
5y
Commits · 90 Days