Update docs to v0.5.1

SUMMARY.md

@@ -22,7 +22,9 @@
 
 ## 功能说明
 * [限速功能说明](functions/speedlimit.md)
+* [设备连接限制功能说明](functions/devicelimit.md)
 * [自定义DNS说明](functions/dns.md)
 * [审计功能说明](functions/rule.md)
 * [自动申请证书说明](functions/cert.md)
 
+

config/README.md

@@ -111,8 +111,11 @@ Nodes:
       NodeID: 41
       NodeType: V2ray # Node type: V2ray, Shadowsocks, Trojan
       Timeout: 30 # Timeout for the api request, Default is 5 sec
-      EnableVless: false # Enable Vless for V2ray Type, Prefer remote configuration
-      EnableXTLS: false # Enable XTLS for V2ray and Trojan， Prefer remote configuration
+      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
+      DeviceLimit: 0 # Local settings will replace remote settings, 0 means disable
+      RuleListPath: # ./rulelist Path to local rulelist file
     ControllerConfig:
       ListenIP: 0.0.0.0 # IP address you want to listen
       UpdatePeriodic: 60 # Time to update the nodeinfo, how many sec.
@@ -135,8 +138,11 @@ Nodes:
       NodeID: 42
       NodeType: Trojan # Node type: V2ray, Shadowsocks, Trojan
       Timeout: 30 # Timeout for the api request
-      EnableVless: false # Enable Vless for V2ray Type, Prefer remote configuration
-      EnableXTLS: false # Enable XTLS for V2ray and Trojan， Prefer remote configuration
+      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
+      DeviceLimit: 0 # Local settings will replace remote settings, 0 means disable
+      RuleListPath: # ./rulelist Path to local rulelist file
     ControllerConfig:
       ListenIP: 0.0.0.0 # IP address you want to listen
       UpdatePeriodic: 60 # Time to update the nodeinfo, how many sec.
@@ -168,31 +174,36 @@ ApiConfig:
     NodeID: 41
     NodeType: V2ray # Node type: V2ray, Shadowsocks, Trojan
     Timeout: 30 # Timeout for the api request, Default is 5 sec
