Skip to content

Latest commit

 

History

History
120 lines (86 loc) · 3.76 KB

README.md

File metadata and controls

120 lines (86 loc) · 3.76 KB
Raw

x-ui

Multi-protocol, multi-user xray panel support

中文文档请点击这里进行查看

Features

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

Installation & Upgrade

bash <(wget -qO- https://raw.githubusercontent.com/sing-web/x-ui/main/install.sh)

Manual installation & upgrade

  1. First download the latest tarball from the project, usually choose the amd64 architecture
  2. Then upload the tarball to the /root/ directory on the server and login to the server with the root user

If your server cpu architecture is not amd64, replace amd64 in the command with another architecture

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

Installing with docker

This docker tutorial and docker image is provided by Chasing66

  1. Installing docker
curl -fsSL https://get.docker.com | sh
  1. install 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 \
    misakablog/x-ui:latest

Build your own image

docker build -t x-ui .

TG bot usage

This feature and tutorial is provided by FranzKafkaYu

X-UI supports daily traffic notification and panel login reminder via Tg bot. The specific application tutorial can be found in blog link Instructions:Set the bot-related parameters in the background of the panel, including

  • Tg Bot Token
  • Tg Bot ChatId
  • Tg Bot cycle running time, using crontab syntax

Reference syntax:

  • 30 * * * * * * //notify on the 30ths of every minute
  • @hourly // hourly notification
  • @daily //daily notification (at 00:00 am sharp)
  • @every 8h //notify every 8 hours

TG notification content:

  • Node traffic usage
  • Panel login reminder
  • Node expiration reminder
  • Traffic alert reminder

More features are being planned...

Recommended Systems

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

Credits

Sponsorship

afdian (for China mainland): https://afdian.net/a/Misaka-blog

afdian-MisakaNo の 小破站

Disclaimer

  • This program is for learning and understanding only, not for profit, please delete within 24 hours after downloading, not for any commercial use, text, data and images are copyrighted, if reproduced, please indicate the source.
  • Use of this program is subject to the deployment disclaimer. Use of this program is subject to the laws and regulations of the country where the server is deployed and the country where the user is located, and the author of the program is not responsible for any misconduct of the user.