Alex-Devera/3x-ui
1
0
Fork 0
mirror of https://github.com/MHSanaei/3x-ui.git synced 2025-04-19 13:32:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

update readme

Browse source
This commit is contained in:
mhsanaei 2024-09-09 10:31:55 +02:00
parent 2e1461e6dc
commit 47987b7785
4 changed files with 153 additions and 129 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

106
README.es_ES.md
View file

@ -276,88 +276,100 @@ Nuestra plataforma ofrece compatibilidad con una amplia gama de arquitecturas y
- Soporta exportar/importar base de datos desde el panel - Soporta exportar/importar base de datos desde el panel
## Configuraciones por Defecto ## Configuración Predeterminada del Panel
<details> <details>
<summary>Haz clic para detalles de las configuraciones por defecto</summary> <summary>Haz clic para ver los detalles de la configuración predeterminada</summary>
### Información ### Nombre de Usuario & Contraseña & Ruta Base Web:
Estos se generarán aleatoriamente si no los modificas.
- **Puerto:** el puerto predeterminado para el panel es `2053`
### Gestión de la Base de Datos:
Puedes realizar copias de seguridad y restauraciones de la base de datos directamente desde el panel.
- **Puerto:** 2053
- **Usuario y Contraseña:** Se generarán aleatoriamente si omites la modificación.
- **Ruta de la Base de Datos:** - **Ruta de la Base de Datos:**
- /etc/x-ui/x-ui.db - `/etc/x-ui/x-ui.db`
- **Ruta de Configuración de Xray:**
- /usr/local/x-ui/bin/config.json ### Ruta Base Web
- **Ruta del Panel Web sin Implementar SSL:**
- http://ip:2053/panel 1. **Restablecer la Ruta Base Web:**
- http://domain:2053/panel - Abre tu terminal.
- **Ruta del Panel Web con Implementación de SSL:** - Ejecuta el comando `x-ui`.
- https://domain:2053/panel - Selecciona la opción `Restablecer la Ruta Base Web`.
2. **Generar o Personalizar la Ruta:**
- La ruta se generará aleatoriamente, o puedes ingresar una ruta personalizada.
3. **Ver Configuración Actual:**
- Para ver tu configuración actual, utiliza el comando `x-ui settings` en el terminal o selecciona `Ver Configuración Actual` en `x-ui`.
### Recomendación de Seguridad:
- Para mayor seguridad, utiliza una palabra larga y aleatoria en la estructura de tu URL.
**Ejemplos:**
- `http://ip:port/*webbasepath*/panel`
- `http://domain:port/*webbasepath*/panel`
</details> </details>
## Configuración WARP ## Configuración de WARP
<details> <details>
<summary>Haz clic para detalles de la configuración WARP</summary> <summary>Haz clic para ver los detalles de la configuración de WARP</summary>
#### Uso #### Uso
Si deseas usar enrutamiento a WARP antes de la versión v2.1.0, sigue los pasos a continuación: **Para versiones `v2.1.0` y posteriores:**
**1.** Instala WARP en **Modo de Proxy SOCKS**: WARP está integrado, no se requiere instalación adicional. Simplemente habilita la configuración necesaria en el panel.
```sh
bash <(curl -sSL https://raw.githubusercontent.com/hamid-gh98/x-ui-scripts/main/install_warp_proxy.sh)
```
**2.** Si ya instalaste warp, puedes desinstalarlo usando el siguiente comando:
```sh
warp u
```
**3.** Activa la configuración que necesites en el panel
Características de Configuración:
- Bloquear Anuncios
- Enrutar Google + Netflix + Spotify + OpenAI (ChatGPT) a WARP
- Corregir error 403 de Google
</details> </details>
## Límite de IP ## Límite de IP
<details> <details>
<summary>Haz clic para más detalles del límite de IP</summary> <summary>Haz clic para ver los detalles del límite de IP</summary>
#### Uso #### Uso
**Nota:** El Límite de IP no funcionará correctamente cuando se use IP Tunnel **Nota:** El Límite de IP no funcionará correctamente cuando uses Túnel IP.
- Para versiones hasta `v1.6.1`:
- **Para versiones hasta `v1.6.1`:**
- El límite de IP está integrado en el panel. - El límite de IP está integrado en el panel.
- Para versiones `v1.7.0` y posteriores: **Para versiones `v1.7.0` y posteriores:**
- Para que el Límite de IP funcione correctamente, necesitas instalar fail2ban y sus archivos requeridos siguiendo estos pasos: Para habilitar la funcionalidad de límite de IP, necesitas instalar `fail2ban` y los archivos requeridos siguiendo estos pasos:
1. Usa el comando `x-ui` dentro de la terminal. 1. Ejecuta el comando `x-ui` en el terminal, luego elige `Gestión de Límite de IP`.
2. Selecciona `Gestión de Límite de IP`. 2. Verás las siguientes opciones:
3. Elige las opciones apropiadas según tus necesidades.
- asegúrate de tener ./access.log en tu Configuración de Xray después de la v2.1.3 tenemos una opción para ello - **Cambiar la Duración del Bloqueo:** Ajustar la duración de los bloqueos.
- **Desbloquear a Todos:** Levantar todos los bloqueos actuales.
- **Revisar los Registros:** Revisar los registros.
- **Estado de Fail2ban:** Verificar el estado de `fail2ban`.
- **Reiniciar Fail2ban:** Reiniciar el servicio `fail2ban`.
- **Desinstalar Fail2ban:** Desinstalar Fail2ban con la configuración.
```sh 3. Agrega una ruta para el registro de acceso en el panel configurando `Xray Configs/log/Access log` a `./access.log`, luego guarda y reinicia Xray.
- **Para versiones anteriores a `v2.1.3`:**
- Necesitas configurar manualmente la ruta del registro de acceso en tu configuración de Xray:
```sh
"log": { "log": {
"access": "./access.log", "access": "./access.log",
"dnsLog": false, "dnsLog": false,
"loglevel": "warning" "loglevel": "warning"
}, },
``` ```
- **Para versiones `v2.1.3` y posteriores:**
- Hay una opción para configurar `access.log` directamente desde el panel.
</details> </details>

