mirror of
https://github.com/remnawave/panel.git
synced 2026-04-24 00:31:35 +00:00
Update the Chinese translation of the documentation. (#285)
* Update AUTH_METHODS_YANDEX.md * Update AUTH_METHODS_GITHUB.md * Update AUTH_METHODS_PASSWORD.md * Update AUTH_METHODS_POCKETID.md * Update AUTH_METHODS_TELEGRAM.md * Update PAGE_CONFIG_PROFILES.md
This commit is contained in:
avsba001
@@ -1,19 +1,21 @@
|
||||
## OAuth2: GitHub
|
||||
## OAuth2：GitHub
|
||||
|
||||
### Creating an OAuth Application
|
||||
### 创建 OAuth 应用
|
||||
|
||||
First, you need to create an OAuth application.
|
||||
Follow the link to create an application: [https://github.com/settings/applications/new](https://github.com/settings/applications/new)
|
||||
首先，你需要创建一个 OAuth 应用。
|
||||
请通过以下链接创建应用：
|
||||
[https://github.com/settings/applications/new](https://github.com/settings/applications/new)
|
||||
|
||||
In the `Authorization callback URL` field, enter the address of your panel.
|
||||
在 `Authorization callback URL` 字段中，填写你的面板地址。
|
||||
|
||||
```bash
|
||||
# Replace YOUR_PANEL_DOMAIN with your panel address
|
||||
# 将 YOUR_PANEL_DOMAIN 替换为你的面板地址
|
||||
https://YOUR_PANEL_DOMAIN/oauth2/callback/github
|
||||
```
|
||||
|
||||
Don't forget to replace `YOUR_PANEL_DOMAIN` with the correct panel address.
|
||||
请务必将 `YOUR_PANEL_DOMAIN` 替换为正确的面板域名。
|
||||
|
||||
### OAuth2 Settings in Remnawave
|
||||
### Remnawave 中的 OAuth2 设置
|
||||
|
||||
After creating the OAuth2 application – copy the `Client ID` and `Client Secret`. Insert this data in the corresponding section. And below, enter the list of email addresses for which login will be allowed.
|
||||
创建 OAuth2 应用后，复制生成的 `Client ID` 和 `Client Secret`，并将它们填写到对应的配置项中。
|
||||
然后，在下方填写允许登录的邮箱地址列表。
|
||||
|
||||
@@ -1,21 +1,22 @@
|
||||
## Authentication Method: Password
|
||||
## 认证方式: 密码
|
||||
|
||||
### Changing or Resetting Password
|
||||
### 修改或重置密码
|
||||
|
||||
Use `Rescue CLI` to reset or change the password.
|
||||
使用 `Rescue CLI` 来重置或修改密码。
|
||||
|
||||
```bash
|
||||
docker exec -it remnawave remnawave
|
||||
```
|
||||
|
||||
After entering `Rescue CLI`, select the `Reset superadmin` option.
|
||||
进入 `Rescue CLI` 后，选择 `Reset superadmin` 选项。
|
||||
|
||||
### Emergency Password Authentication Enable
|
||||
### 启用紧急密码认证
|
||||
|
||||
If you have disabled the "Password" authentication method but later lost access to one of the other authentication methods – you can enable the "Password" authentication method using `Rescue CLI`
|
||||
如果你已禁用“Password”认证方式，但之后又无法通过其他认证方式登录，
|
||||
可以使用 `Rescue CLI` 重新启用“Password”认证方式。
|
||||
|
||||
```bash
|
||||
docker exec -it remnawave remnawave
|
||||
```
|
||||
|
||||
After entering `Rescue CLI`, select the `Enable password authentication` option.
|
||||
进入 `Rescue CLI` 后，选择 `Enable password authentication` 选项。
|
||||
|
||||
@@ -1,25 +1,29 @@
|
||||
## OAuth2: PocketID
|
||||
## OAuth2：PocketID
|
||||
|
||||
### Creating an OIDC Client
|
||||
### 创建 OIDC 客户端
|
||||
|
||||
Log in to the PocketID admin panel and navigate to: `Settings` → `OIDC Clients` → `Add OIDC Client`
|
||||
登录 PocketID 管理面板，并前往：
|
||||
`Settings` → `OIDC Clients` → `Add OIDC Client`
|
||||
|
||||
```
|
||||
# Replace YOUR_PANEL_DOMAIN with your Remnawave panel address
|
||||
# 将 YOUR_PANEL_DOMAIN 替换为你的 Remnawave 面板地址
|
||||
https://YOUR_PANEL_DOMAIN/oauth2/callback/pocketid
|
||||
```
|
||||
|
||||
### OAuth2 Settings in Remnawave
|
||||
### Remnawave 中的 OAuth2 设置
|
||||
|
||||
After creating the OAuth2 application – copy the `Client ID` and `Client Secret`. Insert this data in the corresponding section. And below, enter the list of email addresses for which login will be allowed.
|
||||
创建 OAuth2 应用后，复制生成的 `Client ID` 和 `Client Secret`，
|
||||
并将其填写到对应的配置项中。
|
||||
然后，在下方填写允许登录的邮箱地址列表。
|
||||
|
||||
In the `Plain Domain` field, enter the domain address where your PocketID is located.
|
||||
Just enter the domain name – without the path and `https://`, for example: `pocketid.your-domain.com`
|
||||
在 `Plain Domain` 字段中，填写你的 PocketID 所在的域名。
|
||||
只需要填写域名本身，不要包含路径和 `https://`，例如：
|
||||
`pocketid.your-domain.com`
|
||||
|
||||
### Custom Claims (v2.4.0+)
|
||||
### 自定义声明（Custom Claims，v2.4.0+）
|
||||
|
||||
Remnawave also supports authorization using Custom Claims.
|
||||
When using this method, you do not need to specify an array of email addresses.
|
||||
Remnawave 也支持通过自定义声明进行授权。
|
||||
使用此方式时，无需再配置允许的邮箱地址列表。
|
||||
|
||||
Key
|
||||
|
||||
@@ -33,4 +37,4 @@ Value
|
||||
true
|
||||
```
|
||||
|
||||
Accordingly, if a user has this key (`remnawaveAccess: true`) in their token, they will be authorized.
|
||||
只要用户的令牌中包含该键值对（`remnawaveAccess: true`），即可通过授权。
|
||||
|
||||
@@ -1,39 +1,46 @@
|
||||
## Telegram OAuth2
|
||||
|
||||
To configure the "Login via Telegram" feature, you need a Telegram bot. Additionally, you need to configure the bot for the feature to work correctly.
|
||||
### 配置 Telegram 登录
|
||||
|
||||
### Bot Configuration
|
||||
要使用“通过 Telegram 登录”功能，你需要先创建一个 Telegram 机器人。
|
||||
此外，还需要对该机器人进行正确配置，功能才能正常使用。
|
||||
|
||||
1. Open @BotFather (https://t.me/botfather)
|
||||
### 机器人配置
|
||||
|
||||
2. Send the `/mybots` command and select the required bot
|
||||
1. 打开 @BotFather（https://t.me/botfather）
|
||||
|
||||
3. Select the option `Bot settings` → `Domain`
|
||||
2. 发送 `/mybots` 命令，并选择对应的机器人
|
||||
|
||||
4. Select the option `Set domain`
|
||||
3. 选择 `Bot settings` → `Domain`
|
||||
|
||||
Now send the bot a message containing the domain name used to access Remnawave.
|
||||
4. 选择 `Set domain`
|
||||
|
||||
然后向机器人发送用于访问 Remnawave 的域名，例如：
|
||||
|
||||
```
|
||||
https://panel.domain.com
|
||||
```
|
||||
|
||||
### Access Configuration
|
||||
### 访问权限配置
|
||||
|
||||
After entering the bot token, you need to specify a list of administrator IDs who will have access to login.
|
||||
在填写完机器人 Token 后，需要指定允许登录的管理员 ID 列表。
|
||||
|
||||
1. From the required account, launch the bot – https://t.me/Get_myidrobot
|
||||
2. In response, the bot will send you your ID, enter it in the corresponding field.
|
||||
1. 使用对应账号打开机器人：https://t.me/Get_myidrobot
|
||||
2. 机器人会返回你的用户 ID，将该 ID 填入对应的配置项中。
|
||||
|
||||
---
|
||||
|
||||
### Known Error Solutions
|
||||
### 常见错误说明
|
||||
|
||||
###### Error: BOT_DOMAIN_INVALID
|
||||
#### 错误：BOT_DOMAIN_INVALID
|
||||
|
||||
This error occurs due to incorrect bot domain configuration – review the "Bot Configuration" section (above). If necessary, repeat this step-by-step process.
|
||||
该错误通常由机器人域名配置不正确导致。
|
||||
请重新检查并按照「机器人配置」部分的步骤重新设置。
|
||||
|
||||
###### Error: Telegram confirmation code not received during login
|
||||
#### 错误：登录时未收到 Telegram 验证码
|
||||
|
||||
Unfortunately, this issue cannot be resolved from the Remnawave side. Try using a bot that was created a while ago or use a different browser.
|
||||
Alternatively, you can try logging in on one of the "official" resources – for example, https://fragment.com. Since the Telegram session within the browser will be shared – you can try logging into the panel.
|
||||
该问题无法通过 Remnawave 本身解决。
|
||||
建议使用较早创建的 Telegram 机器人，或更换浏览器重试。
|
||||
|
||||
另外，也可以尝试先登录 Telegram 官方站点（例如 https://fragment.com），
|
||||
因为浏览器中的 Telegram 会话是共享的，然后再尝试登录面板。
|
||||
|
||||
@@ -1,20 +1,20 @@
|
||||
## OAuth2: Yandex
|
||||
## OAuth2：Yandex
|
||||
|
||||
The Yandex authentication method is not recommended for use.
|
||||
不推荐使用 Yandex 的身份验证方式。
|
||||
|
||||
### Creating an OAuth Application
|
||||
### 创建 OAuth 应用
|
||||
|
||||
You need to create an OAuth application in Yandex.
|
||||
你需要在 Yandex 中创建一个 OAuth 应用。
|
||||
|
||||
Follow the link to create an application: https://oauth.yandex.com/client/new
|
||||
点击此链接创建应用： [https://oauth.yandex.com/client/new](https://oauth.yandex.com/client/new)
|
||||
|
||||
On the second step of application creation, select the "Web application" option and enter the `Callback URL`
|
||||
在创建应用的第二步中，选择 “Web application”（网页应用）选项，并填写 `Callback URL`
|
||||
|
||||
```
|
||||
# Replace YOUR_PANEL_DOMAIN with your Remnawave panel address
|
||||
# 将 YOUR_PANEL_DOMAIN 替换为你的 Remnawave 面板地址
|
||||
https://YOUR_PANEL_DOMAIN/oauth2/callback/yandex
|
||||
```
|
||||
|
||||
Don't forget to replace `YOUR_PANEL_DOMAIN` with the correct panel address.
|
||||
别忘了将 `YOUR_PANEL_DOMAIN` 替换为正确的面板域名。
|
||||
|
||||
On the third step of creation – make sure to check the box next to `Access to email address`, no other permissions are required.
|
||||
在创建的第三步中 —— 请确保勾选 “Access to email address”（访问邮箱地址），不需要其他权限。
|
||||
|
||||
@@ -66,13 +66,14 @@ _如果你想添加一个新的入站（例如使用 **VLESS** 协议），只
|
||||
|
||||
关于片段的更多信息，可以点击片段菜单中的问号图标查看说明。
|
||||
|
||||
### Flow Control (VLESS)
|
||||
### 流控（Flow Control / VLESS）
|
||||
|
||||
_This feature is available only in version 2.3.0 and above._
|
||||
_该功能仅在 2.3.0 及以上版本中可用。_
|
||||
|
||||
By default, Remnawave automatically adds the `flow` parameter for the following configurations: VLESS+TLS, REALITY+RAW, or TCP.
|
||||
默认情况下，Remnawave 会自动为以下配置添加 `flow` 参数：
|
||||
VLESS + TLS、REALITY + RAW 或 TCP。
|
||||
|
||||
If you wish to override this behavior, add the `flow` field to the `settings` object.
|
||||
如果你希望手动覆盖这一默认行为，可以在 `settings` 对象中显式指定 `flow` 字段。
|
||||
|
||||
```json
|
||||
"settings": {
|
||||
@@ -82,7 +83,7 @@ If you wish to override this behavior, add the `flow` field to the `settings` ob
|
||||
},
|
||||
```
|
||||
|
||||
Available values for `flow`:
|
||||
可用的 `flow` 值如下：
|
||||
|
||||
- `xtls-rprx-vision`
|
||||
- `""`
|
||||
|
||||
Reference in New Issue
Block a user