top of page
Search

Download X-UI: A Web-Based Xray Management Tool

  • cherrylweiner00553
  • Aug 1, 2023
  • 12 min read



How to Download X-UI: A Multi-Protocol and Multi-User Xray Panel with a Web UI




Xray is a powerful network proxy tool that supports multiple protocols such as VMess, VLESS, Trojan, Shadowsocks, Socks, HTTP, etc. It can help you bypass network censorship, access geo-restricted content, and enhance your online privacy and security. However, managing xray servers and users can be challenging, especially if you have multiple servers and protocols to deal with.


That's where x-ui comes in handy. X-ui is a web-based graphical user interface (GUI) for xray that supports multi-protocol and multi-user management. With x-ui, you can easily create, modify, delete, and monitor xray servers and users on your web browser. You can also customize xray configuration templates, apply SSL certificates, enable Telegram bot notifications, and more.




download x-ui



In this article, we will show you how to download and install x-ui on your Linux server, how to apply SSL certificates for secure access, how to use and configure the web UI, and how to migrate from v2-ui if you are using it. By the end of this article, you will be able to manage your xray servers and users with ease using x-ui.


Prerequisites




Before you download and install x-ui, you need to have the following:



  • A server running Linux with root access. You can use any Linux distribution that supports systemd, such as CentOS, Ubuntu, Debian, etc.



  • A domain name and SSL certificate (optional). If you want to access the web UI over HTTPS, you need to have a domain name that points to your server's IP address and a valid SSL certificate for that domain name. You can use your own domain name and SSL certificate, or you can apply for a free one using the built-in functions of x-ui.



Installation Methods




There are three ways to download and install x-ui on your Linux server: using a single command script, manual installation or upgrade, or using docker. We will explain each method in detail below.


How to download x-ui and install it on Linux


Download x-ui for Windows 10 and configure it easily


Download x-ui latest release from GitHub


Download x-ui docker image and run it on your server


Download x-ui English version with Telegram bot support


Download x-ui and migrate from v2-ui with one command


Download x-ui and apply SSL certificate for free


Download x-ui and monitor your system status


Download x-ui and manage multiple users and protocols


Download x-ui and set up traffic limit and expiration date


Download x-ui and customize your xray configuration template


Download x-ui and enable https access to the panel


Download x-ui and use vmess, vless, trojan, shadowsocks, dokodemo-door, socks, http protocols


Download x-ui and get daily traffic notification via Telegram bot


Download x-ui and get panel login reminder via Telegram bot


Download x-ui and get server SSH login reminder via Telegram bot


Download x-ui and get inbounds expiration alert via Telegram bot


Download x-ui and get traffic warning reminder via Telegram bot


Download x-ui and get daily summary at a pre-defined time via Telegram bot


Download x-ui and use fallback and flow settings for trojan protocol


Download x-ui and fix vless link issue


Download x-ui and fix fallback bug


Download x-ui and optimize UI interface


Download x-ui and improve website loading speed


Download x-ui and lower CPU usage for getting system connections


Download x-ui and fix web panel restart function issue


Download x-ui and fix traffic exceed account disable issue


Download x-ui and fix QR code link not containing address issue


Download x-ui and fix listening IP not empty causing xray not to start issue


Download x-ui and fix old iOS system white screen issue


Download x-ui and fix v2ray restart after panel restart issue


Why download x-ui instead of v2-ui for your server


Where to download x-ui source code and how to build it yourself


How to download x-ui updates and upgrade it automatically


How to download x-ui backup file and restore it on another server


How to download x-ui logs file and troubleshoot errors


How to download x-ui user data file and export it to other formats


How to download x-ui inbound data file and import it from other sources


How to download x-ui database file and manage it with SQLite tools


How to download x-ui media file and change the panel logo or favicon


How to download x-ui config file and modify the panel settings manually


How to download x-ui bin file and replace the xray core with a newer version


How to download x-ui service file and register it as a systemd service


How to download x-ui install script file and run it on your server with curl command


How to download x-ui uninstall script file and remove it from your server completely


Using a Single Command Script




The easiest way to download and install x-ui is to use the single command script provided by the developer. This script will automatically download the latest version of x-ui from GitHub, extract it to the appropriate directories, set the necessary permissions, create a systemd service file, and start the service. To use this method, simply run the following command as root:


