From ac9012a953a5d08c804553eeb1959c464b672298 Mon Sep 17 00:00:00 2001
From: admin <admin@gitea7.yangjieshao.work>
Date: Wed, 16 Sep 2026 16:04:47 +0800
Subject: [PATCH] docs: add relay speed limit configuration guide

---
 README.md | 33 +++++++++++++++++++++++++++++++--
 1 file changed, 31 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b849890..7bd051b 100644
--- a/README.md
+++ b/README.md
@@ -121,8 +121,37 @@ curl -s http://127.0.0.1:21114/_admin/ -o /dev/null -w '%{http_code}\n'
 | `rustdesk-server-s6:1.1.17-forapi` | s6 基础镜像（hbbs + hbbr + rustdesk-utils） |
 | `yangjieshao/rustdesk-api:full-s6-amd64` | 完整镜像（+ apimain + admin 前端，s6 托管） |
 
-| SINGLE_BANDWIDTH      | hbbr          | 单个连接的最大带宽（以Mb/s为单位）                              |
-| TOTAL_BANDWIDTH       | hbbr          | 最大总带宽（以Mb/s为单位）                                  |
+---
+
+### 中继限速配置
+
+hbbr（中继服务器）支持三个限速参数，均通过环境变量设置，**单位 Mb/s**：
+
+| 参数 | 默认值 | 说明 |
+|---|---|---|
+| `LIMIT_SPEED` | **32** | 单连接限速 |
+| `TOTAL_BANDWIDTH` | **1024** | 中继总带宽上限 |
+| `SINGLE_BANDWIDTH` | **128** | 单连接带宽上限 |
+
+**启动时配置（Docker 环境变量）：**
+
+```bash
+docker run ... \
+  -e LIMIT_SPEED=100 \
+  -e TOTAL_BANDWIDTH=2000 \
+  -e SINGLE_BANDWIDTH=500 \
+  yangjieshao/rustdesk-api:full-s6-amd64
+```
+
+**运行时修改（连接控制台）：**
+
+| 命令 | 说明 |
+|---|---|
+| `limit-speed <值>` | 设置单连接限速 |
+| `total-bandwidth <值>` | 设置总带宽 |
+| `single-bandwidth <值>` | 设置单连接带宽 |
+
+> ⚠️ **设为无限制**：代码中 `if v > 0.` 判断导致设 `0` 会被忽略。如需无限制，请设一个极大值，例如 `-e LIMIT_SPEED=100000`（≈100 Gb/s，实际等同无限制）。
 
 ---