X-UI installation and usage tutorial, Xray visualization panel that supports multi-protocol and multi-user

Visual panel X-UI, real-time monitoring of server status

The panel is very convenient, not only for visually building SS,, , Trojan and other popular protocols, and you can also see the performance status of the VPS and traffic usage in real time. X-UI developed using GO language has better performance and very low memory usage. Supported protocols: vmess,,trojan,shadowsocks,dokodemo-door,socks,http

X-UI official project:https://github.com/vaxilu/x-ui

Revised X-UI project:https://github.com/FranzKafkaYu/x-ui

X-UI function introduction

  • System status monitoring
  • Supports multi-user and multi-protocol, web page visual operation
  • Supported protocols: vmess, vless, trojan, shadowsocks, dokodemo-door, socks, http
  • Support configuring more transmission configurations
  • Traffic statistics, limit traffic, limit to time
  • Customizable xray configuration template
  • Supports https access panel (brings its own +Certificate)
  • Support one keyand automatic renewal
  • For more advanced configuration items, see the panel for details

Introduction to the revised x-ui

  • System status monitoring
  • Support single-port multi-user, multi-protocol, web page visualization operation
  • Supported protocols: vmess, vless, trojan, shadowsocks, shadowsocks 2022, dokodemo-door, socks, http
  • Supports configuring more transmission configurations: http, tcp, ws, grpc, kcp, quic
  • Traffic statistics, traffic limit, time limit, one-click reset and device monitoring
  • Customizable xray configuration template
  • Support https access panel (bring your own domain name + )
  • Supports one-click certificate application and automatic renewal
  • bot notification and control functions
  • For more advanced configuration items, see the panel

Configuration requirements

Memory

  • 128MB minimal/256MB+ recommend

operating system

The following two installation commands:

1 is the official original version, but it will not be updated in August 2021.

2 For the revision of X-ui, the update speed is worthy of praise, and many new functions have been added, including the latest Reality protocol, telegram group notifications and other functions.

Everyone is free to choose, choose one of the two, and they can be used normally

1. X-UI installation & upgrade

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

2. Revised x-ui installation method

Please make sure your system supports it before installingbashenvironment, and the system network is normal

⚡This command can also be used when upgrading from the original version, and the data will not be lost⚡

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

For English users, use the following command to install the English support version:

