Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/MHSanaei/3x-ui.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMHSanaei <ho3ein.sanaei@gmail.com>2023-05-07 16:42:47 +0300
committerMHSanaei <ho3ein.sanaei@gmail.com>2023-05-07 16:42:47 +0300
commit87a5190b7d2e01678a6fbb08722e1326692f3530 (patch)
tree8728e2bef80fc245ce6105f95320884a4866e4ec /README.md
parent9d47d74a7a076921d157188ae82ea83e66c96d09 (diff)
v1.4.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 15 insertions, 11 deletions
diff --git a/README.md b/README.md
index 1e9e98df..46ae2098 100644
--- a/README.md
+++ b/README.md
@@ -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://img.shields.io/github/v/release/mhsanaei/3x-ui.svg)](https://github.com/MHSanaei/3x-ui/releases)
[![](https://img.shields.io/github/actions/workflow/status/mhsanaei/3x-ui/release.yml.svg)](#)
@@ -6,11 +7,12 @@
[![Downloads](https://img.shields.io/github/downloads/mhsanaei/3x-ui/total.svg)](#)
[![License](https://img.shields.io/badge/license-GPL%20V3-blue.svg?longCache=true)](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**
+3x-ui panel supporting multi-protocol, **Multi-lang (English,Farsi,Chinese)**
**If you think this project is helpful to you, you may wish to give a** :star2:
-xray panel supporting multi-protocol, **Multi-lang (English,Farsi,Chinese)**
+**Buy Me a Coffee :**
+ - Tron USDT (TRC20): `TXncxkvhkDWGts487Pjqq1qT9JmwRUz8CC`
# Install & Upgrade
@@ -20,10 +22,10 @@ bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.
## Install custom version
-To install your desired version you can add the version to the end of install command. Example for ver `v1.3.3`:
+To install your desired version you can add the version to the end of install command. Example for ver `v1.4.0`:
```
-bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v1.3.3
+bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v1.4.0
```
# SSL
@@ -171,13 +173,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 UID/Password as clientId |
-| `POST` | `"/updateClient/:clientId"` | Update Client by UID/Password as 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:
+- `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
@@ -191,10 +199,6 @@ Reference syntax:
- CentOS 8+
- Fedora 36+
-# Buy Me a Coffee
-
-- Tron USDT (TRC20): `TXncxkvhkDWGts487Pjqq1qT9JmwRUz8CC`
-
# Pictures
![1](./media/1.png)