gandc/x-ui
1
0
Fork 0
mirror of https://github.com/alireza0/x-ui.git synced 2026-03-14 05:23:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

x-ui menu edit typo (#680)

Browse Source 
* Update README.md
* Update x-ui.sh

---------

Co-authored-by: Shahin-IO <115543613+shahin-io@users.noreply.github.com>
This commit is contained in:
shahin-io
2023-12-04 19:29:36 +00:00
committed by GitHub
parent 7ed106a0f0
commit e488dc18b1
2 changed files with 42 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@@ -1,4 +1,4 @@
# x-ui # X-UI
![](https://img.shields.io/github/v/release/alireza0/x-ui.svg) ![](https://img.shields.io/github/v/release/alireza0/x-ui.svg)
![](https://img.shields.io/docker/pulls/alireza7/x-ui.svg) ![](https://img.shields.io/docker/pulls/alireza7/x-ui.svg)
@@ -8,7 +8,7 @@
> **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,Russian)** **Xray Panel Supporting Multi-Protocol, Multi-lang (English,Farsi,Chinese,Russian)**
| Features | Enable? | | Features | Enable? |
| ------------------------------------ | :----------------: | | ------------------------------------ | :----------------: |
@@ -32,13 +32,13 @@ xray panel supporting multi-protocol, **Multi-lang (English,Farsi,Chinese,Russia
- Tron USDT (TRC20): `TYTq73Gj6dJ67qe58JVPD9zpjW2cc9XgVz` - Tron USDT (TRC20): `TYTq73Gj6dJ67qe58JVPD9zpjW2cc9XgVz`
- Tezos (XTZ): tz2Wnh2SsY1eezXrcLChu6idWpgdHzUFQcts - Tezos (XTZ): tz2Wnh2SsY1eezXrcLChu6idWpgdHzUFQcts
# Install & Upgrade to latest version ## Install & Upgrade to latest Version
```sh ```sh
bash <(curl -Ls https://raw.githubusercontent.com/alireza0/x-ui/master/install.sh) bash <(curl -Ls https://raw.githubusercontent.com/alireza0/x-ui/master/install.sh)
``` ```
## Install custom version ## 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`: To install your desired version you can add the version to the end of install command. Example for ver `0.5.2`:
@@ -46,7 +46,7 @@ To install your desired version you can add the version to the end of install co
bash <(curl -Ls https://raw.githubusercontent.com/alireza0/x-ui/master/install.sh) 0.5.2 bash <(curl -Ls https://raw.githubusercontent.com/alireza0/x-ui/master/install.sh) 0.5.2
``` ```
## Manual install & upgrade ## Manual Install & Upgrade
1. First download the latest compressed package from https://github.com/alireza0/x-ui/releases, generally choose Architecture `amd64` 1. First download the latest compressed package from https://github.com/alireza0/x-ui/releases, generally choose Architecture `amd64`
2. Then upload the compressed package to the server's `/root/` directory and login to the server with user `root` 2. Then upload the compressed package to the server's `/root/` directory and login to the server with user `root`
@@ -68,15 +68,15 @@ systemctl enable x-ui
systemctl restart x-ui systemctl restart x-ui
``` ```
## Install using docker ## Install Using Docker
1. install docker 1. Install Docker
```shell ```shell
curl -fsSL https://get.docker.com | sh curl -fsSL https://get.docker.com | sh
``` ```
2. install x-ui 2. Install X-UI
```shell ```shell
mkdir x-ui && cd x-ui mkdir x-ui && cd x-ui
@@ -95,7 +95,7 @@ docker run -itd \
docker build -t x-ui . docker build -t x-ui .
``` ```
# Features ## Features
- System Status Monitoring - System Status Monitoring
- Search within all inbounds and clients - Search within all inbounds and clients
@@ -114,14 +114,14 @@ docker build -t x-ui .
- Support export/import database from panel - Support export/import database from panel
- Show online users - Show online users
## suggestion system ## Recommended OS
- CentOS 8+ - CentOS 8+
- Ubuntu 20+ - Ubuntu 20+
- Debian 10+ - Debian 10+
- Fedora 36+ - Fedora 36+
## API routes ## API Routes
- `/login` with `PUSH` user data: `{username: '', password: ''}` for login - `/login` with `PUSH` user data: `{username: '', password: ''}` for login
- `/xui/API/inbounds` base for following actions: - `/xui/API/inbounds` base for following actions:
@@ -150,7 +150,7 @@ docker build -t x-ui .
- `client.password` for TROJAN - `client.password` for TROJAN
- `client.email` for Shadowsocks - `client.email` for Shadowsocks
# Environment Variables ## Environment Variables
| Variable | Type | Default | | Variable | Type | Default |
| -------------- | :--------------------------------------------: | :------------ | | -------------- | :--------------------------------------------: | :------------ |
@@ -159,14 +159,14 @@ docker build -t x-ui .
| XUI_BIN_FOLDER | `string` | `"bin"` | | XUI_BIN_FOLDER | `string` | `"bin"` |
| XUI_DB_FOLDER | `string` | `"/etc/x-ui"` | | XUI_DB_FOLDER | `string` | `"/etc/x-ui"` |
# Screenshots ## Screenshots
![inbounds](./media/inbounds.png) ![inbounds](./media/inbounds.png)
![Dark inbounds](./media/inbounds-dark.png) ![Dark inbounds](./media/inbounds-dark.png)
![outbounds](./media/outbounds.png) ![outbounds](./media/outbounds.png)
![rules](./media/rules.png) ![rules](./media/rules.png)
## SSL certificate application ## SSL Certificate Application
<details> <details>
<summary>Click for details</summary> <summary>Click for details</summary>
@@ -183,7 +183,7 @@ certbot certonly --standalone --register-unsafely-without-email --non-interactiv
</details> </details>
## Tg robot use ## Telegram Bot
<details> <details>
<summary>Click for details</summary> <summary>Click for details</summary>
@@ -224,18 +224,18 @@ Reference syntax:
- Multi language bot - Multi language bot
</details> </details>
# T-Shoots: ## T-Shoots
**If you upgrade from an old version or other forks, for enable traffic for users you should do :** **Please be aware if you upgrade from an old X-UI version or other forks, by default data traffic usage for users may not work! it's recommended to follow below steps for enabeling:**
find this in config : 1. Find this section in config file
```json ```json
"policy": { "policy": {
"system": { "system": {
``` ```
**and add this just after ` "policy": {` :** 2. Add below section just after ` "policy": {` :
```json ```json
"levels": { "levels": {
@@ -246,7 +246,7 @@ find this in config :
}, },
``` ```
**the final output is like :** - The final output is like:
```json ```json
"policy": { "policy": {
@@ -265,20 +265,20 @@ find this in config :
"routing": { "routing": {
``` ```
restart panel 3. Save and restart panel
</details> </details>
# a special thanks to ## a Special Thanks to
- [HexaSoftwareTech](https://github.com/HexaSoftwareTech/) - [HexaSoftwareTech](https://github.com/HexaSoftwareTech/)
- [MHSanaei](https://github.com/MHSanaei) - [MHSanaei](https://github.com/MHSanaei)
# Acknowledgment ## Acknowledgment
- [Iran Hosted Domains](https://github.com/bootmortis/iran-hosted-domains) (License: **MIT**): _A comprehensive list of Iranian domains and services that are hosted within the country._ - [Iran Hosted Domains](https://github.com/bootmortis/iran-hosted-domains) (License: **MIT**): _A comprehensive list of Iranian domains and services that are hosted within the country._
- [PersianBlocker](https://github.com/MasterKia/PersianBlocker) (License: **AGPLv3**): _An optimal and extensive list to block ads and trackers on Persian websites._ - [PersianBlocker](https://github.com/MasterKia/PersianBlocker) (License: **AGPLv3**): _An optimal and extensive list to block ads and trackers on Persian websites._
## Stargazers over time ## Stargazers over Time
[![Stargazers over time](https://starchart.cc/alireza0/x-ui.svg)](https://starchart.cc/alireza0/x-ui) [![Stargazers over time](https://starchart.cc/alireza0/x-ui.svg)](https://starchart.cc/alireza0/x-ui)

34
x-ui.sh
View File

@@ -613,27 +613,29 @@ ssl_cert_issue_CF() {
} }
show_usage() { show_usage() {
echo "x-ui control menu usages: " echo "X-UI Control Menu Usage"
echo "------------------------------------------" echo "------------------------------------------"
echo "x-ui - Enter Admin menu" echo "SUBCOMMANDS:"
echo "x-ui start - Start x-ui" echo "x-ui - Admin management script"
echo "x-ui stop - Stop x-ui" echo "x-ui start - Start X-UI"
echo "x-ui restart - Restart x-ui" echo "x-ui stop - Stop X-UI"
echo "x-ui status - Show x-ui status" echo "x-ui restart - Restart X-UI"
echo "x-ui enable - Enable x-ui on system startup" echo "x-ui status - Current X-UI status"
echo "x-ui disable - Disable x-ui on system startup" echo "x-ui enable - Enable X-UI on system startup"
echo "x-ui log - Check x-ui logs" echo "x-ui disable - Disable X-UI on system startup"
echo "x-ui update - Update x-ui" echo "x-ui log - Check X-UI logs"
echo "x-ui install - Install x-ui" echo "x-ui update - Update X-UI"
echo "x-ui uninstall - Uninstall x-ui" echo "x-ui install - Install X-UI"
echo "x-ui uninstall - Uninstall X-UI"
echo "x-ui help - Control menu usage"
echo "------------------------------------------" echo "------------------------------------------"
} }
show_menu() { show_menu() {
echo -e " echo -e "
${green}X-UI Panel Management Script${plain} ${green}X-UI Admin Management Script ${plain}
———————————————— ————————————————
${green}0.${plain} Exit Script ${green}0.${plain} Exit
———————————————— ————————————————
${green}1.${plain} Install X-UI ${green}1.${plain} Install X-UI
${green}2.${plain} Update X-UI ${green}2.${plain} Update X-UI
@@ -646,7 +648,7 @@ show_menu() {
———————————————— ————————————————
${green}8.${plain} Start X-UI ${green}8.${plain} Start X-UI
${green}9.${plain} Stop X-UI ${green}9.${plain} Stop X-UI
${green}10.${plain} Reboot X-UI ${green}10.${plain} Restart X-UI
${green}11.${plain} Check X-UI State ${green}11.${plain} Check X-UI State
${green}12.${plain} Check X-UI Logs ${green}12.${plain} Check X-UI Logs
———————————————— ————————————————
@@ -717,7 +719,7 @@ show_menu() {
ssl_cert_issue_CF ssl_cert_issue_CF
;; ;;
*) *)
LOGE "Please enter the correct number [0-16]" LOGE "Please enter the correct number [0-17]"
;; ;;
esac esac
} }