Skip to content

Commit 841d558

Browse files
authored
Merge pull request #83 from xeefei/3x-ui
3x UI
2 parents 3d99290 + b52f1af commit 841d558

50 files changed

Lines changed: 979 additions & 1422 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/docker.yml

Lines changed: 42 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,55 @@
11
name: Release 3X-UI for Docker
22
on:
3+
workflow_dispatch:
34
push:
45
tags:
5-
- "*"
6-
workflow_dispatch:
6+
- "v*.*.*"
77

88
jobs:
9-
build_and_push:
9+
build:
1010
runs-on: ubuntu-latest
1111

1212
steps:
13-
- name: Check out the code
14-
uses: actions/checkout@v4
15-
- name: Set up QEMU
16-
uses: docker/setup-qemu-action@v3
13+
- uses: actions/checkout@v4
14+
with:
15+
submodules: true
16+
17+
- name: Docker meta
18+
id: meta
19+
uses: docker/metadata-action@v5
20+
with:
21+
images: |
22+
hsanaeii/3x-ui
23+
ghcr.io/mhsanaei/3x-ui
24+
tags: |
25+
type=ref,event=branch
26+
type=ref,event=tag
27+
type=pep440,pattern={{version}}
28+
29+
- name: Set up QEMU
30+
uses: docker/setup-qemu-action@v3
1731

18-
- name: Set up Docker Buildx
19-
uses: docker/setup-buildx-action@v3
32+
- name: Set up Docker Buildx
33+
uses: docker/setup-buildx-action@v3
2034

21-
- name: Login to GHCR
22-
uses: docker/login-action@v3
23-
with:
24-
registry: ghcr.io
25-
username: ${{ github.actor }}
26-
password: ${{ secrets.GITHUB_TOKEN }}
35+
- name: Login to Docker Hub
36+
uses: docker/login-action@v3
37+
with:
38+
username: ${{ secrets.DOCKER_HUB_USERNAME }}
39+
password: ${{ secrets.DOCKER_HUB_TOKEN }}
2740

28-
- name: Docker meta
29-
id: meta
30-
uses: docker/metadata-action@v5
31-
with:
32-
images: ghcr.io/${{ github.repository }}
41+
- name: Login to GHCR
42+
uses: docker/login-action@v3
43+
with:
44+
registry: ghcr.io
45+
username: ${{ github.repository_owner }}
46+
password: ${{ secrets.GITHUB_TOKEN }}
3347

34-
- name: Build and push Docker image
35-
uses: docker/build-push-action@v6
36-
with:
37-
context: .
38-
push: ${{ github.event_name != 'pull_request' }}
39-
platforms: linux/amd64, linux/arm64/v8, linux/arm/v7, linux/arm/v6, linux/386
40-
tags: ${{ steps.meta.outputs.tags }}
41-
labels: ${{ steps.meta.outputs.labels }}
48+
- name: Build and push Docker image
49+
uses: docker/build-push-action@v6
50+
with:
51+
context: .
52+
push: true
53+
platforms: linux/amd64, linux/arm64/v8, linux/arm/v7, linux/arm/v6, linux/386
54+
tags: ${{ steps.meta.outputs.tags }}
55+
labels: ${{ steps.meta.outputs.labels }}

.github/workflows/release.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
name: Release 3X-UI
22

33
on:
4+
workflow_dispatch:
45
push:
56
tags:
6-
- "*"
7-
workflow_dispatch:
7+
- "v*.*.*"
88

99
jobs:
1010
build:
@@ -83,7 +83,7 @@ jobs:
8383
cd x-ui/bin
8484
8585
# Download dependencies
86-
Xray_URL="https://github.com/XTLS/Xray-core/releases/download/v24.9.30/"
86+
Xray_URL="https://github.com/XTLS/Xray-core/releases/download/v24.10.16/"
8787
if [ "${{ matrix.platform }}" == "amd64" ]; then
8888
wget ${Xray_URL}Xray-linux-64.zip
8989
unzip Xray-linux-64.zip

