x-ui menu edit typo (#680)

* 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

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/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**
xray panel supporting multi-protocol, **Multi-lang (English,Farsi,Chinese,Russian)**
**Xray Panel Supporting Multi-Protocol, Multi-lang (English,Farsi,Chinese,Russian)**
| Features | Enable? |
| ------------------------------------ | :----------------: |
@@ -32,13 +32,13 @@ xray panel supporting multi-protocol, **Multi-lang (English,Farsi,Chinese,Russia
- Tron USDT (TRC20): `TYTq73Gj6dJ67qe58JVPD9zpjW2cc9XgVz`
- Tezos (XTZ): tz2Wnh2SsY1eezXrcLChu6idWpgdHzUFQcts
# Install & Upgrade to latest version
## Install & Upgrade to latest Version
```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`:
@@ -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
```
## 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`
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
```
## Install using docker
## Install Using Docker
1. install docker
1. Install Docker
```shell
curl -fsSL https://get.docker.com | sh
```
2. install x-ui
2. Install X-UI
```shell
mkdir x-ui && cd x-ui
@@ -95,7 +95,7 @@ docker run -itd \
docker build -t x-ui .
```
# Features
## Features
- System Status Monitoring
- Search within all inbounds and clients
@@ -114,14 +114,14 @@ docker build -t x-ui .
- Support export/import database from panel
- Show online users
## suggestion system
## Recommended OS
- CentOS 8+
- Ubuntu 20+
- Debian 10+
- Fedora 36+
## API routes
## API Routes
- `/login` with `PUSH` user data: `{username: '', password: ''}` for login
- `/xui/API/inbounds` base for following actions:
@@ -150,7 +150,7 @@ docker build -t x-ui .
- `client.password` for TROJAN
- `client.email` for Shadowsocks
# Environment Variables
## Environment Variables
| Variable | Type | Default |
| -------------- | :--------------------------------------------: | :------------ |
@@ -159,14 +159,14 @@ docker build -t x-ui .
| XUI_BIN_FOLDER | `string` | `"bin"` |
| XUI_DB_FOLDER | `string` | `"/etc/x-ui"` |
# Screenshots
## Screenshots
![inbounds](./media/inbounds.png)
![Dark inbounds](./media/inbounds-dark.png)
![outbounds](./media/outbounds.png)
![rules](./media/rules.png)
## SSL certificate application
## SSL Certificate Application
<details>
<summary>Click for details</summary>
@@ -183,7 +183,7 @@ certbot certonly --standalone --register-unsafely-without-email --non-interactiv
</details>
## Tg robot use
## Telegram Bot
<details>
<summary>Click for details</summary>
@@ -224,18 +224,18 @@ Reference syntax:
- Multi language bot
</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
"policy": {
"system": {
```
**and add this just after ` "policy": {` :**
2. Add below section just after ` "policy": {` :
```json
"levels": {
@@ -246,7 +246,7 @@ find this in config :
},
```
**the final output is like :**
- The final output is like:
```json
"policy": {
@@ -265,20 +265,20 @@ find this in config :
"routing": {
```
restart panel
3. Save and restart panel
</details>
# a special thanks to
## a Special Thanks to
- [HexaSoftwareTech](https://github.com/HexaSoftwareTech/)
- [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._
- [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)