Skip to content

English Version of X-UI, A Multi-protocol & Multi-user Xray Panel with a Web UI

License

Notifications You must be signed in to change notification settings

essoojay/x-ui-english

 
 

Repository files navigation

X-UI ENGLISH VERSION

The Translated-to-English Version of Yu FranzKafka's x-ui, forked from vaxilu's awesome repo which is a Multi-protocol Multi-user Xray Panel

Features

  • Everything is in English (Serverside setup + Serverside UI + Web UI)
  • 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

Preview

Single Command Install & upgrade

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

Manual install & upgrade

  1. First update your system
  2. Then download the latest compressed package from https://github.com/NidukaAkalanka/x-ui-english/releases/latest, generally choose amd64 architecture
  3. Upload the compressed package to the /root/ directory of the server, and use the root user to log in to the server and run following commands

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

cd
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:

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

How to get the Cloudflare Global API Key:

  1. Visit the link https://dash.cloudflare.com/profile/api-tokens
  2. Click on View Global API Key (See the screenshot below)
  3. You may have to re-authenticate your account. After that, the API Key will be shown (See the screenshot below)

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

Suggested OSs

  • 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

Issues Fixed on latest update

  • GLIBV 2.28 Not Found -- Fixed
  • Workflow error on TG Bot -- Fixed (TG Bot feature temporarily removed)

About

English Version of X-UI, A Multi-protocol & Multi-user Xray Panel with a Web UI

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 88.1%
  • HTML 5.3%
  • Go 4.4%
  • Shell 1.9%
  • CSS 0.3%
  • Dockerfile 0.0%