bash <(curl -Ls https://raw.githubusercontent.com/FranzKafkaYu/x-ui/master/install_en.sh)

To install the specified version, you can specify the version number in the above command. For example, the specified version is0.3.4.4, the installation command is as follows:

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

Revision x-ui update record

  • 2023.07.18: Randomly generate Reality dest and serverNames, remove Microsoft domain name; refine sniffing configuration
  • 2023.06.10: Automatically reuse panel certificates and domain names when is turned on; add certificate hot reload settings; optimize device restriction functions
  • 2023.04.09: Support Reality; support new telegram bot control commands
  • 2023.03.05: Support user expiration time limit; random user name, password and port generation
  • 2023.02.09: Supports user traffic restriction and statistics within a single port; supports VLESS utls configuration and sharing link export
  • 2022.12.07: Add device concurrency limit; refine tls configuration, support minVersion, maxVersion and cipherSuites selection
  • 2022.11.14: Add xtls-rprx-vision flow control option; automatically update geo and clear logs regularly
  • 2022.10.23: Achieve full English support; add batch export sharing link function; optimize page details and Telegram notification
  • 2022.08.11: Implement Vmess/Vless/Trojan single port multi-user; add CPU usage over limit reminder
  • 2022.07.28: Add acme standalone mode application certificate; add x-ui automatic keep-alive mechanism; optimize compilation options to adapt to more systems
  • 2022.07.24: Add automatic generation of panel root path,Traffic automatic reset function, device IP access change notification function
  • 2022.07.21: Add IP access change reminder, add stop/restart xray function to the Web panel, and optimize some translations
  • 2022.07.11: Add node expiration reminder, traffic warning strategy, add Telegram bot node copy, obtain sharing link, etc.
  • 2022.07.03: Reconstruct the Telegram bot function, command control no longer requires keyboard input; add Trojan underlying transmission configuration
  • 2022.06.19: Add Shadowsocs2022 new Cipher, add node search, one-click clear traffic function
  • 2022.05.14: Add Telegram bot Command control function, support closing/opening/deleting nodes, etc.
  • 2022.04.25: Add login reminder and panel login reminder
  • 2022.04.23: Add more Telegram bot reminder functions
  • 2022.04.16: Added panel setting Telegram bot function
  • 2022.04.12: Optimize Telegram Bot notification reminder
  • 2022.04.06: Optimize the installation/update process, add certificate issuance function, and add Telegram bot robot push function

Effect preview

Manual installation & upgrade

  1. First fromhttps://github.com/vaxilu/x-ui/releasesDownload the latest compressed package, generally selectamd64frame
  2. Then this compressed package to the server/root/directory, and userootuser login server

If your server cpu architecture is notamd64, change the commandamd64Replace with another schema

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 Tutorial and image byChasing66supply

Install docker

curl -fsSL https://get.docker.com | sh

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

Create your own mirror

docker build -t x-ui .

SSL certificate application

This feature and tutorial are provided byFranzKafkaYusupply

Set the function in the script. To use this script to apply for a certificate, the following conditions must be met:

  • know register e-mail
  • Know the Global API Key
  • The domain name has been resolved to the server in question through cloudflare

How to obtain Cloudflare Global API Key: X-UI supports multi-protocol and multi-user Xray panel-1
X-UI supports multi-protocol and multi-user Xray panel-2

To use, you only need to enterdomain nameMail,API KEYThat's it, the display intention is as follows:X-UI supports multi-protocol and multi-user Xray panel-3

Precautions:

  • The script uses API to apply for a certificate
  • Let's Encrypt is used as the CA by default
  • The certificate installation directory is the /root/cert directory
  • The certificates applied for in this script are all pan-domain certificates.

Apply for a domain name certificate using Acme script

Note: Before installing Acme scripts, install socat first

dnf install -y curl socat wget

Once installed, proceed to install the Acme script below.

Install Acme script

curl https://get.acme.sh | sh

X-UI installation tutorial, Xray visualization panel that supports multi-protocol and multi-user-1

If socat is not installed, an error will be reported when installing the script!

Certificate application method for idle port 80

Change the domain name and email address of xxx in the code to resolve the domain name and email address for you.

~/.acme.sh/acme.sh --register-account -m xxx@gmail.com ~/.acme.sh/acme.sh --issue -d xxx.com --standalone

X-UI installation tutorial, Xray visualization panel that supports multi-protocol and multi-user-1

If the picture above is displayed, it means that the has been applied successfully. Next, install the certificate to the specified folder.

Install the certificate to the specified folder

Replace the domain name in the code with the domain name you resolve, and store the domain name certificate in the /root/ directory.

~/.acme.sh/acme.sh --installcert -d xxx.com --key-file /root/private.key --fullchain-file /root/cert.crt

X-UI installation tutorial

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

Wait for the installation, and when the following prompt appears on the command line, the installation is successful!

X-UI supports multi-protocol and multi-user Xray panel-1
Modify panel password
Browser openshttp://server ip address:54321, login panel (both username and password are admin)
X-UI supports multi-protocol and multi-user Xray panel-2
Go to panel settings → user settings, modify username and password
X-UI supports multi-protocol and multi-user Xray panel-3

Configure node

Non-CDN mode

Login to the panel, go to the Inbound list, click on the blue + sign.
X-UI supports multi-protocol multi-user Xray panel-4
Enter remarks, the port is generally left as the default, and the transmission protocol is recommended to choose ws. The flow rate and expiration time can be set, but generally not. Then click add
X-UI supports multi-protocol and multi-user Xray panel-5
Next to the node just created, click Operation→QR Code
X-UI supports multi-protocol multi-user Xray panel-6
Use your mobile phone to scan the QR code on the screen, or click the copy button to export the node just created
X-UI supports multi-protocol and multi-user Xray panel-7

CDN mode

Open CloudFlare's domain name management, add a resolution record to your own VPS, keep Xiaoyunduo open, click Save to save
X-UI supports multi-protocol and multi-user Xray panel-8
Go to Origin Server and click Create Certificate
X-UI supports multi-protocol multi-user Xray panel-9
To modify the certificate expiration time, click Create
X-UI supports multi-protocol and multi-user Xray panel-10
Copy the public key and private key for backup
X-UI supports multi-protocol and multi-user Xray panel-11
Login to the panel, go to the Inbound list, click on the blue + sign.
X-UI supports multi-protocol and multi-user Xray panel-12
Refer to the figure below to set, and then click Add
X-UI supports multi-protocol and multi-user Xray panel-13
Next to the node just created, click Operation→QR Code
X-UI supports multi-protocol and multi-user Xray panel-14
Use your mobile phone to scan the QR code on the screen, or click the copy button to export the node just created
X-UI supports multi-protocol and multi-user Xray panel-15

X-UI FAQ

Why can't I connect to the node?

  1. Please check configuration
  2. Go to the domain name management page of CF, go to the SSL tab, and select the Full option.

X-UI supports multi-protocol multi-user Xray panel-16

uzbox
uzbox

Leave a Reply

Your email address will not be published. Required fields are marked *