mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2025-04-19 21:42:24 +00:00
better view
This commit is contained in:
Ho3ein
GitHub
parent
1f2eb2ca1a
commit
45a8d6c95e
1 changed files with 88 additions and 62 deletions
130
README.md
130
README.md
|
|
@ -22,14 +22,13 @@
|
||||||
bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh)
|
bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-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 `v1.6.0`:
|
To install your desired version you can add the version to the end of install command. Example for ver `v1.6.0`:
|
||||||
|
|
||||||
```
|
```
|
||||||
bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v1.6.0
|
bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v1.6.0
|
||||||
```
|
```
|
||||||
|
|
||||||
# SSL
|
# SSL
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
@ -38,40 +37,28 @@ certbot certonly --standalone --agree-tos --register-unsafely-without-email -d y
|
||||||
certbot renew --dry-run
|
certbot renew --dry-run
|
||||||
```
|
```
|
||||||
|
|
||||||
or you can use x-ui menu then number '16' (Apply for an SSL Certificate)
|
or you can use x-ui menu then number `16` (`SSL Certificate Management`)
|
||||||
|
|
||||||
# Default settings
|
# Features
|
||||||
|
|
||||||
- Port: 2053
|
- System Status Monitoring
|
||||||
- username and password will be generated randomly if you skip to modify your own security(x-ui "7")
|
- Search within all inbounds and clients
|
||||||
- database path: /etc/x-ui/x-ui.db
|
- Support Dark/Light theme UI
|
||||||
- xray config path: /usr/local/x-ui/bin/config.json
|
- 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
|
||||||
|
- Fix api routes (user setting will create with api)
|
||||||
|
- Support to change configs by different items provided in panel
|
||||||
|
- Support export/import database from panel
|
||||||
|
|
||||||
Before you set ssl on settings
|
# Manual Install & Upgrade
|
||||||
|
<details>
|
||||||
- http://ip:2053/panel
|
<summary>Click for Manual Install details</summary>
|
||||||
- http://domain:2053/panel
|
|
||||||
|
|
||||||
After you set ssl on settings
|
|
||||||
|
|
||||||
- https://yourdomain:2053/panel
|
|
||||||
|
|
||||||
# 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"` |
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
XUI_BIN_FOLDER="bin" XUI_DB_FOLDER="/etc/x-ui" go build main.go
|
|
||||||
```
|
|
||||||
|
|
||||||
## Manual install & upgrade
|
|
||||||
|
|
||||||
1. To download the latest version of the compressed package directly to your server, run the following command:
|
1. To download the latest version of the compressed package directly to your server, run the following command:
|
||||||
|
|
||||||
|
|
@ -95,10 +82,12 @@ systemctl daemon-reload
|
||||||
systemctl enable x-ui
|
systemctl enable x-ui
|
||||||
systemctl restart x-ui
|
systemctl restart x-ui
|
||||||
```
|
```
|
||||||
Note: If your server's CPU architecture is `arm64`, modify the URL by substituting `amd64` in `tar zxvf x-ui-linux-amd64.tar.gz` with your respective CPU architecture.
|
Note: If your server's CPU architecture is `arm64`, modify the `amd64` in `tar zxvf x-ui-linux-amd64.tar.gz` with your respective CPU architecture.
|
||||||
|
</details>
|
||||||
|
|
||||||
# Install with Docker
|
# Install with Docker
|
||||||
|
<details>
|
||||||
|
<summary>Click for Docker details</summary>
|
||||||
1. Install Docker:
|
1. Install Docker:
|
||||||
```sh
|
```sh
|
||||||
bash <(curl -sSL https://get.docker.com)
|
bash <(curl -sSL https://get.docker.com)
|
||||||
|
|
@ -128,9 +117,32 @@ Note: If your server's CPU architecture is `arm64`, modify the URL by substituti
|
||||||
--name 3x-ui \
|
--name 3x-ui \
|
||||||
ghcr.io/mhsanaei/3x-ui:latest
|
ghcr.io/mhsanaei/3x-ui:latest
|
||||||
```
|
```
|
||||||
|
</details>
|
||||||
|
|
||||||
|
# Default settings
|
||||||
|
<details>
|
||||||
|
<summary>Click for Default settings details</summary>
|
||||||
|
|
||||||
|
- Port: 2053
|
||||||
|
- username and password will be generated randomly if you skip to modify your own security(x-ui "7")
|
||||||
|
- database path: /etc/x-ui/x-ui.db
|
||||||
|
- xray config path: /usr/local/x-ui/bin/config.json
|
||||||
|
|
||||||
|
Before you set ssl on settings
|
||||||
|
|
||||||
|
- http://ip:2053/panel
|
||||||
|
- http://domain:2053/panel
|
||||||
|
|
||||||
|
After you set ssl on settings
|
||||||
|
|
||||||
|
- https://yourdomain:2053/panel
|
||||||
|
</details>
|
||||||
|
|
||||||
# Xray Configurations:
|
# Xray Configurations:
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Click for Xray Configurations details</summary>
|
||||||
|
|
||||||
**copy and paste to xray Configuration :** (you don't need to do this if you have a fresh install)
|
**copy and paste to xray Configuration :** (you don't need to do this if you have a fresh install)
|
||||||
|
|
||||||
- [traffic](./media/configs/traffic.json)
|
- [traffic](./media/configs/traffic.json)
|
||||||
|
|
@ -139,8 +151,13 @@ Note: If your server's CPU architecture is `arm64`, modify the URL by substituti
|
||||||
- [traffic + Block Ads + Use IPv4 for Google](./media/configs/traffic+block-ads+ipv4-google.json)
|
- [traffic + Block Ads + Use IPv4 for Google](./media/configs/traffic+block-ads+ipv4-google.json)
|
||||||
- [traffic + Block Ads + Route Google + Netflix + Spotify + OpenAI (ChatGPT) to WARP](./media/configs/traffic+block-ads+warp.json)
|
- [traffic + Block Ads + Route Google + Netflix + Spotify + OpenAI (ChatGPT) to WARP](./media/configs/traffic+block-ads+warp.json)
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
# [WARP Configuration](https://github.com/fscarmen/warp) (Optional)
|
# [WARP Configuration](https://github.com/fscarmen/warp) (Optional)
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Click for WARP Configuration details</summary>
|
||||||
|
|
||||||
If you want to use routing to WARP follow steps as below:
|
If you want to use routing to WARP follow steps as below:
|
||||||
|
|
||||||
1. If you already installed warp, you can uninstall using below command:
|
1. If you already installed warp, you can uninstall using below command:
|
||||||
|
|
@ -163,24 +180,12 @@ If you want to use routing to WARP follow steps as below:
|
||||||
- Route Google + Netflix + Spotify + OpenAI (ChatGPT) to WARP
|
- Route Google + Netflix + Spotify + OpenAI (ChatGPT) to WARP
|
||||||
- Fix Google 403 error
|
- Fix Google 403 error
|
||||||
|
|
||||||
# Features
|
</details>
|
||||||
|
|
||||||
- System Status Monitoring
|
# Telegram Bot
|
||||||
- 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
|
|
||||||
- Fix api routes (user setting will create with api)
|
|
||||||
- Support to change configs by different items provided in panel
|
|
||||||
- Support export/import database from panel
|
|
||||||
|
|
||||||
# Tg robot use
|
<details>
|
||||||
|
<summary>Click for Telegram Bot details</summary>
|
||||||
|
|
||||||
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)
|
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:
|
Set the robot-related parameters in the panel background, including:
|
||||||
|
|
@ -216,8 +221,11 @@ Reference syntax:
|
||||||
- Check server status
|
- Check server status
|
||||||
- Check depleted users
|
- Check depleted users
|
||||||
- Receive backup by request and in periodic reports
|
- Receive backup by request and in periodic reports
|
||||||
|
</details>
|
||||||
|
|
||||||
## API routes
|
# API routes
|
||||||
|
<details>
|
||||||
|
<summary>Click for API routes details</summary>
|
||||||
|
|
||||||
- `/login` with `PUSH` user data: `{username: '', password: ''}` for login
|
- `/login` with `PUSH` user data: `{username: '', password: ''}` for login
|
||||||
- `/panel/api/inbounds` base for following actions:
|
- `/panel/api/inbounds` base for following actions:
|
||||||
|
|
@ -248,6 +256,24 @@ Reference syntax:
|
||||||
- `client.email` for Shadowsocks
|
- `client.email` for Shadowsocks
|
||||||
|
|
||||||
- [Postman Collection](https://gist.github.com/mehdikhody/9a862801a2e41f6b5fb6bbc7e1326044)
|
- [Postman Collection](https://gist.github.com/mehdikhody/9a862801a2e41f6b5fb6bbc7e1326044)
|
||||||
|
</details>
|
||||||
|
|
||||||
|
# Environment Variables
|
||||||
|
<details>
|
||||||
|
<summary>Click for Environment Variables details</summary>
|
||||||
|
| 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"` |
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
XUI_BIN_FOLDER="bin" XUI_DB_FOLDER="/etc/x-ui" go build main.go
|
||||||
|
```
|
||||||
|
</details>
|
||||||
|
|
||||||
# A Special Thanks To
|
# A Special Thanks To
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue