Skip to content

imantaba/x-ui

 
 

Repository files navigation

x-ui

xray panel that supports multi-protocol and multi-user

Features

  • System status monitoring
  • Support multi-user and multi-protocol, web page visualization operation
  • Supported protocols: vmess, vless, trojan, shadowsocks, dokodemo-door, socks, http
  • Support to configure more transport configurations
  • Traffic statistics, limit traffic, limit expiration time
  • Customizable xray configuration templates
  • Support https access panel (self-provided domain name + ssl certificate)
  • Support one-click SSL certificate application and automatic renewal
  • For more advanced configuration items, see the panel for details

Install & Upgrade

installation

Set your proxy url and email in the 'run-x-ui.sh' script , make it executeable and run it.

Note: run it as root user

sudo su
wget https://raw.githubusercontent.com/imantaba/x-ui/main/run-x-ui.sh
vim run-x-ui.sh
chmod +x run-x-ui.sh
./run-x-ui.sh

Manual installation & upgrade

  1. First download the latest compressed package from https://github.com/vaxilu/x-ui/releases, generally choose amd64 architecture
  2. Then upload the compressed package to the /root/ directory of the server, and use the root user to log in to the server
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 注册邮箱
  • 知晓Cloudflare Global API Key
  • 域名已通过cloudflare进行解析到当前服务器

获取Cloudflare Global API Key的方法:

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

注意事项:

  • 该脚本使用DNS API进行证书申请
  • 默认使用Let'sEncrypt作为CA方
  • 证书安装目录为/root/cert目录
  • 本脚本申请证书均为泛域名证书

Tg机器人使用(开发中,暂不可使用)

此功能与教程由FranzKafkaYu提供

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

  • Tg机器人Token
  • Tg机器人ChatId
  • Tg机器人周期运行时间,采用crontab语法

参考语法:

  • 30 * * * * * //每一分的第30s进行通知
  • @hourly //每小时通知
  • @daily //每天通知(凌晨零点整)
  • @every 8h //每8小时通知

TG通知内容:

  • 节点流量使用
  • 面板登录提醒
  • 节点到期提醒
  • 流量预警提醒

更多功能规划中...

建议系统

  • CentOS 7+
  • Ubuntu 16+
  • Debian 8+

常见问题

从 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

About

x-ui en

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 87.9%
  • HTML 5.2%
  • Go 5.1%
  • Shell 1.5%
  • CSS 0.3%
  • Dockerfile 0.0%