Skip to content

Latest commit

 

History

History
266 lines (203 loc) · 8.9 KB

README.md

File metadata and controls

266 lines (203 loc) · 8.9 KB
Raw

myxui

Go Report Card 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

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

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 🌟

Install & Upgrade to latest version

bash <(curl -Ls https://raw.githubusercontent.com/r0zbeh/myxui/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/r0zbeh/myxui/master/install.sh) 0.5.2

Manual install & upgrade

  1. First download the latest compressed package from https://github.com/r0zbeh/myxui/releases, generally choose Architecture amd64
  2. 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

ARCH=$(uname -m)
[[ "${ARCH}" == "s390x" ]] && XUI_ARCH="s390x" || [[ "${ARCH}" == "aarch64" || "${ARCH}" == "arm64" ]] && XUI_ARCH="arm64" || XUI_ARCH="amd64"
cd /root/
rm x-ui/ /usr/local/x-ui/ /usr/bin/x-ui -rf
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

Install using docker

  1. install docker
curl -fsSL https://get.docker.com | sh
  1. 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 .

Features

  • System Status Monitoring
  • Search within all inbounds and clients
  • Support Dark/Light theme UI
  • Support multi-user multi-protocol, web page visualization operation
  • Support multi-domain configuration and multi-certificate inbounds
  • 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
  • Support export/import database from panel

suggestion system

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

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
GET "/createbackup" Telegram bot sends backup to admins
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 clientId*
POST "/updateClient/:clientId" Update Client by 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)

*- The field clientId should be filled by:

  • client.id for VMESS and VLESS
  • client.password for TROJAN
  • client.email for Shadowsocks

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

inbounds Dark inbounds

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 UUID (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
  • Multi language bot

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

a special thanks to