DockerInit.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ case $1 in
2727
esac
2828
mkdir -p build/bin
2929
cd build/bin
30-
wget "https://github.com/XTLS/Xray-core/releases/download/v24.9.30/Xray-linux-${ARCH}.zip"
30+
wget "https://github.com/XTLS/Xray-core/releases/download/v24.10.16/Xray-linux-${ARCH}.zip"
3131
unzip "Xray-linux-${ARCH}.zip"
3232
rm -f "Xray-linux-${ARCH}.zip" geoip.dat geosite.dat
3333
mv xray "xray-linux-${FNAME}"

README.es_ES.md

Lines changed: 40 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -28,38 +28,62 @@
2828
bash <(curl -Ls https://raw.githubusercontent.com/xeefei/3x-ui/master/install.sh)
2929
```
3030

31-
## Instalar una Versión Personalizada
31+
## Instalar versión antigua (no recomendamos)
3232

33-
Para instalar la versión deseada, agrega la versión al final del comando de instalación. Por ejemplo, ver `v2.4.3`:
33+
Para instalar la versión deseada, utiliza el siguiente comando de instalación. Por ejemplo, ver `v1.7.9`:
3434

3535
```
36-
bash <(curl -Ls https://raw.githubusercontent.com/xeefei/3x-ui/master/install.sh) v2.4.3
36+
VERSION=v1.7.9 && <(curl -Ls "https://raw.githubusercontent.com/xeefei/3x-ui/$VERSION/install.sh") $VERSION
3737
```
3838

3939
## Certificado SSL
4040

4141
<details>
42-
<summary>Haz clic para el Certificado SSL</summary>
42+
<summary>Haga clic para ver los detalles del certificado SSL</summary>
4343

44-
### Cloudflare
45-
46-
El script de gestión tiene una aplicación de certificado SSL incorporada para Cloudflare. Para usar este script para colocar un certificado, necesitas lo siguiente:
44+
### ACME
4745

48-
- Correo electrónico registrado en Cloudflare
49-
- Clave Global de API de Cloudflare
50-
- El nombre de dominio se ha resuelto en el servidor actual a través de Cloudflare
46+
Para gestionar certificados SSL utilizando ACME:
5147

52-
**1:** Ejecuta el comando`x-ui`en la terminal, luego elige `Certificado SSL de Cloudflare`.
48+
1. Asegúrate de que tu dominio esté correctamente resuelto al servidor.
49+
2. Ejecuta el comando `x-ui` en la terminal y elige `Gestión de Certificados SSL`.
50+
3. Se te presentarán las siguientes opciones:
5351

52+
- **Get SSL:** Obtener certificados SSL.
53+
- **Revoke:** Revocar certificados SSL existentes.
54+
- **Force Renew:** Forzar la renovación de certificados SSL.
55+
- **Show Existing Domains:** Mostrar todos los certificados de dominio disponibles en el servidor.
56+
- **Set Certificate Paths for the Panel:** Especificar el certificado para tu dominio que será utilizado por el panel.
5457

5558
### Certbot
56-
```
59+
60+
Para instalar y usar Certbot:
61+
62+
```sh
5763
apt-get install certbot -y
5864
certbot certonly --standalone --agree-tos --register-unsafely-without-email -d yourdomain.com
5965
certbot renew --dry-run
6066
```
6167

62-
***Consejo:*** *Certbot también está integrado en el script de gestión. Puedes ejecutar el comando `x-ui` , luego elegir `Gestión de Certificados SSL`.*
68+
### Cloudflare
69+
70+
El script de gestión incluye una aplicación de certificado SSL integrada para Cloudflare. Para usar este script para solicitar un certificado, necesitas lo siguiente:
71+
72+
- Correo electrónico registrado en Cloudflare
73+
- Clave API Global de Cloudflare
74+
- El nombre de dominio debe estar resuelto al servidor actual a través de Cloudflare
75+
76+
**Cómo obtener la Clave API Global de Cloudflare:**
77+
78+
1. Ejecuta el comando `x-ui` en la terminal y elige `Certificado SSL de Cloudflare`.
79+
2. Visita el enlace: [Tokens de API de Cloudflare](https://dash.cloudflare.com/profile/api-tokens).
80+
3. Haz clic en "Ver Clave API Global" (consulta la captura de pantalla a continuación):
81+
![](media/APIKey1.PNG)
82+
4. Es posible que necesites volver a autenticar tu cuenta. Después de eso, se mostrará la Clave API (consulta la captura de pantalla a continuación):
83+
![](media/APIKey2.png)
84+
85+
Al utilizarlo, simplemente ingresa tu `nombre de dominio`, `correo electrónico` y `CLAVE API`. El diagrama es el siguiente:
86+
![](media/DetailEnter.png)
6387

6488
</details>
6589

@@ -181,6 +205,7 @@ eliminar 3x-ui de docker
181205
- Ubuntu 20.04+
182206
- Debian 11+
183207
- CentOS 8+
208+
- OpenEuler 22.03+
184209
- Fedora 36+
185210
- Arch Linux
186211
- Parch Linux
@@ -421,6 +446,7 @@ Ingresa el ID de chat de usuario en el campo de entrada número 4. Las cuentas d
421446

422447
#### Uso
423448

449+
- [Documentación de API](https://documenter.getpostman.com/view/5146551/2sAXxP8Y12)
424450
- `/login` con `POST` datos de usuario: `{username: '', password: ''}` para iniciar sesión
425451
- `/panel/api/inbounds` base para las siguientes acciones:
426452

@@ -450,9 +476,7 @@ Ingresa el ID de chat de usuario en el campo de entrada número 4. Las cuentas d
450476
- `client.password` para TROJAN
451477
- `client.email` para Shadowsocks
452478

453-
454-
- [Documentación de API](https://documenter.getpostman.com/view/16802678/2s9YkgD5jm)
455-
- [<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://app.getpostman.com/run-collection/16802678-1a4c9270-ac77-40ed-959a-7aa56dc4a415?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D16802678-1a4c9270-ac77-40ed-959a-7aa56dc4a415%26entityType%3Dcollection%26workspaceId%3D2cd38c01-c851-4a15-a972-f181c23359d9)
479+
- [<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/5146551-e6aac565-e0e2-46df-acff-2607a51bbd04?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D5146551-e6aac565-e0e2-46df-acff-2607a51bbd04%26entityType%3Dcollection%26workspaceId%3Dd64f609f-485a-4951-9b8f-876b3f917124)
456480
</details>
457481

458482
## Variables de Entorno

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,13 +112,13 @@ apt update -y&&apt install -y curl&&apt install -y socat
112112
- 在到这一步必须要注意:要保留旧设置的话,需要输入【n】
113113
![11](./media/11.png)
114114

115-
------------
115+
116116
## 安装指定版本
117117

118-
若要安装指定的版本,请将该版本添加到安装命令的末尾。 e.g., ver `v2.4.3`:
118+
若要安装指定的版本,请使用以下安装命令。 e.g., ver `v2.4.5`:
119119

120120
```
121-
bash <(curl -Ls https://raw.githubusercontent.com/xeefei/3x-ui/master/install.sh) v2.4.3
121+
VERSION=v2.4.5 && bash <(curl -Ls "https://raw.githubusercontent.com/xeefei/3x-ui/$VERSION/install.sh") $VERSION
122122
```
123123
------------
124124
## 若你的VPS默认有防火墙,请在安装完成之后放行指定端口
@@ -262,6 +262,9 @@ bash <(curl -Ls https://raw.githubusercontent.com/xeefei/3x-ui/master/install.sh
262262
- **获取证书** ----获取SSL证书
263263
- **吊销证书** ----吊销现有的SSL证书
264264
- **续签证书** ----强制续签SSL证书
265+
- **显示所有证书** ----显示服务器中所有能用的证书
266+
- **设置面板证书路径** ----指定面板要使用的证书
267+
265268

266269
### Certbot
267270

@@ -422,6 +425,7 @@ systemctl restart x-ui
422425
- Ubuntu 20.04+
423426
- Debian 11+
424427
- CentOS 8+
428+
- OpenEuler 22.03+
425429
- Fedora 36+
426430
- Arch Linux
427431
- Manjaro
@@ -454,10 +458,11 @@ systemctl restart x-ui
454458

455459
------------
456460
## Languages
457-
461+
458462
- English(英语)
459463
- Farsi(伊朗语)
460-
- Chinese(中文)
464+
- Simplified Chinese(简体中文)
465+
- Traditional Chinese(繁体中文)
461466
- Russian(俄语)
462467
- Vietnamese(越南语)
463468
- Spanish(西班牙语)
@@ -484,7 +489,6 @@ systemctl restart x-ui
484489
- 支持通过面板中提供的不同项目更改配置。
485490
- 支持从面板导出/导入数据库
486491

487-
------------
488492
## 默认面板设置
489493

490494
<details>
@@ -686,6 +690,7 @@ Web 面板通过 Telegram Bot 支持每日流量、面板登录、数据库备
686690
- `client.email` for Shadowsocks
687691

688692

693+
689694
- [API 文档](https://documenter.getpostman.com/view/16802678/2s9YkgD5jm)
690695

691696
- [<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://app.getpostman.com/run-collection/16802678-1a4c9270-ac77-40ed-959a-7aa56dc4a415?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D16802678-1a4c9270-ac77-40ed-959a-7aa56dc4a415%26entityType%3Dcollection%26workspaceId%3D2cd38c01-c851-4a15-a972-f181c23359d9)

README.ru_RU.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@
2828
bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh)
2929
```
3030

31-
## Установка определённой версии
31+
## Установить старую версию (мы не рекомендуем)
3232

33-
Чтобы установить нужную вам версию, добавьте номер версии в конец команды установки. Например, `v2.4.3`:
33+
Чтобы установить желаемую версию, используйте следующую команду установки. Например, ver `v1.7.9`:
3434

3535
```
36-
bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v2.4.3
36+
VERSION=v1.7.9 && <(curl -Ls "https://raw.githubusercontent.com/mhsanaei/3x-ui/$VERSION/install.sh") $VERSION
3737
```
3838

3939
## SSL Сертификат
@@ -52,6 +52,8 @@ bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.
5252
- **Get SSL:** Получить SSL сертификаты.
5353
- **Revoke:** Отозвать существующие SSL сертификаты.
5454
- **Force Renew:** Принудительно перевыпустить SSL сертификаты.
55+
- **Show Existing Domains:** Отобразить все сертификаты доменов, доступные на сервере.
56+
- **Set Certificate Paths for the Panel:** Укажите сертификат для вашего домена, который будет использоваться панелью.
5557

5658
### Certbot
5759

@@ -242,6 +244,7 @@ location /sub {
242244
- Ubuntu 20.04+
243245
- Debian 11+
244246
- CentOS 8+
247+
- OpenEuler 22.03+
245248
- Fedora 36+
246249
- Arch Linux
247250
- Parch Linux
@@ -476,6 +479,7 @@ WARP встроен, и дополнительная установка не т
476479

477480
#### Использование
478481

482+
- [API документация](https://documenter.getpostman.com/view/5146551/2sAXxP8Y12)
479483
- `/login` с `POST`-данными: `{username: '', password: ''}` для входа
480484
- `/panel/api/inbounds` это базовый путь для следующих действий:
481485

@@ -509,8 +513,7 @@ WARP встроен, и дополнительная установка не т
509513
</details>
510514
511515
512-
- [API-документация](https://documenter.getpostman.com/view/16802678/2s9YkgD5jm)
513-
- [<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://app.getpostman.com/run-collection/16802678-1a4c9270-ac77-40ed-959a-7aa56dc4a415?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D16802678-1a4c9270-ac77-40ed-959a-7aa56dc4a415%26entityType%3Dcollection%26workspaceId%3D2cd38c01-c851-4a15-a972-f181c23359d9)
516+
- [<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/5146551-e6aac565-e0e2-46df-acff-2607a51bbd04?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D5146551-e6aac565-e0e2-46df-acff-2607a51bbd04%26entityType%3Dcollection%26workspaceId%3Dd64f609f-485a-4951-9b8f-876b3f917124)
514517
</details>
515518
516519
## Переменные среды

README.zh_CN.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@
2828
bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh)
2929
```
3030

31-
## 安装指定版本
31+
## 安装旧版本 (我们不建议)
3232

33-
要安装所需的版本,请将该版本添加到安装命令的末尾。 e.g., ver `v2.4.3`:
33+
要安装您想要的版本,请使用以下安装命令。例如,ver `v1.7.9`:
3434

3535
```
36-
bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v2.4.3
36+
VERSION=v1.7.9 && <(curl -Ls "https://raw.githubusercontent.com/mhsanaei/3x-ui/$VERSION/install.sh") $VERSION
3737
```
3838

3939
### SSL证书
@@ -49,9 +49,11 @@ bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.
4949
2. 在终端中运行 `x-ui` 命令,然后选择 `SSL证书管理`
5050
3. 您将看到以下选项:
5151

52-
- **获取SSL证书:** 获取SSL证书。
53-
- **吊销:** 吊销现有的SSL证书。
54-
- **强制更新:** 强制更新SSL证书。
52+
- **Get SSL:** 获取SSL证书。
53+
- **Revoke:** 吊销现有的SSL证书。
54+
- **Force Renew:** 强制更新SSL证书。
55+
- **Show Existing Domains:** 显示服务器上所有可用的域证书。
56+
- **Set Certificate Paths for the Panel:** 指定用于面板的域证书。
5557

5658
### Certbot
5759

@@ -239,6 +241,7 @@ location /sub {
239241
- Ubuntu 20.04+
240242
- Debian 11+
241243
- CentOS 8+
244+
- OpenEuler 22.03+
242245
- Fedora 36+
243246
- Arch Linux
244247
- Parch Linux
@@ -471,6 +474,7 @@ Web 面板通过 Telegram Bot 支持每日流量、面板登录、数据库备
471474

472475
#### 使用
473476

477+
- [API 文档](https://documenter.getpostman.com/view/5146551/2sAXxP8Y12)
474478
- `/login` 使用 `POST` 用户名称 & 密码: `{username: '', password: ''}` 登录
475479
- `/panel/api/inbounds` 以下操作的基础:
476480

@@ -500,9 +504,7 @@ Web 面板通过 Telegram Bot 支持每日流量、面板登录、数据库备
500504
- `client.password` TROJAN
501505
- `client.email` Shadowsocks
502506

503-
504-
- [API 文档](https://documenter.getpostman.com/view/16802678/2s9YkgD5jm)
505-
- [<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://app.getpostman.com/run-collection/16802678-1a4c9270-ac77-40ed-959a-7aa56dc4a415?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D16802678-1a4c9270-ac77-40ed-959a-7aa56dc4a415%26entityType%3Dcollection%26workspaceId%3D2cd38c01-c851-4a15-a972-f181c23359d9)
507+
- [<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/5146551-e6aac565-e0e2-46df-acff-2607a51bbd04?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D5146551-e6aac565-e0e2-46df-acff-2607a51bbd04%26entityType%3Dcollection%26workspaceId%3Dd64f609f-485a-4951-9b8f-876b3f917124)
506508
</details>
507509

508510
## 环境变量

config/version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.4.3
1+
2.4.5

0 commit comments

Comments
 (0)