diff options
| author | Hamidreza Ghavami <70919649+hamid-gh98@users.noreply.github.com> | 2023-05-12 20:48:52 +0300 |
|---|---|---|
| committer | Hamidreza Ghavami <70919649+hamid-gh98@users.noreply.github.com> | 2023-05-12 21:15:32 +0300 |
| commit | 288374d5fa6eedb3131326e60437c0acf058d32f (patch) | |
| tree | 155a4ab4f59de4807541caeae130166f5685babf /README.md | |
| parent | 1f7c79c7359367d54ca0c0080fc78acffe678805 (diff) | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 33 insertions, 6 deletions
@@ -1,4 +1,5 @@ -# 3x-ui +# 3x-ui + > **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** [](https://github.com/MHSanaei/3x-ui/releases) @@ -12,7 +13,8 @@ **If you think this project is helpful to you, you may wish to give a** :star2: **Buy Me a Coffee :** - - Tron USDT (TRC20): `TXncxkvhkDWGts487Pjqq1qT9JmwRUz8CC` + +- Tron USDT (TRC20): `TXncxkvhkDWGts487Pjqq1qT9JmwRUz8CC` # Install & Upgrade @@ -69,6 +71,31 @@ Example: XUI_BIN_FOLDER="bin" XUI_DB_FOLDER="/etc/x-ui" go build main.go ``` +# Install with Docker + +1. Install Docker: + ```sh + bash <(curl -sSL https://get.docker.com) + ``` +2. Run 3x-ui: + + ```sh + docker compose up -d + ``` + + OR + + ```sh + docker run -itd \ + -e XRAY_VMESS_AEAD_FORCED=false \ + -v $PWD/db/:/etc/x-ui/ \ + -v $PWD/cert/:/root/cert/ \ + --network=host \ + --restart=unless-stopped \ + --name 3x-ui \ + ghcr.io/mhsanaei/3x-ui:latest + ``` + # Xray Configurations: **copy and paste to xray Configuration :** (you don't need to do this if you have a fresh install) @@ -173,19 +200,19 @@ Reference syntax: | `POST` | `"/clientIps/:email"` | Client Ip address | | `POST` | `"/clearClientIps/:email"` | Clear Client Ip address | | `POST` | `"/addClient"` | Add Client to inbound | -| `POST` | `"/:id/delClient/:clientId"` | Delete Client by clientId* | -| `POST` | `"/updateClient/:clientId"` | Update Client by clientId* | +| `POST` | `"/:id/delClient/:clientId"` | Delete Client by clientId\* | +| `POST` | `"/updateClient/:clientId"` | Update Client by clientId\* | | `POST` | `"/:id/resetClientTraffic/:email"` | Reset Client's Traffic | | `POST` | `"/resetAllTraffics"` | Reset traffics of all inbounds | | `POST` | `"/resetAllClientTraffics/:id"` | Reset traffics of all clients in an inbound | | `POST` | `"/delDepletedClients/:id"` | Delete inbound depleted clients (-1: all) | -*- The field `clientId` should be filled by: +\*- The field `clientId` should be filled by: + - `client.id` for VMESS and VLESS - `client.password` for TROJAN - `client.email` for Shadowsocks - - [Postman Collection](https://gist.github.com/mehdikhody/9a862801a2e41f6b5fb6bbc7e1326044) # A Special Thanks To |