x-ui

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

xray panel supporting multi-protocol, Multi-lang (English,Farsi,Chinese)

Features	Enable?
Multi-lang	✔️
Dark/Light Theme	✔️
Search in deep	✔️
Inbound Multi User	✔️
Multi User Traffic & Expiration time	✔️
REST API	✔️
Telegram BOT (admin + clients)	✔️
Backup database using Telegram BOT	✔️
Subscription link + userInfo	✔️
Calculate expire date on first usage	✔️

If you think this project is helpful to you, you may wish to give a 🌟

Features

System Status Monitoring
Search within all inbounds and clients
Support Dark/Light theme UI
Support multi-user multi-protocol, web page visualization operation
Supported protocols: vmess, vless, trojan, shadowsocks, dokodemo-door, socks, http
Support for configuring more transport configurations
Traffic statistics, limit traffic, limit expiration time
Customizable xray configuration templates
Support subscription ( multi ) link
Detect users which are expiring or exceed traffic limit soon
Support https access panel (self-provided domain name + ssl certificate)
Support one-click SSL certificate application and automatic renewal
For more advanced configuration items, please refer to the panel

API routes

/login with PUSH user data: {username: '', password: ''} for login
/xui/API/inbounds base for following actions:

Method	Path	Action
`GET`	`"/"`	Get all inbounds
`GET`	`"/get/:id"`	Get inbound with inbound.id
`POST`	`"/add"`	Add inbound
`POST`	`"/del/:id"`	Delete Inbound
`POST`	`"/update/:id"`	Update Inbound
`POST`	`"/addClient/"`	Add Client to inbound
`POST`	`"/:id/delClient/:clientId"`	Delete Client by UID/Password as clientId
`POST`	`"/updateClient/:clientId"`	Update Client by UID/Password as clientId
`POST`	`"/getClientTraffics/:email"`	Get Client's Traffic
`POST`	`"/resetAllTraffics"`	Reset traffics of all inbounds
`POST`	`"/resetAllClientTraffics/:id"`	Reset inbound clients traffics (-1: all)
`POST`	`"/delDepletedClients/:id"`	Delete inbound depleted clients (-1: all)

Environment Variables

Variable	Type	Default
XUI_LOG_LEVEL	`"debug"` \| `"info"` \| `"warn"` \| `"error"`	`"info"`
XUI_DEBUG	`boolean`	`false`
XUI_BIN_FOLDER	`string`	`"bin"`
XUI_DB_FOLDER	`string`	`"/etc/x-ui"`

Screenshot from Inbouds page

suggestion system

CentOS 8+
Ubuntu 20+
Debian 10+
Fedora 36+

Install & Upgrade to latest version

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

Install custom version

To install your desired version you can add the version to the end of install command. Example for ver 0.5.2:

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

Manual install & upgrade

First download the latest compressed package from https://github.com/alireza0/x-ui/releases , generally choose Architecture amd64
Then upload the compressed package to the server's /root/ directory and root rootlog in to the server with user

If your server cpu architecture is not amd64 replace another architecture

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

install docker

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

install x-ui

mkdir x-ui && cd x-ui
docker run -itd \
    -p 54321:54321 -p 443:443 -p 80:80 \
    -e XRAY_VMESS_AEAD_FORCED=false \
    -v $PWD/db/:/etc/x-ui/ \
    -v $PWD/cert/:/root/cert/ \
    --name x-ui --restart=unless-stopped \
    alireza7/x-ui:latest

Build your own image

docker build -t x-ui .

SSL certificate application

Click for details

Certbot

snap install core; snap refresh core
snap install --classic certbot
ln -s /snap/bin/certbot /usr/bin/certbot

certbot certonly --standalone --register-unsafely-without-email --non-interactive --agree-tos -d <Your Domain Name>

Tg robot use

Click for details

X-UI supports daily traffic notification, panel login reminder and other functions through the Tg robot. To use the Tg robot, you need to apply for the specific application tutorial. You can refer to the blog Set the robot-related parameters in the panel background, including:

Tg robot Token
Tg robot ChatId
Tg robot cycle runtime, in crontab syntax
Tg robot Expiration threshold
Tg robot Traffic threshold
Tg robot Enable send backup in cycle runtime
Tg robot Enable CPU usage alarm threshold

Reference syntax:

30 * * * * * //Notify at the 30s of each point
0 */10 * * * * //Notify at the first second of each 10 minutes
@hourly // hourly notification
@daily // Daily notification (00:00 in the morning)
@every 8h // notify every 8 hours

Telegram Bot Features

Report periodic
Login notification
CPU threshold notification
Threshold for Expiration time and Traffic to report in advance
Support client report menu if client's telegram username added to the user's configurations
Support telegram traffic report searched with UID (VMESS/VLESS) or Password (TROJAN) - anonymously
Menu based bot
Search client by email ( only admin )
Check all inbounds
Check server status
Check depleted users
Receive backup by request and in periodic reports

Common problem

Click for details

## 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 the native v2-ui All inbound account data to x-ui，Panel settings and username passwords are not migrated

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

T-Shoots:

If you upgrade from an old version or other forks, for enable traffic for users you should do :

find this in config :

 "policy": {
    "system": {

and add this just after "policy": { :

    "levels": {
      "0": {
        "statsUserUplink": true,
        "statsUserDownlink": true
      }
    },

the final output is like :

  "policy": {
    "levels": {
      "0": {
        "statsUserUplink": true,
        "statsUserDownlink": true
      }
    },

    "system": {
      "statsInboundDownlink": true,
      "statsInboundUplink": true
    }
  },
  "routing": {

restart panel

hamed00019 / x-ui-alireza Goto Github PK

x-ui-alireza's Introduction

x-ui

Features

API routes

Environment Variables

Screenshot from Inbouds page

suggestion system

Install & Upgrade to latest version

Install custom version

Manual install & upgrade

Install using docker

SSL certificate application

Certbot

Tg robot use

Telegram Bot Features

Common problem

T-Shoots:

a special thanks to

Stargazers over time

x-ui-alireza's People

Contributors

Recommend Projects

Recommend Topics

Recommend Org