Skip to content

Commit ea24cb4

Browse files
authored
docs: update configuration documentation to include default values for parameters in server, client, and master cores
1 parent 8268657 commit ea24cb4

File tree

2 files changed

+26
-26
lines changed

2 files changed

+26
-26
lines changed

docs/en/configuration.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -254,19 +254,19 @@ nodepass "server://0.0.0.0:10101/0.0.0.0:8080?log=info&tls=1&proxy=1&rate=100"
254254

255255
NodePass allows flexible configuration via URL query parameters. The following table shows which parameters are applicable in server, client, and master modes:
256256

257-
| Parameter | Description | server | client | master |
258-
|-----------|----------------------|:------:|:------:|:------:|
259-
| `log` | Log level | O | O | O |
260-
| `tls` | TLS encryption mode | O | X | O |
261-
| `crt` | Custom certificate path| O | X | O |
262-
| `key` | Custom key path | O | X | O |
263-
| `min` | Minimum pool capacity | X | O | X |
264-
| `max` | Maximum pool capacity | O | X | X |
265-
| `mode` | Run mode control | O | O | X |
266-
| `read` | Data read timeout | O | O | X |
267-
| `rate` | Bandwidth rate limit | O | O | X |
268-
| `slot` | Maximum connection limit | O | O | X |
269-
| `proxy` | PROXY protocol support| O | O | X |
257+
| Parameter | Description | Default | server | client | master |
258+
|-----------|----------------------|---------|:------:|:------:|:------:|
259+
| `log` | Log level | `info` | O | O | O |
260+
| `tls` | TLS encryption mode | `0` | O | X | O |
261+
| `crt` | Custom certificate path| N/A | O | X | O |
262+
| `key` | Custom key path | N/A | O | X | O |
263+
| `min` | Minimum pool capacity | `64` | X | O | X |
264+
| `max` | Maximum pool capacity | `1024` | O | X | X |
265+
| `mode` | Run mode control | `0` | O | O | X |
266+
| `read` | Data read timeout | `1h` | O | O | X |
267+
| `rate` | Bandwidth rate limit | `0` | O | O | X |
268+
| `slot` | Maximum connection limit | `65536` | O | O | X |
269+
| `proxy` | PROXY protocol support| `0` | O | O | X |
270270

271271
- O: Parameter is valid and recommended for configuration
272272
- X: Parameter is not applicable and should be ignored

docs/zh/configuration.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -254,19 +254,19 @@ nodepass "server://0.0.0.0:10101/0.0.0.0:8080?log=info&tls=1&proxy=1&rate=100"
254254

255255
NodePass支持通过URL查询参数进行灵活配置,不同参数在 server、client、master 模式下的适用性如下表:
256256

257-
| 参数 | 说明 | server | client | master |
258-
|-----------|----------------------|:------:|:------:|:------:|
259-
| `log` | 日志级别 | O | O | O |
260-
| `tls` | TLS加密模式 | O | X | O |
261-
| `crt` | 自定义证书路径 | O | X | O |
262-
| `key` | 自定义密钥路径 | O | X | O |
263-
| `min` | 最小连接池容量 | X | O | X |
264-
| `max` | 最大连接池容量 | O | X | X |
265-
| `mode` | 运行模式控制 | O | O | X |
266-
| `read` | 读取超时时间 | O | O | X |
267-
| `rate` | 带宽速率限制 | O | O | X |
268-
| `slot` | 最大连接数限制 | O | O | X |
269-
| `proxy` | PROXY协议支持 | O | O | X |
257+
| 参数 | 说明 | 默认值 | server | client | master |
258+
|-----------|----------------------|-----------|:------:|:------:|:------:|
259+
| `log` | 日志级别 | `info` | O | O | O |
260+
| `tls` | TLS加密模式 | `0` | O | X | O |
261+
| `crt` | 自定义证书路径 | N/A | O | X | O |
262+
| `key` | 自定义密钥路径 | N/A | O | X | O |
263+
| `min` | 最小连接池容量 | `64` | X | O | X |
264+
| `max` | 最大连接池容量 | `1024` | O | X | X |
265+
| `mode` | 运行模式控制 | `0` | O | O | X |
266+
| `read` | 读取超时时间 | `1h` | O | O | X |
267+
| `rate` | 带宽速率限制 | `0` | O | O | X |
268+
| `slot` | 最大连接数限制 | `65536` | O | O | X |
269+
| `proxy` | PROXY协议支持 | `0` | O | O | X |
270270

271271

272272
- O:参数有效,推荐根据实际场景配置

0 commit comments

Comments
 (0)