Skip to content

Commit 23db876

Browse files
authored
docs: update usage instructions to include advanced parameters for timeouts and rate limits
1 parent 4c4ea45 commit 23db876

File tree

4 files changed

+6
-2
lines changed

4 files changed

+6
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ English | [简体中文](README_zh.md)
4040
- **⚙️ Minimal Configuration**
4141
- No config files required, ready to use via CLI.
4242
- Optimized for CI/CD and containers.
43-
- Flexible tuning via environment variables.
43+
- Advanced parameters like timeouts and rate limits.
4444

4545
- **📈 Performance**
4646
- Intelligent scheduling, auto-tuning, ultra-low resource usage.

README_zh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
- **⚙️ 极简配置方式**
4141
- 无需配置文件,仅命令行参数即可运行,适合自动化和快速迭代。
4242
- 适配 CI/CD 流程与容器环境,极大提升部署和运维效率。
43-
- 支持环境变量性能调优,灵活适应不同运行环境。
43+
- 支持超时、限速等高级参数调优,灵活适应不同运行环境。
4444

4545
- **📈 高性能优化**
4646
- 智能流量调度与自动连接调优,极低资源占用。

docs/en/usage.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ nodepass "server://<tunnel_addr>/<target_addr>?log=<level>&tls=<mode>&crt=<cert_
5858
- `0`: Automatic detection (default) - attempts local binding first, falls back if unavailable
5959
- `1`: Force reverse mode - server binds to target address locally and receives traffic
6060
- `2`: Force forward mode - server connects to remote target address
61+
- `read`: Data read timeout duration (default: 10m, supports time units like 30s, 5m, 30m, etc.)
62+
- `rate`: Bandwidth rate limit (default: 0 means no limit)
6163
6264
#### How Server Mode Works
6365

docs/zh/usage.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ nodepass "server://<tunnel_addr>/<target_addr>?log=<level>&tls=<mode>&crt=<cert_
5858
- `0`:自动检测(默认)- 首先尝试本地绑定,如果不可用则回退
5959
- `1`:强制反向模式 - 服务器本地绑定目标地址并接收流量
6060
- `2`:强制正向模式 - 服务器连接到远程目标地址
61+
- `read`:数据读取超时时间(默认:10m,支持时间单位如30s、5m、30m等)
62+
- `rate`:带宽速率限制,单位Mbps(默认:0表示无限制)
6163

6264
#### 服务端模式工作原理
6365

0 commit comments

Comments
 (0)