bash < (curl -Ls [16](


The script will prompt you to enter the port number for accessing the web UI. The default port is 54321. You can change it to any port that is not in use by other services on your server. After entering the port number, press Enter to continue.


The script will then download and install x-ui on your server. It may take a few minutes depending on your network speed. When the installation is complete, you will see a message like this:



x-ui Successful installation If it is a new installation, the default web port is: 54321 The default username is: admin The default password is: admin Please make sure that this port is not blocked by firewalls or other software. Otherwise you will not be able to access the panel. x-ui If you want to uninstall x-ui, you can run the following command as root: bash < (curl -Ls [17](


This will stop and remove the x-ui service, delete the x-ui directory and all its files, and restore the original xray configuration file. Manual Installation or Upgrade




If you prefer to download and install x-ui manually, or if you want to upgrade x-ui to the latest version, you can follow these steps: 1. Download the latest release of x-ui from GitHub: [18]( 2. Extract the downloaded file to a directory of your choice, such as /usr/local/x-ui 3. Change the owner and group of the directory and its files to root:root 4. Copy the x-ui.service file to /etc/systemd/system/ 5. Reload the systemd daemon: systemctl daemon-reload 6. Start the x-ui service: systemctl start x-ui 7. Enable the x-ui service to run on boot: systemctl enable x-ui To upgrade x-ui, you can repeat steps 1 to 6, but skip step 5. Using Docker




If you are familiar with docker, you can also use it to download and run x-ui on your server. To use this method, you need to have docker installed and running on your server. You can follow the official documentation to install docker on your Linux distribution: [19]( To download and run x-ui using docker, you can use the following command: docker run -d --name=x-ui --restart=always --network=host -v /etc/localtime:/etc/localtime:ro -v /etc/x-ui:/etc/x-ui vaxilu/x-ui


This will pull the latest image of x-ui from Docker Hub and run it as a container named x-ui. It will also mount the /etc/localtime and /etc/x-ui directories on your host machine to the container, so that you can access and modify the configuration files and logs of x-ui. The --network=host option will allow the container to use the host network, so that you can access the web UI using the host IP address and port. To stop and remove the x-ui container, you can use the following command: docker stop x-ui && docker rm x-ui


To update the x-ui image, you can use the following command: docker pull vaxilu/x-ui


SSL Certificate Application




If you want to access the web UI of x-ui over HTTPS, you need to have a domain name that points to your server's IP address and a valid SSL certificate for that domain name. You can use your own domain name and SSL certificate, or you can apply for a free one using one of the following methods:


Using Cloudflare DNS API




If you are using Cloudflare as your DNS provider, you can use its API to apply for a free SSL certificate from Let's Encrypt. To use this method, you need to have a Cloudflare account and an API token with Zone.Zone and Zone.DNS permissions. You can follow this guide to create an API token: [20](


Once you have your API token, you can run the following command as root:


x-ui ssl --cf-email [your cloudflare email] --cf-key [your cloudflare api token] --domain [your domain name]


This will use acme.sh script to issue a SSL certificate for your domain name using Cloudflare DNS API. The certificate will be saved in /root/.acme.sh/[your domain name]/ directory. The script will also automatically renew the certificate every 60 days.


Using acme.sh Script




If you are not using Cloudflare as your DNS provider, or if you prefer to use another script to apply for a SSL certificate, you can use acme.sh script. This is a shell script that can issue SSL certificates from Let's Encrypt using different DNS providers or webroot methods. You can find more information about acme.sh script here: [21](


To use this method, you need to install acme.sh script on your server first. You can run the following command as root:


curl sh


This will install acme.sh script in /root/.acme.sh/ directory and create an alias for it.


Then Then, you need to issue a SSL certificate for your domain name using acme.sh script. You can use different methods depending on your DNS provider or webroot access. For example, if you are using Google Cloud DNS, you can run the following command as root: export GD_Key="your google cloud dns api key" export GD_Secret="your google cloud dns api secret" acme.sh --issue --dns dns_gd -d [your domain name]


This will use Google Cloud DNS API to issue a SSL certificate for your domain name. The certificate will be saved in /root/.acme.sh/[your domain name]/ directory. The script will also automatically renew the certificate every 60 days. You can find more examples of using acme.sh script with different DNS providers or webroot methods here: [22]( and here: [23]( Using certbot Script




Another script that you can use to apply for a SSL certificate is certbot. This is a Python-based script that can issue SSL certificates from Let's Encrypt using different plugins or webroot methods. You can find more information about certbot script here: [24](


To use this method, you need to install certbot script on your server first. You can follow the official documentation to install certbot on your Linux distribution: [25](


Then, you need to issue a SSL certificate for your domain name using certbot script. You can use different plugins or webroot methods depending on your server configuration and preference. For example, if you have nginx installed and configured on your server, you can run the following command as root:


certbot --nginx -d [your domain name]


This will use the nginx plugin to issue a SSL certificate for your domain name and automatically configure nginx to use it. The certificate will be saved in /etc/letsencrypt/live/[your domain name]/ directory. The script will also automatically renew the certificate every 90 days.


You can find more examples of using certbot script with different plugins or webroot methods here: [26](


Usage and Configuration




After you have downloaded and installed x-ui and applied a SSL certificate for your domain name, you can start using and configuring the web UI of x-ui. Here are some of the main features and functions of x-ui that you should know:


Accessing the Web UI and Setting the Panel Password




To access the web UI of x-ui, you need to open your web browser and enter the following URL:


http(s)://[your server IP or domain name]:[your web port]


For example, if your server IP is 1.2.3.4, your domain name is example.com, and your web port is 54321, you can enter either of these URLs:



If you have applied a SSL certificate for your domain name, we recommend using HTTPS for secure access.


The first time you access the web UI, you will be asked to enter the username and password for logging in. The default username is admin and the default password is admin. You should change the password as soon as possible to prevent unauthorized access.


To change the panel password, click on the Settings icon on the top right corner of the web UI, then click on Panel Settings. Enter your old password and new password, then click on Save.


Adding and Managing Servers and Users




To add a new xray server or user, click on the Add button on the top left corner of the web UI, then select Server or User. You will see a form where you can enter the details of the server or user, such as name, protocol, port, UUID, etc.


You can also edit or delete an existing server or user by clicking on the Edit or Delete button next to their name on the web UI.


To view the status and statistics of a server or user, such as traffic usage, online status, connection speed, etc., click on their name on the web UI.


Customizing Xray Configuration Templates




X-ui uses configuration templates to generate xray configuration files for each server and user. You can customize these templates to suit your needs and preferences.


To edit a configuration template To edit a configuration template, click on the Settings icon on the top right corner of the web UI, then click on Configuration Templates. You will see a list of templates for different protocols and scenarios. You can click on the Edit button next to a template to modify it. You can use variables in the templates to represent the values of the server or user parameters, such as name, port, UUID, etc. For example, .Port will be replaced by the actual port number of the server or user. You can find more information about the variables and their usage here: [27]( You can also use comments in the templates to add notes or explanations. Comments start with // and end with a newline. For example, // this is a comment. You can preview the generated configuration file for a server or user by clicking on their name on the web UI, then clicking on Configuration File. Enabling Telegram Bot for Notifications (Under Development)




X-ui has a feature that allows you to receive notifications from a Telegram bot when a server or user is added, deleted, modified, or expired. This feature is still under development and may not work properly.


To enable this feature, you need to have a Telegram account and a bot token. You can follow this guide to create a bot and get its token: [28](


Once you have your bot token, you need to enter it in the web UI of x-ui. Click on the Settings icon on the top right corner of the web UI, then click on Telegram Bot Settings. Enter your bot token and click on Save.


Then, you need to start a conversation with your bot on Telegram and send it any message. This will allow the bot to get your chat ID and send you notifications.


You can also customize the notification messages and enable or disable notifications for different events. You can find more information about this feature here: [29](


Migration from v2-ui




If you are using v2-ui, a similar web-based GUI for v2ray, and you want to switch to x-ui, you can migrate all your inbound account data from v2-ui to x-ui using a built-in function of x-ui.


To use this function, you need to have both v2-ui and x-ui installed and running on your server. Then, run the following command as root:


x-ui v2-ui


This will prompt you to enter the port number of v2-ui's web UI. The default port is 65432. You can change it if you have modified it before.


Then, the command will read all the inbound account data from v2-ui's database and import them into x-ui's database. It will also backup v2-ui's database and configuration file in /etc/v2-ui/ directory.


After the migration is complete, you can stop and uninstall v2-ui if you want to. You can also delete the backup files if you don't need them anymore.


Conclusion




In this article, we have shown you how to download and install x-ui on your Linux server, how to apply SSL certificates for secure access, how to use and configure the web UI, and how to migrate from v2-ui if you are using it.


X-ui is a multi-protocol and multi-user xray panel with a web UI that can help you manage your xray servers and users with ease. It supports multiple protocols such as VMess, VLESS, Trojan, Shadowsocks, Socks, HTTP, etc., and allows you to customize xray configuration templates, apply SSL certificates, enable Telegram bot notifications, and more.


If you want to learn more about x-ui and its features, you can visit its GitHub repository here: [30]( or join its Telegram group here: [31](


Frequently Asked Questions





  • What is the difference between x-ui and v2-ui?



  • X-ui is based on v2-ui but supports xray instead of v2ray. Xray is a fork of v2ray that has more features and better performance. X-ui also has some improvements and bug fixes over v2-ui.



  • How can I backup or restore my x-ui data?



  • You can backup your x-ui data by copying the /etc/x-ui/ directory to another location. You can restore your You can restore your x-ui data by copying the backup directory to /etc/x-ui/ and restarting the x-ui service.



  • How can I update x-ui to the latest version?



  • You can update x-ui to the latest version by using one of the installation methods mentioned above. The update process will not overwrite your existing data or configuration.



  • How can I troubleshoot x-ui issues?



  • You can check the x-ui log file in /etc/x-ui/x-ui.log for any errors or warnings. You can also check the xray log file in /etc/xray/xray.log for any issues related to xray. If you need further assistance, you can contact the developer or the community on GitHub or Telegram.



  • How can I contribute to x-ui development?



You can contribute to x-ui development by reporting bugs, suggesting features, translating languages, or making donations. You can find more information on how to contribute here: [32](


I hope you enjoyed this article and found it useful. If you have any questions or feedback, please feel free to leave a comment below. Thank you for reading! 44f88ac181


 
 
 

Recent Posts

See All
Testes de substantivos

Como usar o substantivo Testləri para aprender inglês Os substantivos são uma das partes mais básicas e essenciais do discurso em...

 
 
 
faça um bebê feliz apk mod

Make a Happy Baby APK Mod: um jogo divertido e educativo para Android Você ama bebês e quer cuidar deles? Você quer experimentar...

 
 
 

Comments


bottom of page