mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2025-04-19 21:42:24 +00:00
Update README.md
This commit is contained in:
parent
b0a544a321
commit
40c2f5206b
1 changed files with 59 additions and 14 deletions
73
README.md
73
README.md
|
@ -1,10 +1,11 @@
|
||||||
# 3x-ui
|
# 3x-ui
|
||||||

|

|
||||||

|

|
||||||
[](https://img.shields.io/github/go-mod/go-version/mhsanaei/3x-ui)
|

|
||||||
[](https://img.shields.io/github/downloads/mhsanaei/3x-ui/total)
|

|
||||||
[](https://www.gnu.org/licenses/gpl-3.0.en.html)
|
[](https://www.gnu.org/licenses/gpl-3.0.en.html)
|
||||||
|
|
||||||
|
|
||||||
> **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**
|
> **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)**
|
xray panel supporting multi-protocol, **Multi-lang (English,Farsi,Chinese)**
|
||||||
|
@ -42,6 +43,58 @@ After you set ssl on settings
|
||||||
- [for enable traffic](https://raw.githubusercontent.com/mhsanaei/3x-ui/main/media/for%20enable%20traffic.txt)
|
- [for enable traffic](https://raw.githubusercontent.com/mhsanaei/3x-ui/main/media/for%20enable%20traffic.txt)
|
||||||
- [for enable traffic+block all iran ip address](https://raw.githubusercontent.com/mhsanaei/3x-ui/main/media/for%20enable%20traffic%2Bblock%20all%20iran%20ip.txt)
|
- [for enable traffic+block all iran ip address](https://raw.githubusercontent.com/mhsanaei/3x-ui/main/media/for%20enable%20traffic%2Bblock%20all%20iran%20ip.txt)
|
||||||
|
|
||||||
|
# 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 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
|
||||||
|
|
||||||
|
# Tg robot use
|
||||||
|
|
||||||
|
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](https://coderfan.net/how-to-use-telegram-bot-to-alarm-you-when-someone-login-into-your-vps.html)
|
||||||
|
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:
|
||||||
|
|
||||||
|
- @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 if client's telegram username is added to the end of `email` like 'test123@telegram_username'
|
||||||
|
- 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 Exhausted users
|
||||||
|
- Receive backup by request and in periodic reports
|
||||||
|
|
||||||
|
# A Special Thanks To
|
||||||
|
- [alireza0](https://github.com/alireza0/)
|
||||||
|
- [HexaSoftwareTech](https://github.com/HexaSoftwareTech/)
|
||||||
|
|
||||||
# Suggestion System
|
# Suggestion System
|
||||||
- Ubuntu 20.04+
|
- Ubuntu 20.04+
|
||||||
- Debian 10+
|
- Debian 10+
|
||||||
|
@ -50,18 +103,10 @@ After you set ssl on settings
|
||||||
|
|
||||||
# Pictures
|
# Pictures
|
||||||
|
|
||||||

|

|
||||||

|

|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
# A Special Thanks To
|
|
||||||
- [vaxilu](https://github.com/vaxilu/)
|
|
||||||
- [HexaSoftwareTech](https://github.com/HexaSoftwareTech/)
|
|
||||||
- [diditra](https://github.com/diditra/)
|
|
||||||
- [FranzKafkaYu](https://github.com/FranzKafkaYu)
|
|
||||||
- [alireza0](https://github.com/alireza0/)
|
|
||||||
|
|
||||||
|
|
||||||
## Stargazers over time
|
## Stargazers over time
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue