Merge branch 'master' of github.com:XrayR-project/XrayR-doc

Ethan-Yami · Jun 3, 2021 · bfa2165 · bfa2165
2 parents 6161347 + 358cac9
commit bfa2165
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/config/README.md b/config/README.md
@@ -113,7 +113,7 @@ Nodes:
       Timeout: 30 # Timeout for the api request, Default is 5 sec
       EnableVless: false # Enable Vless for V2ray Type
       EnableXTLS: false # Enable XTLS for V2ray and Trojan
-      SpeedLimit: 0 # Local settings will replace remote settings, 0 means disable
+      SpeedLimit: 0 # Mbps, Local settings will replace remote settings, 0 means disable
       DeviceLimit: 0 # Local settings will replace remote settings, 0 means disable
       RuleListPath: # ./rulelist Path to local rulelist file
     ControllerConfig:
@@ -189,7 +189,7 @@ ApiConfig:
 | `Timeout`      | 无                             | 设定单次访问API超时时间，默认5秒                 |
 | `EnableVless`  | `true`,`false`                 | 是否给V2ray启用Vless协议                         |
 | `EnableXTLS`   | `true`,`false`                 | 是否使用XTLS                                     |
-| `SpeedLimit`   | float                          | 本地限速设置，会覆盖远程设置，0为不启用          |
+| `SpeedLimit`   | float                          | 单位Mbps, 本地限速设置，会覆盖远程设置，0为不启用   |
 | `DeviceLimit`  | int                            | 本地设备限制，会覆盖远程设置，0为不启用          |
 | `RuleListPath` | 无                             | 本地规则设置，指定本地规则文件路径，规则文件格式 |
 #### 后端相关配置
@@ -228,4 +228,4 @@ CertConfig:
 | `CertFile`   | 无                         | 手动指定的证书路径                                                                                                                                                                  |
 | `KeyFile`    | 无                         | 手动指定的私钥路径                                                                                                                                                                  |
 | `Provider`   | 无                         | dns提供商，所有支持的dns提供商请在此获取：https://go-acme.github.io/lego/dns/                                                                                                       |
-| `DNSEnv`     | 无                         | 采用DNS申请证书需要的环境变量，请参考上文链接内，自己的dns提供商所需要的参数，填写于此。请注意一行一个，填写时需符合yaml文件格式。                                                  |
+| `DNSEnv`     | 无                         | 采用DNS申请证书需要的环境变量，请参考上文链接内，自己的dns提供商所需要的参数，填写于此。请注意一行一个，填写时需符合yaml文件格式。                                                  |
diff --git a/functions/rule.md b/functions/rule.md
@@ -10,8 +10,10 @@ RuleListPath`设置本地规则文件路径。规则文件不需要定义文件
 配置文件详见：[配置文件说明](../config/README.md)
 
 **本地规则文件示例**
+
+请保证每行只是一个单纯的正则规则，不要包含任何其无关他字符串。
 ```
 (.+\.|^)(360|so)\.(cn|com)
 baidu.com
 google.com
-```
+```
diff --git a/functions/speedlimit.md b/functions/speedlimit.md
@@ -1,7 +1,7 @@
 # 限速功能说明
 
-1. 节点限速：请在SSpanel的节点限速处填写，单位mbps。
-2. 用户限速：请在SSpanel的用户设置处填写，单位mbps。
+1. 节点限速：请在SSpanel的节点限速处填写，单位Mbps。
+2. 用户限速：请在SSpanel的用户设置处填写，单位Mbps。
 3. 限速值设为0，则为不限速。
 
 ## 本地节点限速设置