X-UI ENGLISH VERSION

Another Translated-to-English Version of X-UI.

A furthur development from my previous repo and kind a fork from taffychan's x-ui + Yu FranzKafka's x-ui, forked from vaxilu's awesome project 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)
• Multi UUIDs can be added as users for Vmess and Vless configurations
• Telegram Bot for basic functions and noticifactions
• Support one-click SSL certificate application and automatic renewal
• Can be securely migrated from v2-ui
• For more advanced configuration items, see the panel for details

Preview

Telegram Bot 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

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

2. 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

The script has 2 built-in SSL certificate application functions. Using a sub-domain is recommended.

• 1st Method (Recommended. Works for almost any TLD including Freenom free TLDs)

To use this method to apply for a certificate, your server's IP addres being correctly pointed to a domain or subdomain that you own is the only requirement. (Acme.sh script's 3rd option)

• 2nd Method (Use if the above one fails. Would not work for Freenom free TLDs)

This is not beginner frienly as much as the first one. To use this method, all of the follwoing prerequisites should 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. You can choose between Zerossl.com or Buypass.com
• The certificate installation directory is the /root/ directory
• The certificates applied for by this script are all generic domain name certificates

Suggested OSs

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

Telegram Bot Setup Guie

Follow these steps correclty to activate X-UI English Telegram Bot:

1. Head to Botfather bot. Start it and send /newbot command. Follow the Bot's instruvtions for setting a name and username for your bot. Upon a successful new bot creation, you'll see a message like follows. which contains your API key. Keep it somewhere safer. You'll need it later.

Note for Beginner Devs

Hey Beginner Developer! Appreciate your intrest on playing the codes with this repository. I have seen many people who are not much familiar with none of the languages used here, but still need to do some modifications such as translating the UIs to their native language, modifying telegram bot functions and etc... But after they are done with all of these code modifications, some of them having hard times converting their code into a binary. So they contact me and I have to repeatedly tell them the same procedure. So, here's how you can do it by yourself.

• Head to Your fork repository link/actions . Enable Github Actions if it isn't yet.
• Click on Relese X-ui under All workflows
• Finally, click Run workflow twice. Wait untill the workflow run finishes. Once finished, you will find a release packages with your modifications at Your fork repository link/releases

If you are looking to modify Telegram Bot functions, the Bot's code lives at /web/service/telegram.go

Happy Coding, Beginner Dev!

Issues Fixed until the latest update

• GLIBC 2.28 Not Found -- Fixed on 0.1
• Workflow error on TG Bot -- Fixed on 0.1
• One-click SSL installation -- Fixed on 0.1.1
• Multi-user IDs for Vmess and Vless -- Fixed on 0.2
• Telegram bot implementation -- Fixed on 0.2
• Release packages being much heavier in size -- Fixed on 0.2