Home

Awesome

English | 中文 | Español | Русский

<p align="center"><a href="#"><img src="./media/3X-UI.png" alt="Image"></a></p>

An Advanced Web Panel • Built on Xray Core

GO Version Downloads License

Disclaimer: This project is only for personal learning and communication, please do not use it for illegal purposes, please do not use it in a production environment

If this project is helpful to you, you may wish to give it a:star2:

<p align="left"> <a href="https://buymeacoffee.com/mhsanaei" target="_blank"> <img src="./media/buymeacoffe.png" alt="Image"> </a> </p>

Install & Upgrade

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

Install legacy Version (we don't recommend)

To install your desired version, use following installation command. e.g., ver v1.7.9:

VERSION=v1.7.9 && bash <(curl -Ls "https://raw.githubusercontent.com/mhsanaei/3x-ui/$VERSION/install.sh") $VERSION

SSL Certificate

<details> <summary>Click for SSL Certificate details</summary>

ACME

To manage SSL certificates using ACME:

  1. Ensure your domain is correctly resolved to the server.

  2. Run the x-ui command in the terminal, then choose SSL Certificate Management.

  3. You will be presented with the following options:

    • Get SSL: Obtain SSL certificates.
    • Revoke: Revoke existing SSL certificates.
    • Force Renew: Force renewal of SSL certificates.
    • Show Existing Domains: Display all domain certificates available on the server.
    • Set Certificate Paths for the Panel: Specify the certificate for your domain to be used by the panel.

Certbot

To install and use Certbot:

apt-get install certbot -y
certbot certonly --standalone --agree-tos --register-unsafely-without-email -d yourdomain.com
certbot renew --dry-run

Cloudflare

The management script includes a built-in SSL certificate application for Cloudflare. To use this script to apply for a certificate, you need the following:

How to get the Cloudflare Global API Key:

  1. Run the x-ui command in the terminal, then choose Cloudflare SSL Certificate.
  2. Visit the link: Cloudflare API Tokens.
  3. Click on "View Global API Key" (see the screenshot below):
  4. You may need to re-authenticate your account. After that, the API Key will be shown (see the screenshot below):

When using, just enter your domain name, email, and API KEY. The diagram is as follows:

</details>

Manual Install & Upgrade

<details> <summary>Click for manual install details</summary>

Usage

  1. To download the latest version of the compressed package directly to your server, run the following command:
ARCH=$(uname -m)
case "${ARCH}" in
  x86_64 | x64 | amd64) XUI_ARCH="amd64" ;;
  i*86 | x86) XUI_ARCH="386" ;;
  armv8* | armv8 | arm64 | aarch64) XUI_ARCH="arm64" ;;
  armv7* | armv7) XUI_ARCH="armv7" ;;
  armv6* | armv6) XUI_ARCH="armv6" ;;
  armv5* | armv5) XUI_ARCH="armv5" ;;
  s390x) echo 's390x' ;;
  *) XUI_ARCH="amd64" ;;
esac


wget https://github.com/MHSanaei/3x-ui/releases/latest/download/x-ui-linux-${XUI_ARCH}.tar.gz
  1. Once the compressed package is downloaded, execute the following commands to install or upgrade x-ui:
ARCH=$(uname -m)
case "${ARCH}" in
  x86_64 | x64 | amd64) XUI_ARCH="amd64" ;;
  i*86 | x86) XUI_ARCH="386" ;;
  armv8* | armv8 | arm64 | aarch64) XUI_ARCH="arm64" ;;
  armv7* | armv7) XUI_ARCH="armv7" ;;
  armv6* | armv6) XUI_ARCH="armv6" ;;
  armv5* | armv5) XUI_ARCH="armv5" ;;
  s390x) echo 's390x' ;;
  *) XUI_ARCH="amd64" ;;
esac

cd /root/
rm -rf x-ui/ /usr/local/x-ui/ /usr/bin/x-ui
tar zxvf x-ui-linux-${XUI_ARCH}.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
</details>

Install with Docker

<details> <summary>Click for Docker details</summary>

