lejianwen 1 год назад
Родитель
Сommit
3a430c72a2
2 измененных файлов с 3 добавлено и 401 удалено
  1. 1 203
      README.md
  2. 2 198
      README_EN.md

+ 1 - 203
README.md

@@ -263,209 +263,7 @@ proxy:
263 263
     lejianwen/rustdesk-api
264 264
     ```
265 265
 
266
-2. 使用`docker compose`
267
-   - 简单示例
268
-   ```yaml
269
-   services:
270
-      rustdesk-api:
271
-       container_name: rustdesk-api
272
-       environment:
273
-         - TZ=Asia/Shanghai
274
-         - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116
275
-         - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117
276
-         - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114
277
-         - RUSTDESK_API_RUSTDESK_KEY=<key>
278
-       ports:
279
-         - 21114:21114
280
-       image: lejianwen/rustdesk-api
281
-       volumes:
282
-         - /data/rustdesk/api:/app/data #将数据库挂载出来方便备份
283
-       networks:
284
-         - rustdesk-net
285
-       restart: unless-stopped
286
-   ```
287
-
288
-   - 根据rustdesk官方提供的示例,加上自己的rustdesk-api
289
-     - 如果是使用的系统生成的KEY,去掉`-k <key>`参数,在启动后运行`docker-compose logs hbbs`或者`cat ./data/id_ed25519.pub`查看KEY,然后再修改`RUSTDESK_API_RUSTDESK_KEY=<key>`再执行`docker-compose up -d`
290
-      ```yaml
291
-      networks:
292
-        rustdesk-net:
293
-          external: false
294
-      services:
295
-        hbbs:
296
-          container_name: hbbs
297
-          ports:
298
-            - 21115:21115
299
-            - 21116:21116 # 自定义 hbbs 映射端口
300
-            - 21116:21116/udp # 自定义 hbbs 映射端口
301
-            - 21118:21118 # web client
302
-          image: rustdesk/rustdesk-server
303
-          command: hbbs -r <relay-server-ip[:port]> -k <key> # 填入个人域名或 IP + hbbr 暴露端口
304
-          volumes:
305
-            - ./data:/root # 自定义挂载目录
306
-          networks:
307
-            - rustdesk-net
308
-          depends_on:
309
-            - hbbr
310
-          restart: unless-stopped
311
-          deploy:
312
-            resources:
313
-              limits:
314
-                memory: 64M
315
-        hbbr:
316
-          container_name: hbbr
317
-          ports:
318
-            - 21117:21117 # 自定义 hbbr 映射端口
319
-            - 21119:21119 # web client
320
-          image: rustdesk/rustdesk-server
321
-          command: hbbr -k <key>
322
-          volumes:
323
-            - ./data:/root
324
-          networks:
325
-            - rustdesk-net
326
-          restart: unless-stopped
327
-          deploy:
328
-            resources:
329
-              limits:
330
-                memory: 64M
331
-        rustdesk-api:
332
-          container_name: rustdesk-api
333
-          environment:
334
-            - TZ=Asia/Shanghai
335
-            - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116
336
-            - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117
337
-            - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114
338
-            - RUSTDESK_API_RUSTDESK_KEY=<key>
339
-          ports:
340
-            - 21114:21114
341
-          image: lejianwen/rustdesk-api
342
-          volumes:
343
-            - /data/rustdesk/api:/app/data #将数据库挂载出来方便备份
344
-          networks:
345
-            - rustdesk-net
346
-          restart: unless-stopped
347
-      ```
348
-     
349
-   - S6的镜像
350
-     - 如果使用***系统生成的KEY***或者***自定义KEY_PUB,KEY_PRIV***,不需要修改启动脚本,但要在生成KEY后获取到KEY再`docker-compose up -d`
351
-         ```yaml
352
-         networks:
353
-           rustdesk-net:
354
-             external: false
355
-         services:
356
-           rustdesk-server:
357
-             container_name: rustdesk-server
358
-             ports:
359
-               - 21115:21115
360
-               - 21116:21116
361
-               - 21116:21116/udp
362
-               - 21117:21117
363
-               - 21118:21118
364
-               - 21119:21119
365
-             image: rustdesk/rustdesk-server-s6:latest
366
-             environment:
367
-               - RELAY=192.168.1.66:21117
368
-               - ENCRYPTED_ONLY=1
369
-             volumes:
370
-               - ./data:/data
371
-             restart: unless-stopped
372
-           rustdesk-api:
373
-             container_name: rustdesk-api
374
-             ports:
375
-               - 21114:21114
376
-             image: lejianwen/rustdesk-api
377
-             environment:
378
-               - TZ=Asia/Shanghai
379
-               - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116
380
-               - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117
381
-               - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114
382
-               - RUSTDESK_API_RUSTDESK_KEY=<key> #系统生成的KEY
383
-             volumes:
384
-               - /data/rustdesk/api:/app/data #将数据库挂载
385
-             networks:
386
-               - rustdesk-net
387
-             restart: unless-stopped
388
-         ```
389
-     - 如果使用***自定义KEY***,会需要修改启动脚本,覆盖镜像中的`/etc/s6-overlay/s6-rc.d/hbbr/run`和`/etc/s6-overlay/s6-rc.d/hbbr/run`
390
-       1. 创建`hbbr/run`,自定义KEY才需要
391
-          ```bash
392
-          #!/command/with-contenv sh
393
-          cd /data
394
-          PARAMS=
395
-          [ "${ENCRYPTED_ONLY}" = "1" ] && PARAMS="-k ${KEY}"
396
-          /usr/bin/hbbr $PARAMS
397
-          ```
398
-       2. 创建`hbbs/run`,自定义KEY才需要
399
-           ```bash
400
-           #!/command/with-contenv sh
401
-           sleep 2
402
-           cd /data
403
-           PARAMS=
404
-           [ "${ENCRYPTED_ONLY}" = "1" ] && PARAMS="-k ${KEY}"
405
-           /usr/bin/hbbs -r $RELAY $PARAMS
406
-           ```
407
-       3. 修改`docker-compose.yml`中的`s6`部分
408
-       ```yaml
409
-       networks:
410
-         rustdesk-net:
411
-           external: false
412
-       services:
413
-         rustdesk-server:
414
-           container_name: rustdesk-server
415
-           ports:
416
-             - 21115:21115
417
-             - 21116:21116
418
-             - 21116:21116/udp
419
-             - 21117:21117
420
-             - 21118:21118
421
-             - 21119:21119
422
-           image: rustdesk/rustdesk-server-s6:latest
423
-           environment:
424
-             - RELAY=192.168.1.66:21117
425
-             - ENCRYPTED_ONLY=1
426
-             - KEY=<key>  #自定义KEY
427
-           volumes:
428
-             - ./data:/data
429
-             - ./hbbr/run:/etc/s6-overlay/s6-rc.d/hbbr/run 
430
-             - ./hbbs/run:/etc/s6-overlay/s6-rc.d/hbbs/run 
431
-           restart: unless-stopped
432
-         rustdesk-api:
433
-           container_name: rustdesk-api
434
-           ports:
435
-             - 21114:21114
436
-           image: lejianwen/rustdesk-api
437
-           environment:
438
-             - TZ=Asia/Shanghai
439
-             - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116
440
-             - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117
441
-             - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114
442
-             - RUSTDESK_API_RUSTDESK_KEY=<key>
443
-           volumes:
444
-             - /data/rustdesk/api:/app/data #将数据库挂载
445
-           networks:
446
-             - rustdesk-net
447
-           restart: unless-stopped
448
-       ```
449
-
450
-#### nginx反代
451
-
452
-在`nginx`中配置反代
453
-
454
-```
455
-server {
456
-    listen <your port>;
457
-    server_name <your server>;
458
-    location / {
459
-        proxy_pass http://<api-server[:port]>;
460
-        proxy_set_header Host $host;
461
-        proxy_set_header X-Real-IP $remote_addr;
462
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
463
-        proxy_set_header X-Forwarded-Proto $scheme;
464
-    }
465
-}
466
-```
467
-##### HTTPS等更多相关配置参考[wiki](https://github.com/lejianwen/rustdesk-api/wiki/Web-Client-V2-Preview-Document)
468
-
266
+2. 使用`docker compose`,参考[wiki](https://github.com/lejianwen/rustdesk-api/wiki)
469 267
 
470 268
 #### 下载release直接运行
471 269
 

+ 2 - 198
README_EN.md

@@ -267,189 +267,7 @@ The prefix for variable names is `RUSTDESK_API`. If environment variables exist,
267 267
     lejianwen/rustdesk-api
268 268
     ```
