Skip to content
forked from vaxilu/x-ui

Multi-protocol multi-user xray panel support

License

Notifications You must be signed in to change notification settings

hermangroup/x-ui

 
 

Repository files navigation

x-ui

Xray panel with multi-protocol multi-user support [English Translated]

Features

  • System status monitoring
  • Support multi-user multi-protocol, web page visualization operation
  • Supported protocols: vmess, vless, trojan, shadowsocks, dokodemo-door, socks, http
  • Support to configure more transmission configurations
  • Traffic statistics, limit traffic, limit expiration time
  • Customizable xray configuration templates
  • Support https access panel (bring your own 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

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

Manual install & 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

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

Install using docker

This docker tutorial and docker image are provided by Chasing66

  1. Install 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 \
    enwaiax/x-ui:latest

Build your own image

docker build -t x-ui .

##SSL certificate application

This function and tutorial are provided by FranzKafkaYu

The script has a built-in SSL certificate application function. To use this script to apply for a certificate, the following conditions must be met:

  • Know the Cloudflare registered email address
  • Know the Cloudflare Global API Key
  • The domain name has been resolved to the current server through cloudflare

How to get the Cloudflare Global API Key:

When using, just enter domain name, email, API KEY, the diagram is as follows:

Precautions:

  • The script uses DNS API for certificate request
  • Use Let'sEncrypt as the CA party by default
  • The certificate installation directory is the /root/cert directory
  • The certificates applied for by this script are all generic domain name certificates

##Tg robot use (under development, temporarily unavailable)

This function and tutorial are provided by FranzKafkaYu

X-UI supports daily traffic notification, panel login reminder and other functions through Tg robot. To use Tg robot, you need to apply by yourself For specific application tutorials, please refer to blog link Instructions for use: Set robot-related parameters in the background of the panel, including

  • Tg Robot Token
  • Tg Robot ChatId
  • Tg robot cycle runtime, in crontab syntax

Reference syntax:

  • 30 * * * * * //Notify at the 30s of each point
  • @hourly // hourly notifications
  • @daily // Daily notification (00:00 AM)
  • @every 8h // Notification every 8 hours

TG notification content:

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

More features are planned...

suggestion system

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

common problem

Migrating from v2-ui

First install the latest version of x-ui on the server where v2-ui is installed, and then use the following command to migrate, which will migrate all inbound account data of the local v2-ui to x-ui, panel settings and username and password' will not migrate

After the migration is successful, please close v2-ui and restart x-ui, otherwise the inbound of v2-ui will cause a port conflict with the inbound of x-ui

x-ui v2-ui

issue closed

All kinds of small white problems see high blood pressure

Stargazers over time

Stargazers over time

About

Multi-protocol multi-user xray panel support

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

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