Usage

  1. Install Docker:

    bash <(curl -sSL https://get.docker.com)

  2. Clone the Project Repository:

    git clone https://github.com/MHSanaei/3x-ui.git
cd 3x-ui

  3. Start the Service:

    docker compose up -d

Add --pull always flag to make docker automatically recreate container if a newer image is pulled. See https://docs.docker.com/reference/cli/docker/container/run/#pull for more info.

OR

docker run -itd \
   -e XRAY_VMESS_AEAD_FORCED=false \
   -v $PWD/db/:/etc/x-ui/ \
   -v $PWD/cert/:/root/cert/ \
   --network=host \
   --restart=unless-stopped \
   --name 3x-ui \
   ghcr.io/mhsanaei/3x-ui:latest

  1. Update to the Latest Version:

    cd 3x-ui
docker compose down
docker compose pull 3x-ui
docker compose up -d

  2. Remove 3x-ui from Docker:

    docker stop 3x-ui
docker rm 3x-ui
cd --
rm -r 3x-ui
</details>

Nginx Settings

<details> <summary>Click for Reverse Proxy Configuration</summary>

Nginx Reverse Proxy

location / {
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header Host $http_host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header Range $http_range;
    proxy_set_header If-Range $http_if_range; 
    proxy_redirect off;
    proxy_pass http://127.0.0.1:2053;
}

Nginx sub-path

location /sub {
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header Host $http_host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header Range $http_range;
    proxy_set_header If-Range $http_if_range; 
    proxy_redirect off;
    proxy_pass http://127.0.0.1:2053;
}
</details>

Recommended OS

Supported Architectures and Devices

<details> <summary>Click for Supported Architectures and devices details</summary>

Our platform offers compatibility with a diverse range of architectures and devices, ensuring flexibility across various computing environments. The following are key architectures that we support:

</details>

Languages

Features

Default Panel Settings

<details> <summary>Click for default settings details</summary>

Username, Password, Port, and Web Base Path

If you choose not to modify these settings, they will be generated randomly (this does not apply to Docker).

Default Settings for Docker:

Database Management:

You can conveniently perform database Backups and Restores directly from the panel.

Web Base Path

  1. Reset Web Base Path:

    • Open your terminal.
    • Run the x-ui command.
    • Select the option to Reset Web Base Path.

  2. Generate or Customize Path:

    • The path will be randomly generated, or you can enter a custom path.

  3. View Current Settings:

    • To view your current settings, use the x-ui settings command in the terminal or View Current Settings in x-ui

Security Recommendation:

Examples:

</details>

WARP Configuration

<details> <summary>Click for WARP configuration details</summary>

Usage

For versions v2.1.0 and later:

WARP is built-in, and no additional installation is required. Simply turn on the necessary configuration in the panel.

</details>

IP Limit

<details> <summary>Click for IP limit details</summary>

Usage

Note: IP Limit won't work correctly when using IP Tunnel.

For versions v1.7.0 and newer:

To enable the IP Limit functionality, you need to install fail2ban and its required files by following these steps:

  1. Run the x-ui command in the terminal, then choose IP Limit Management.

  2. You will see the following options:

    • Change Ban Duration: Adjust the duration of bans.
    • Unban Everyone: Lift all current bans.
    • Check Logs: Review the logs.
    • Fail2ban Status: Check the status of fail2ban.
    • Restart Fail2ban: Restart the fail2ban service.
    • Uninstall Fail2ban: Uninstall Fail2ban with configuration.

  3. Add a path for the access log on the panel by setting Xray Configs/log/Access log to ./access.log then save and restart xray.

</details>

Telegram Bot

<details> <summary>Click for Telegram bot details</summary>

Usage

The web panel supports daily traffic, panel login, database backup, system status, client info, and other notification and functions through the Telegram Bot. To use the bot, you need to set the bot-related parameters in the panel, including:

Reference syntax:

Telegram Bot Features

Setting up Telegram bot

Enter your bot token in input field number 3. Enter the user ID in input field number 4. The Telegram accounts with this id will be the bot admin. (You can enter more than one, Just separate them with ,)

</details>

API Routes

<details> <summary>Click for API routes details</summary>

Usage

MethodPathAction
GET"/list"Get all inbounds
GET"/get/:id"Get inbound with inbound.id
GET"/getClientTraffics/:email"Get Client Traffics with email
GET"/getClientTrafficsById/:id"Get client's traffic By ID
GET"/createbackup"Telegram bot sends backup to admins
POST"/add"Add inbound
POST"/del/:id"Delete Inbound
POST"/update/:id"Update Inbound
POST"/clientIps/:email"Client Ip address
POST"/clearClientIps/:email"Clear Client Ip address
POST"/addClient"Add Client to inbound
POST"/:id/delClient/:clientId"Delete Client by clientId*
POST"/updateClient/:clientId"Update Client by clientId*
POST"/:id/resetClientTraffic/:email"Reset Client's Traffic
POST"/resetAllTraffics"Reset traffics of all inbounds
POST"/resetAllClientTraffics/:id"Reset traffics of all clients in an inbound
POST"/delDepletedClients/:id"Delete inbound depleted clients (-1: all)
POST"/onlines"Get Online users ( list of emails )

*- The field clientId should be filled by:

</details>

Environment Variables

<details> <summary>Click for environment variables details</summary>

Usage

VariableTypeDefault
XUI_LOG_LEVEL"debug" | "info" | "warn" | "error""info"
XUI_DEBUGbooleanfalse
XUI_BIN_FOLDERstring"bin"
XUI_DB_FOLDERstring"/etc/x-ui"
XUI_LOG_FOLDERstring"/var/log"

Example:

XUI_BIN_FOLDER="bin" XUI_DB_FOLDER="/etc/x-ui" go build main.go
</details>

Preview

1 2 3 4 5 6 7

A Special Thanks to

Acknowledgment

Stargazers over Time

Stargazers over time