|
|
@@ -1,3 +1,63 @@
|
|
|
1
|
+# 关于此分支
|
|
|
2
|
+
|
|
|
3
|
+[](https://github.com/lejianwen/rustdesk-server/actions/workflows/build.yaml)
|
|
|
4
|
+
|
|
|
5
|
+- 解决当客户端登录了`Api`账号时链接超时的问题
|
|
|
6
|
+- s6镜像添加了`Api`支持，`Api`开源地址 https://github.com/lejianwen/rustdesk-api
|
|
|
7
|
+- 是否必须登录才能链接， `MUST_LOGIN` 默认为 `N`，设置为 `Y` 则必须登录才能链接
|
|
|
8
|
+- `RUSTDESK_API_JWT_KEY`，设置后会通过`JWT`校验token的合法性
|
|
|
9
|
+- Support client websocket (client >= 1.4.1)
|
|
|
10
|
+
|
|
|
11
|
+## docker镜像地址
|
|
|
12
|
+
|
|
|
13
|
+- s6 镜像 [lejianwen/rustdesk-server-s6](https://hub.docker.com/r/lejianwen/rustdesk-server-s6)
|
|
|
14
|
+
|
|
|
15
|
+```yaml
|
|
|
16
|
+ networks:
|
|
|
17
|
+ rustdesk-net:
|
|
|
18
|
+ external: false
|
|
|
19
|
+ services:
|
|
|
20
|
+ rustdesk:
|
|
|
21
|
+ ports:
|
|
|
22
|
+ - 21114:21114
|
|
|
23
|
+ - 21115:21115
|
|
|
24
|
+ - 21116:21116
|
|
|
25
|
+ - 21116:21116/udp
|
|
|
26
|
+ - 21117:21117
|
|
|
27
|
+ - 21118:21118
|
|
|
28
|
+ - 21119:21119
|
|
|
29
|
+ image: lejianwen/rustdesk-server-s6:latest
|
|
|
30
|
+ environment:
|
|
|
31
|
+ - RELAY=<relay_server[:port]>
|
|
|
32
|
+ - ENCRYPTED_ONLY=1
|
|
|
33
|
+ - MUST_LOGIN=N
|
|
|
34
|
+ - TZ=Asia/Shanghai
|
|
|
35
|
+ - RUSTDESK_API_RUSTDESK_ID_SERVER=<id_server[:21116]>
|
|
|
36
|
+ - RUSTDESK_API_RUSTDESK_RELAY_SERVER=<relay_server[:21117]>
|
|
|
37
|
+ - RUSTDESK_API_RUSTDESK_API_SERVER=http://<api_server[:21114]>
|
|
|
38
|
+ - RUSTDESK_API_KEY_FILE=/data/id_ed25519.pub
|
|
|
39
|
+ - RUSTDESK_API_JWT_KEY=xxxxxx # jwt key
|
|
|
40
|
+ volumes:
|
|
|
41
|
+ - /data/rustdesk/server:/data
|
|
|
42
|
+ - /data/rustdesk/api:/app/data #将数据库挂载
|
|
|
43
|
+ networks:
|
|
|
44
|
+ - rustdesk-net
|
|
|
45
|
+ restart: unless-stopped
|
|
|
46
|
+
|
|
|
47
|
+```
|
|
|
48
|
+
|
|
|
49
|
+- 普通镜像 [lejianwen/rustdesk-server](https://hub.docker.com/r/lejianwen/rustdesk-server)
|
|
|
50
|
+
|
|
|
51
|
+# API功能截图
|
|
|
52
|
+
|
|
|
53
|
+
|
|
|
54
|
+
|
|
|
55
|
+
|
|
|
56
|
+
|
|
|
57
|
+更多查看 [RustDesk Api](https://github.com/lejianwen/rustdesk-api)
|
|
|
58
|
+
|
|
|
59
|
+
|
|
|
60
|
+
|
|
1
|
61
|
<p align="center">
|
|
2
|
62
|
<a href="#如何自行建置">自行建置</a> •
|
|
3
|
63
|
<a href="#Docker-映像檔">Docker</a> •
|
|
|
@@ -46,8 +106,8 @@ Docker 映像檔會在每次 GitHub 發布時自動生成並發布。我們有
|
|
46
|
106
|
|
|
47
|
107
|
這些映像檔是基於 `ubuntu-20.04` 建置的，僅添加了兩個主要的執行檔（`hbbr` 和 `hbbs`）。它們可在 [Docker Hub](https://hub.docker.com/r/rustdesk/rustdesk-server/) 上取得，帶有以下tags：
|
|
48
|
108
|
|
|
49
|
|
-| 架構 | image:tag |
|
|
50
|
|
-| ------- | ----------------------------------------- |
|
|
|
109
|
+| 架構 | image:tag |
|
|
|
110
|
+|---------|-------------------------------------------|
|
|
51
|
111
|
| amd64 | `rustdesk/rustdesk-server:latest` |
|
|
52
|
112
|
| arm64v8 | `rustdesk/rustdesk-server:latest-arm64v8` |
|
|
53
|
113
|
|
|
|
@@ -116,10 +176,11 @@ services:
|
|
116
|
176
|
|
|
117
|
177
|
## 基於 S6-overlay 的映象檔
|
|
118
|
178
|
|
|
119
|
|
-這些映象檔是針對 `busybox:stable` 建置的，並添加了執行檔（hbbr 和 hbbs）以及 [S6-overlay](https://github.com/just-containers/s6-overlay)。 它們在以及這些 tags 在 [Docker hub](https://hub.docker.com/r/rustdesk/rustdesk-server-s6/) 可用：
|
|
|
179
|
+這些映象檔是針對 `busybox:stable` 建置的，並添加了執行檔（hbbr 和 hbbs）以及 [S6-overlay](https://github.com/just-containers/s6-overlay)。 它們在以及這些 tags
|
|
|
180
|
+在 [Docker hub](https://hub.docker.com/r/rustdesk/rustdesk-server-s6/) 可用：
|
|
120
|
181
|
|
|
121
|
|
-| 架構 | version | image:tag |
|
|
122
|
|
-| --------- | ------- | -------------------------------------------- |
|
|
|
182
|
+| 架構 | version | image:tag |
|
|
|
183
|
+|-----------|---------|----------------------------------------------|
|
|
123
|
184
|
| multiarch | latest | `rustdesk/rustdesk-server-s6:latest` |
|
|
124
|
185
|
| amd64 | latest | `rustdesk/rustdesk-server-s6:latest-amd64` |
|
|
125
|
186
|
| i386 | latest | `rustdesk/rustdesk-server-s6:latest-i386` |
|
|
|
@@ -187,14 +248,14 @@ services:
|
|
187
|
248
|
|
|
188
|
249
|
對於此容器映象檔，您可以使用這些環境變數，**除了**以下**環境變數**部分指定的那些。
|
|
189
|
250
|
|
|
190
|
|
-| 環境變數 | 是否可選 | 敘述 |
|
|
191
|
|
-| -------------- | -------- | ------------------------------------------ |
|
|
192
|
|
-| RELAY | 否 | 運行此容器的機器的 IP 地址/ DNS 名稱 |
|
|
193
|
|
-| ENCRYPTED_ONLY | 是 | 如果設置為 **"1"**，將不接受未加密的連接。 |
|
|
194
|
|
-| KEY_PUB | 是 | 金鑰對中的公鑰（Public Key） |
|
|
195
|
|
-| KEY_PRIV | 是 | 金鑰對中的私鑰（Private Key） |
|
|
|
251
|
+| 環境變數 | 是否可選 | 敘述 |
|
|
|
252
|
+|----------------|------|---------------------------|
|
|
|
253
|
+| RELAY | 否 | 運行此容器的機器的 IP 地址/ DNS 名稱 |
|
|
|
254
|
+| ENCRYPTED_ONLY | 是 | 如果設置為 **"1"**，將不接受未加密的連接。 |
|
|
|
255
|
+| KEY_PUB | 是 | 金鑰對中的公鑰（Public Key） |
|
|
|
256
|
+| KEY_PRIV | 是 | 金鑰對中的私鑰（Private Key） |
|
|
196
|
257
|
|
|
197
|
|
-### 在基於 S6-overlay 的 Secret 管理
|
|
|
258
|
+### 在基於 S6-overlay 的 Secret 管理
|
|
198
|
259
|
|
|
199
|
260
|
您可以將金鑰對保存在 Docker volume 中，但最佳實踐建議不要將金鑰寫入文件系統；因此，我們提供了一些選項。
|
|
200
|
261
|
|
|
|
@@ -332,16 +393,16 @@ Secret Key: egAVd44u33ZEUIDTtksGcHeVeAwywarEdHmf99KM5ajwEsuG3NQFT9coAfiZ6nen4hf
|
|
332
|
393
|
可以使用這些 ENV 參數來配置 hbbs 和 hbbr。
|
|
333
|
394
|
您可以像往常一樣指定參數，或者使用 .env 文件。
|
|
334
|
395
|
|
|
335
|
|
-| 參數 | 執行檔 | 敘述 |
|
|
336
|
|
-| --------------------- | --------- | -------------------------------------------------------------------- |
|
|
337
|
|
-| ALWAYS_USE_RELAY | hbbs | 如果設為 **"Y"**，禁止直接點對點連接 |
|
|
338
|
|
-| DB_URL | hbbs | 資料庫的路徑 |
|
|
339
|
|
-| DOWNGRADE_START_CHECK | hbbr | 降級檢查之前的延遲時間（以秒為單位） |
|
|
340
|
|
-| DOWNGRADE_THRESHOLD | hbbr | 降級檢查的閾值（bit/ms） |
|
|
341
|
|
-| KEY | hbbs/hbbr | 如果設置了，將強制使用特定金鑰，如果設為 **"_"**，則強制使用任何金鑰 |
|
|
342
|
|
-| LIMIT_SPEED | hbbr | 速度限制（以Mb/s為單位） |
|
|
343
|
|
-| PORT | hbbs/hbbr | 監聽端口（hbbs為21116，hbbr為21117） |
|
|
344
|
|
-| RELAY_SERVERS | hbbs | 運行hbbr的機器的IP地址/DNS名稱（用逗號分隔） |
|
|
345
|
|
-| RUST_LOG | all | 設定 debug level (error\|warn\|info\|debug\|trace) |
|
|
346
|
|
-| SINGLE_BANDWIDTH | hbbr | 單個連接的最大頻寬（以Mb/s為單位） |
|
|
347
|
|
-| TOTAL_BANDWIDTH | hbbr | 最大總頻寬（以Mb/s為單位） |
|
|
|
396
|
+| 參數 | 執行檔 | 敘述 |
|
|
|
397
|
+|-----------------------|-----------|--------------------------------------------------|
|
|
|
398
|
+| ALWAYS_USE_RELAY | hbbs | 如果設為 **"Y"**，禁止直接點對點連接 |
|
|
|
399
|
+| DB_URL | hbbs | 資料庫的路徑 |
|
|
|
400
|
+| DOWNGRADE_START_CHECK | hbbr | 降級檢查之前的延遲時間（以秒為單位） |
|
|
|
401
|
+| DOWNGRADE_THRESHOLD | hbbr | 降級檢查的閾值（bit/ms） |
|
|
|
402
|
+| KEY | hbbs/hbbr | 如果設置了，將強制使用特定金鑰，如果設為 **"_"**，則強制使用任何金鑰 |
|
|
|
403
|
+| LIMIT_SPEED | hbbr | 速度限制（以Mb/s為單位） |
|
|
|
404
|
+| PORT | hbbs/hbbr | 監聽端口（hbbs為21116，hbbr為21117） |
|
|
|
405
|
+| RELAY_SERVERS | hbbs | 運行hbbr的機器的IP地址/DNS名稱（用逗號分隔） |
|
|
|
406
|
+| RUST_LOG | all | 設定 debug level (error\|warn\|info\|debug\|trace) |
|
|
|
407
|
+| SINGLE_BANDWIDTH | hbbr | 單個連接的最大頻寬（以Mb/s為單位） |
|
|
|
408
|
+| TOTAL_BANDWIDTH | hbbr | 最大總頻寬（以Mb/s為單位） |
|
lejianwen