-    EnableVless: false # Enable Vless for V2ray Type, Prefer remote
-    EnableXTLS: false # Enable XTLS for V2ray and Trojan， Prefer remote configuration
+    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
+    DeviceLimit: 0 # Local settings will replace remote settings, 0 means disable
+    RuleListPath: # ./rulelist Path to local rulelist file
 ```
-| 参数          | 选项                           | 说明                                                          |
-| ------------- | ------------------------------ | ------------------------------------------------------------- |
-| `ApiHost`     | 无                             | 对接前端面板地址                                              |
-| `ApiKey`      | 无                             | 前端对接通讯秘钥                                              |
-| `NodeID`      | 无                             | 节点ID                                                        |
-| `NodeType`    | `V2ray`,`Shadowsocks`,`Trojan` | 节点类型                                                      |
-| `Timeout`     | 无                             | 设定单次访问API超时时间，默认5秒                              |
-| `EnableVless` | `true`,`false`                 | 是否给V2ray启用Vless协议，SSP面板会优先使用远端配置覆盖此选项 |
-| `EnableXTLS`  | `true`,`false`                 | 是否使用XTLS，SSP面板会优先使用远端配置覆盖此选项             |
-
+| 参数          | 选项                           | 说明                                    |
+| ------------- | ------------------------------ | --------------------------------------- |
+| `ApiHost`     | 无                             | 对接前端面板地址                        |
+| `ApiKey`      | 无                             | 前端对接通讯秘钥                        |
+| `NodeID`      | 无                             | 节点ID                                  |
+| `NodeType`    | `V2ray`,`Shadowsocks`,`Trojan` | 节点类型                                |
+| `Timeout`     | 无                             | 设定单次访问API超时时间，默认5秒        |
+| `EnableVless` | `true`,`false`                 | 是否给V2ray启用Vless协议                |
+| `EnableXTLS`  | `true`,`false`                 | 是否使用XTLS                            |
+| `SpeedLimit`  | float                          | 本地限速设置，会覆盖远程设置，0为不启用 |
+| `DeviceLimit` | int                            | 本地设备限制，会覆盖远程设置，0为不启用 |
+| `DeviceLimit` | 无                             | 本地规则设置，指定本地规则文件路径      |
 #### 后端相关配置
 ``` yaml
 ControllerConfig:
     ListenIP: 0.0.0.0 # IP address you want to listen
     UpdatePeriodic: 60 # Time to update the nodeinfo, how many sec.
     EnableDNS: false # Enable custom DNS config, Please ensure that you set the dns.json well
 ```
-| 参数         | 选项                                    | 说明                         |
-| ------------ | --------------------------------------- | ---------------------------- |
-| `ListenIP`      | 无| 选择监听的IP地址，`0.0.0.0`会同时监听v6和v4 |
-|`UpdatePeriodic`|无|从前端更新节点、用户信息和上报用户使用信息的间隔，默认60秒|
-|`EnableDNS`|`true`,`false`|是否为当前节点启用自定义DNS，默认使用系统DNS|
+| 参数             | 选项           | 说明                                                       |
+| ---------------- | -------------- | ---------------------------------------------------------- |
+| `ListenIP`       | 无             | 选择监听的IP地址，`0.0.0.0`会同时监听v6和v4                |
+| `UpdatePeriodic` | 无             | 从前端更新节点、用户信息和上报用户使用信息的间隔，默认60秒 |
+| `EnableDNS`      | `true`,`false` | 是否为当前节点启用自定义DNS，默认使用系统DNS               |
 
 #### 证书申请相关配置
 
@@ -210,11 +221,11 @@ CertConfig:
         ALICLOUD_ACCESS_KEY: aaa
         ALICLOUD_SECRET_KEY: bbb
 ```
-| 参数         | 选项                                    | 说明                         |
-| ------------ | --------------------------------------- | ---------------------------- |
-| `CertMode`      | `none`,`file`,`http`,`dns`| 获取证书的方式。`file`:手动提供，并制定路径。`http`：通过http申请，需要80端口。`dns`：使用dns模式申请，需要制定相关dns服务商配置。`none`：强制关闭tls设置，交由nginx或者caddy处理。|
-|`CertDomain`|无|申请证书域名|
-|`CertFile`|无|手动指定的证书路径|
-|`KeyFile`|无|手动指定的私钥路径|
-|`Provider`|无|dns提供商，所有支持的dns提供商请在此获取：https://go-acme.github.io/lego/dns/
-|`DNSEnv`|无|采用DNS申请证书需要的环境变量，请参考上文链接内，自己的dns提供商所需要的参数，填写于此。请注意一行一个，填写时需符合yaml文件格式。|
+| 参数         | 选项                       | 说明                                                                                                                                                                                |
+| ------------ | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `CertMode`   | `none`,`file`,`http`,`dns` | 获取证书的方式。`file`:手动提供，并制定路径。`http`：通过http申请，需要80端口。`dns`：使用dns模式申请，需要制定相关dns服务商配置。`none`：强制关闭tls设置，交由nginx或者caddy处理。 |
+| `CertDomain` | 无                         | 申请证书域名                                                                                                                                                                        |
+| `CertFile`   | 无                         | 手动指定的证书路径                                                                                                                                                                  |
+| `KeyFile`    | 无                         | 手动指定的私钥路径                                                                                                                                                                  |
+| `Provider`   | 无                         | dns提供商，所有支持的dns提供商请在此获取：https://go-acme.github.io/lego/dns/                                                                                                       |
+| `DNSEnv`     | 无                         | 采用DNS申请证书需要的环境变量，请参考上文链接内，自己的dns提供商所需要的参数，填写于此。请注意一行一个，填写时需符合yaml文件格式。                                                  |