11
README.md
View file

@ -359,17 +359,6 @@ Our platform offers compatibility with a diverse range of architectures and devi
WARP is built-in, and no additional installation is required. Simply turn on the necessary configuration in the panel. WARP is built-in, and no additional installation is required. Simply turn on the necessary configuration in the panel.
**For versions before `v2.1.0`:**
1. Run the `x-ui` command in the terminal, then choose `WARP Management`.
2. You will see the following options:
- **Account Type (free, plus, team):** Choose the appropriate account type.
- **Enable/Disable WireProxy:** Toggle WireProxy on or off.
- **Uninstall WARP:** Remove the WARP application.
3. Configure the settings as needed in the panel.
</details> </details>
## IP Limit ## IP Limit

11
README.ru_RU.md
View file

@ -354,17 +354,6 @@ location /sub {
WARP встроен, и дополнительная установка не требуется. Просто включите необходимую конфигурацию в панели. WARP встроен, и дополнительная установка не требуется. Просто включите необходимую конфигурацию в панели.
**Для версий до `v2.1.0`:**
1. Выполните команду `x-ui` в терминале, затем выберите `WARP Management`.
2. Вам будут предложены следующие опции:
- **Account Type (free, plus, team):** Выбрать соответствующий тип учетной записи.
- **Enable/Disable WireProxy:** Включить или отключить WireProxy.
- **Uninstall WARP:** Удалить приложение WARP.
3. Настройте параметры по мере необходимости в панели.
</details> </details>
## Ограничение IP ## Ограничение IP

154
README.zh_CN.md
View file

@ -38,30 +38,52 @@ bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.
bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v2.3.15 bash <(curl -Ls https://raw.githubusercontent.com/mhsanaei/3x-ui/master/install.sh) v2.3.15
``` ```
## SSL 认证 ### SSL证书
<details> <details>
<summary>点击查看 SSL 认证</summary> <summary>点击查看SSL证书详情</summary>
### Cloudflare ### ACME
管理脚本具有用于 Cloudflare 的内置 SSL 证书应用程序。若要使用此脚本申请证书，需要满足以下条件： 使用ACME管理SSL证书：
- Cloudflare 邮箱地址 1. 确保您的域名正确解析到服务器。
- Cloudflare Global API Key 2. 在终端中运行 `x-ui` 命令，然后选择 `SSL证书管理`。
- 域名已通过 cloudflare 解析到当前服务器 3. 您将看到以下选项：
**1:** 在终端中运行`x-ui`， 选择 `Cloudflare SSL Certificate`.
- **获取SSL证书:** 获取SSL证书。
- **吊销:** 吊销现有的SSL证书。
- **强制更新:** 强制更新SSL证书。
### Certbot ### Certbot
```
安装并使用Certbot：
```sh
apt-get install certbot -y apt-get install certbot -y
certbot certonly --standalone --agree-tos --register-unsafely-without-email -d yourdomain.com certbot certonly --standalone --agree-tos --register-unsafely-without-email -d yourdomain.com
certbot renew --dry-run certbot renew --dry-run
``` ```
***Tip:*** *管理脚本具有 Certbot 。使用 `x-ui` 命令， 选择 `SSL Certificate Management`.* ### Cloudflare
管理脚本内置了Cloudflare的SSL证书申请。要使用此脚本申请证书，您需要以下信息：
- Cloudflare注册的电子邮件
- Cloudflare全局API密钥
- 域名必须通过Cloudflare解析到当前服务器
**如何获取Cloudflare全局API密钥：**
1. 在终端中运行 `x-ui` 命令，然后选择 `Cloudflare SSL证书`。
2. 访问链接：[Cloudflare API Tokens](https://dash.cloudflare.com/profile/api-tokens)。
3. 点击“查看全局API密钥”（参见下图）：
![](media/APIKey1.PNG)
4. 您可能需要重新验证您的账户。之后将显示API密钥（参见下图）：
![](media/APIKey2.png)
使用时，只需输入您的 `域名`、`电子邮件` 和 `API密钥`。如下图所示：
![](media/DetailEnter.png)
</details> </details>
@ -276,88 +298,100 @@ location /sub {
- 支持从面板导出/导入数据库 - 支持从面板导出/导入数据库
## 默认设置 ## 默认面板设置
<details> <details>
<summary>点击查看 默认设置</summary> <summary>点击查看默认设置详情</summary>
### 信息 ### 用户名 & 密码 & Web基础路径：
- **端口：** 2053 如果不修改这些，它们将会随机生成。
- **用户名 & 密码：** 当您跳过设置时，此项会随机生成。
- **数据库路径：** - **端口号:** 面板的默认端口号是 `2053`
- /etc/x-ui/x-ui.db
- **Xray 配置路径：** ### 数据库管理：
- /usr/local/x-ui/bin/config.json
- **面板链接（无SSL）：** 您可以直接在面板中方便地进行数据库备份和还原。
- http://ip:2053/panel
- http://domain:2053/panel - **数据库路径:**
- **面板链接（有SSL）：** - `/etc/x-ui/x-ui.db`
- https://domain:2053/panel
### Web 基础路径
1. **重置 Web 基础路径:**
- 打开终端。
- 运行 `x-ui` 命令。
- 选择 `重置 Web 基础路径` 选项。
2. **生成或自定义路径:**
- 路径将会随机生成，或者您可以输入自定义路径。
3. **查看当前设置:**
- 要查看当前设置，请在终端中使用 `x-ui settings` 命令，或在 `x-ui` 面板中点击 `查看当前设置`。
### 安全建议：
- 为了提高安全性，建议在URL结构中使用一个长的随机词。
**示例：**
- `http://ip:port/*webbasepath*/panel`
- `http://domain:port/*webbasepath*/panel`
</details> </details>
## WARP 配置 ## WARP 配置
<details> <details>
<summary>点击查看 WARP 配置</summary> <summary>点击查看 WARP 配置详情</summary>
#### 使用 #### 使用方法
如果要在 v2.1.0 之前使用 WARP 路由，请按照以下步骤操作： **对于 `v2.1.0` 及之后的版本：**
**1.** 在 **SOCKS Proxy Mode** 模式中安装Wrap WARP 已内置，无需额外安装。只需在面板中开启相关配置即可。
```sh
bash <(curl -sSL https://raw.githubusercontent.com/hamid-gh98/x-ui-scripts/main/install_warp_proxy.sh)
```
**2.** 如果您已经安装了 warp，您可以使用以下命令卸载：
```sh
warp u
```
**3.** 在面板中打开您需要的配置
配置:
- Block Ads
- Route Google + Netflix + Spotify + OpenAI (ChatGPT) to WARP
- Fix Google 403 error
</details> </details>
## IP 限制 ## IP 限制
<details> <details>
<summary>点击查看 IP 限制</summary> <summary>点击查看 IP 限制详情</summary>
#### 使用 #### 使用方法
**注意：** 使用 IP 隧道时，IP 限制无法正常工作。 **注意:** 当使用 IP 隧道时，IP 限制将无法正常工作。
- 适用于最高 `v1.6.1` ： - **对于 `v1.6.1` 及之前的版本：**
- IP 限制功能已内置于面板中。
- IP 限制 已被集成在面板中。 **对于 `v1.7.0` 及更新的版本：**
- 适用于 `v1.7.0` 以及更新的版本： 要启用 IP 限制功能，您需要安装 `fail2ban` 及其所需的文件，步骤如下：
- 要使 IP 限制正常工作，您需要按照以下步骤安装 fail2ban 及其所需的文件： 1. 在终端中运行 `x-ui` 命令，然后选择 `IP 限制管理`。
2. 您将看到以下选项：
1. 使用面板内置的 `x-ui` 指令 - **更改封禁时长:** 调整封禁时长。
2. 选择 `IP Limit Management`. - **解除所有封禁:** 解除当前的所有封禁。
3. 根据您的需要选择合适的选项。 - **查看日志:** 查看日志。
- **Fail2ban 状态:** 检查 `fail2ban` 的状态。
- **重启 Fail2ban:** 重启 `fail2ban` 服务。
- **卸载 Fail2ban:** 卸载带有配置的 Fail2ban。
- 确保您的 Xray 配置上有 ./access.log 。在 v2.1.3 之后，我们有一个选项。 3. 在面板中通过设置 `Xray 配置/log/访问日志` 为 `./access.log` 添加访问日志路径，然后保存并重启 Xray。
```sh - **对于 `v2.1.3` 之前的版本：**
- 您需要在 Xray 配置中手动设置访问日志路径：
```sh
"log": { "log": {
"access": "./access.log", "access": "./access.log",
"dnsLog": false, "dnsLog": false,
"loglevel": "warning" "loglevel": "warning"
}, },
``` ```
- **对于 `v2.1.3` 及之后的版本：**
- 面板中直接提供了配置 `access.log` 的选项。
</details> </details>