Code Monkey home page Code Monkey logo

x-ui's Introduction

x-ui

xray panel supporting multi-protocol, Multi-lang (English,Chinese), IP Restrication Per Inbound

Features Enable?
Multi-lang ✔️
IP Restriction ✔️
Inbound Multi User ✔️

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

Feel Free for Donation : ❤️

Features

  • System Status Monitoring
  • 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 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

Enable IP Restrictions Per Inbound

1 - open panel settings and tab xray related settings put this to first of json :

{ 
...

"log": {
   "loglevel": "warning", 
   "access": "./access.log"
 },
 
...
"api": ...
  • change access log path as you want

2 - add IP limit and Unique Email for inbound(vmess & vless)

Install & Upgrade

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

Manual install & upgrade

  1. First download the latest compressed package from https://github.com/hossinasaadi/x-ui/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

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

This docker tutorial and docker image are provided by Chasing66

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

This feature and tutorial are provided by FranzKafkaYu

The script has a built-in SSL certificate application function. To use this script to apply for a certificate, the following conditions must be met:

  • Know the Cloudflare registered email
  • Know the Cloudflare Global API Key
  • The domain name has been resolved to the current server through cloudflare

How to get the Cloudflare Global API Key:

When using, just enter email, domain, API KEY and the schematic diagram is as follows:

Precautions:

  • The script uses DNS API for certificate request
  • By default, Let'sEncrypt is used as the CA party
  • The certificate installation directory is the /root/cert directory
  • The certificates applied for by this script are all generic domain name certificates

Tg robot use (under development, temporarily unavailable)

This feature and tutorial are provided by FranzKafkaYu

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

Reference syntax:

  • 30 * * * * * //Notify at the 30s of each point

  • @hourly // hourly notification

  • @daily // Daily notification (00:00 in the morning)

  • @every 8h // notify every 8 hours

  • TG notification content:

  • Node traffic usage

  • Panel login reminder

  • Node expiration reminder

  • Traffic warning reminder

More features are planned...

suggestion system

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

common problem

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

Stargazers over time

Stargazers over time

x-ui's People

Contributors

vaxilu avatar hossinasaadi avatar foroughi1380 avatar hosseinadib-hub avatar franzkafkayu avatar proshir avatar gswxxn avatar jukrb0x avatar chasing66 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.