functions/devicelimit.md

@@ -0,0 +1,7 @@
+# 设备连接限制说明
+
+由于大量面板不再支持远程设备限制指定，现增加本地设备限制参数。
+
+如需启用，可在配置文件中将`DeviceLimit`设为非0值，注意此设置会覆盖远程获取的用户设备限制数目。
+
+配置文件详见：[配置文件说明](../config/README.md)

functions/rule.md

@@ -1,3 +1,16 @@
 # 审计功能说明
 
-1. 请在前端审计规则处填写任意正则表达式，如 `baidu.com`将屏蔽所有baidu的域名。暂不支持bt协议的审计。
+1. 请在前端审计规则处填写任意正则表达式，如 `baidu.com`将屏蔽所有baidu的域名。暂不支持bt协议的审计。
+
+## 本地审计规则设置
+
+针对不支持远程设置审计规则的面板：如V2board，可以在本地配置文件`
+RuleListPath`设置本地规则文件路径。规则文件，每条规则一行，默认本地规则ID标号为-1。
+
+配置文件详见：[配置文件说明](../config/README.md)
+
+**本地规则文件示例**
+```
+baidu.com
+google.com
+```

functions/speedlimit.md

@@ -3,4 +3,9 @@
 1. 节点限速：请在SSpanel的节点限速处填写，单位mbps。
 2. 用户限速：请在SSpanel的用户设置处填写，单位mbps。
 3. 限速值设为0，则为不限速。
-4. V2board暂不支持限速。
+
+## 本地节点限速设置
+
+针对不支持远程设置限速的面板：如V2board，可以在本地配置文件`SpeedLimit`设置限速。注意此设置会覆盖远程获取的节点级别限速。
+
+配置文件详见：[配置文件说明](../config/README.md)

sspanel/trojan/README.md

@@ -17,8 +17,6 @@
 示例：gz.aaa.com;port=443#12345|host=hk.aaa.com
 ```
 ## 启用xtls **(此项为实验性功能)**
-在配置后增加`|enable_xtls=true`.
-```
-示例：gz.aaa.com;port=443#12345|host=hk.aaa.com|enable_xtls=true
-```
+在本地设置文件将`EnableXTLS`设为true。
+配置文件详见：[配置文件说明](../config/README.md)
 

sspanel/v2ray/README.md

@@ -8,7 +8,7 @@
 
 ## SSpanel-uim 节点地址格式
 ```
-IP;监听端口;alterId;(tcp或ws);(tls或xtls或不填);path=/xxx|host=xxxx.com|server=xxx.com|outside_port=xxx|enable_vless=(true或false)
+IP;监听端口;alterId;(tcp或ws);(tls或不填);path=/xxx|host=xxxx.com|server=xxx.com|outside_port=xxx
 ```
 alterId设为0，则自动启用VMessAEAD。
 ## TCP示例
@@ -48,13 +48,10 @@ XrayR没有`inside_port=xx`配置选项，如需监听本地端口，请在配
 ```
 ## 启用Vless **(此项为实验性功能)**
 
-在任一配置组合后增加`|enable_vless=true`.
-```
-示例：1.3.5.7;12345;2;tcp;tls;server=hk.domain.com|host=hk.domain.com|enable_vless=true
-```
+在本地设置文件将`EnableVless`设为true。
+配置文件详见：[配置文件说明](../config/README.md)
+
 请开启vless同时务必使用tls或者xtls。
 ## 启用xtls **(此项为实验性功能)**
-替换tls为xtls
-```
-示例：1.3.5.7;12345;2;tcp;xtls;server=hk.domain.com|host=hk.domain.com
-```
+在本地设置文件将`EnableXTLS`设为true。
+配置文件详见：[配置文件说明](../config/README.md)