269 269
 
270
-2. Using `docker-compose`
271
-    - Simple example:
272
-       ```yaml
273
-       services:
274
-          rustdesk-api:
275
-           container_name: rustdesk-api
276
-           environment:
277
-             - RUSTDESK_API_LANG=en
278
-             - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116
279
-             - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117
280
-             - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114
281
-             - RUSTDESK_API_RUSTDESK_KEY=<key>
282
-           ports:
283
-             - 21114:21114
284
-           image: lejianwen/rustdesk-api
285
-           volumes:
286
-             - /data/rustdesk/api:/app/data # Mount the database for easy backup
287
-           networks:
288
-             - rustdesk-net
289
-           restart: unless-stopped
290
-       ```
291
-
292
-    - Example with RustDesk's official Docker Compose file, adding your `rustdesk-api` service:
293
-     - If you are using a system-generated KEY, remove the `-k <key>` parameter. However, after the first startup, run `docker-compose logs hbbs` or `cat ./data/id_ed25519.pub` to view the KEY, then modify `RUSTDESK_API_RUSTDESK_KEY=<key>` and execute `docker-compose up -d` again.
294
-       ```yaml
295
-          networks:
296
-            rustdesk-net:
297
-              external: false
298
-          services:
299
-            hbbs:
300
-              container_name: hbbs
301
-              ports:
302
-                - 21115:21115
303
-                - 21116:21116 # 自定义 hbbs 映射端口
304
-                - 21116:21116/udp # 自定义 hbbs 映射端口
305
-                - 21118:21118 # web client
306
-              image: rustdesk/rustdesk-server
307
-              command: hbbs -r <relay-server-ip[:port]> -k <key> # 填入个人域名或 IP + hbbr 暴露端口
308
-              volumes:
309
-                - ./data:/root # 自定义挂载目录
310
-              networks:
311
-                - rustdesk-net
312
-              depends_on:
313
-                - hbbr
314
-              restart: unless-stopped
315
-              deploy:
316
-                resources:
317
-                  limits:
318
-                    memory: 64M
319
-            hbbr:
320
-              container_name: hbbr
321
-              ports:
322
-                - 21117:21117 # 自定义 hbbr 映射端口
323
-                - 21119:21119 # web client
324
-              image: rustdesk/rustdesk-server
325
-              command: hbbr -k <key>
326
-              volumes:
327
-                - ./data:/root
328
-              networks:
329
-                - rustdesk-net
330
-              restart: unless-stopped
331
-              deploy:
332
-                resources:
333
-                  limits:
334
-                    memory: 64M
335
-            rustdesk-api:
336
-              container_name: rustdesk-api
337
-              environment:
338
-                - TZ=Asia/Shanghai
339
-                - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116
340
-                - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117
341
-                - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114
342
-                - RUSTDESK_API_RUSTDESK_KEY=<key>
343
-              ports:
344
-                - 21114:21114
345
-              image: lejianwen/rustdesk-api
346
-              volumes:
347
-                - /data/rustdesk/api:/app/data #将数据库挂载出来方便备份
348
-              networks:
349
-                - rustdesk-net
350
-              restart: unless-stopped
351
-          ```
352
-
353
-   - S6 image
354
-       - - If using ***custom KEY***, you will need to modify the startup script to override the `/etc/s6-overlay/s6-rc.d/hbbr/run` and `/etc/s6-overlay/s6-rc.d/hbbr/run` in the image.
355
-           1. Create `hbbr/run`, only needed for custom KEY
356
-              ```bash
357
-              #!/command/with-contenv sh
358
-              cd /data
359
-              PARAMS=
360
-              [ "${ENCRYPTED_ONLY}" = "1" ] && PARAMS="-k ${KEY}"
361
-              /usr/bin/hbbr $PARAMS
362
-              ```
363
-           2. Create `hbbs/run`, only needed for custom KEY
364
-               ```bash
365
-               #!/command/with-contenv sh
366
-               sleep 2
367
-               cd /data
368
-               PARAMS=
369
-               [ "${ENCRYPTED_ONLY}" = "1" ] && PARAMS="-k ${KEY}"
370
-               /usr/bin/hbbs -r $RELAY $PARAMS
371
-               ```
372
-           3. Modify the `s6` section in `docker-compose.yml`
373
-           ```yaml
374
-           networks:
375
-             rustdesk-net:
376
-               external: false
377
-           services:
378
-             rustdesk-server:
379
-               container_name: rustdesk-server
380
-               ports:
381
-                 - 21115:21115
382
-                 - 21116:21116
383
-                 - 21116:21116/udp
384
-                 - 21117:21117
385
-                 - 21118:21118
386
-                 - 21119:21119
387
-               image: rustdesk/rustdesk-server-s6:latest
388
-               environment:
389
-                 - RELAY=192.168.1.66:21117
390
-                 - ENCRYPTED_ONLY=1
391
-                 - KEY=<key>  #KEY
392
-               volumes:
393
-                 - ./data:/data
394
-                 - ./hbbr/run:/etc/s6-overlay/s6-rc.d/hbbr/run 
395
-                 - ./hbbs/run:/etc/s6-overlay/s6-rc.d/hbbs/run 
396
-               restart: unless-stopped
397
-             rustdesk-api:
398
-               container_name: rustdesk-api
399
-               ports:
400
-                 - 21114:21114
401
-               image: lejianwen/rustdesk-api
402
-               environment:
403
-                 - TZ=Asia/Shanghai
404
-                 - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116
405
-                 - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117
406
-                 - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114
407
-                 - RUSTDESK_API_RUSTDESK_KEY=<key>
408
-               volumes:
409
-                 - /data/rustdesk/api:/app/data 
410
-               networks:
411
-                 - rustdesk-net
412
-               restart: unless-stopped
413
-           ```
414
-   - If using ***system-generated KEY*** or ***custom KEY_PUB, KEY_PRIV***, you do not need to modify the startup script, but you need to obtain the KEY after it is generated and then run `docker-compose up -d`
415
-       ```yaml
416
-       networks:
417
-         rustdesk-net:
418
-           external: false
419
-       services:
420
-         rustdesk-server:
421
-           container_name: rustdesk-server
422
-           ports:
423
-             - 21115:21115
424
-             - 21116:21116
425
-             - 21116:21116/udp
426
-             - 21117:21117
427
-             - 21118:21118
428
-             - 21119:21119
429
-           image: rustdesk/rustdesk-server-s6:latest
430
-           environment:
431
-             - RELAY=192.168.1.66:21117
432
-             - ENCRYPTED_ONLY=1
433
-           volumes:
434
-             - ./data:/data
435
-           restart: unless-stopped
436
-         rustdesk-api:
437
-           container_name: rustdesk-api
438
-           ports:
439
-             - 21114:21114
440
-           image: lejianwen/rustdesk-api
441
-           environment:
442
-             - TZ=Asia/Shanghai
443
-             - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116
444
-             - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117
445
-             - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114
446
-             - RUSTDESK_API_RUSTDESK_KEY=<key>
447
-           volumes:
448
-             - /data/rustdesk/api:/app/data 
449
-           networks:
450
-             - rustdesk-net
451
-           restart: unless-stopped
452
-       ```
270
+2. Using `docker-compose`,look [wiki](https://github.com/lejianwen/rustdesk-api/wiki)
453 271
 
454 272
 #### Running from Release
455 273
 
@@ -498,21 +316,7 @@ Download the release from [release](https://github.com/lejianwen/rustdesk-api/re
498 316
 6. Open your browser and visit `http://<your server[:port]>/_admin/`, with default credentials `admin admin`. Please
499 317
    change the password promptly.
500 318
 
501
-#### nginx reverse proxy
502
-Configure reverse proxy in `nginx`
503
-```
504
-server {
505
-    listen <your port>;
506
-    server_name <your server>;
507
-    location / {
508
-        proxy_pass http://<api-server[:port]>;
509
-        proxy_set_header Host $host;
510
-        proxy_set_header X-Real-IP $remote_addr;
511
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
512
-        proxy_set_header X-Forwarded-Proto $scheme;
513
-    }
514
-}
515
-```
319
+
516 320
 ## Others
517 321
 
518 322
 - [Change client ID](https://github.com/abdullah-erturk/RustDesk-ID-Changer)