diff --git a/README.md b/README.md index 9a9dabc..687230e 100644 --- a/README.md +++ b/README.md @@ -263,209 +263,7 @@ proxy: lejianwen/rustdesk-api ``` -2. 使用`docker compose` - - 简单示例 - ```yaml - services: - rustdesk-api: - container_name: rustdesk-api - environment: - - TZ=Asia/Shanghai - - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116 - - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117 - - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114 - - RUSTDESK_API_RUSTDESK_KEY= - ports: - - 21114:21114 - image: lejianwen/rustdesk-api - volumes: - - /data/rustdesk/api:/app/data #将数据库挂载出来方便备份 - networks: - - rustdesk-net - restart: unless-stopped - ``` - - - 根据rustdesk官方提供的示例，加上自己的rustdesk-api - - 如果是使用的系统生成的KEY，去掉`-k `参数，在启动后运行`docker-compose logs hbbs`或者`cat ./data/id_ed25519.pub`查看KEY，然后再修改`RUSTDESK_API_RUSTDESK_KEY=`再执行`docker-compose up -d` - ```yaml - networks: - rustdesk-net: - external: false - services: - hbbs: - container_name: hbbs - ports: - - 21115:21115 - - 21116:21116 # 自定义 hbbs 映射端口 - - 21116:21116/udp # 自定义 hbbs 映射端口 - - 21118:21118 # web client - image: rustdesk/rustdesk-server - command: hbbs -r -k # 填入个人域名或 IP + hbbr 暴露端口 - volumes: - - ./data:/root # 自定义挂载目录 - networks: - - rustdesk-net - depends_on: - - hbbr - restart: unless-stopped - deploy: - resources: - limits: - memory: 64M - hbbr: - container_name: hbbr - ports: - - 21117:21117 # 自定义 hbbr 映射端口 - - 21119:21119 # web client - image: rustdesk/rustdesk-server - command: hbbr -k - volumes: - - ./data:/root - networks: - - rustdesk-net - restart: unless-stopped - deploy: - resources: - limits: - memory: 64M - rustdesk-api: - container_name: rustdesk-api - environment: - - TZ=Asia/Shanghai - - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116 - - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117 - - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114 - - RUSTDESK_API_RUSTDESK_KEY= - ports: - - 21114:21114 - image: lejianwen/rustdesk-api - volumes: - - /data/rustdesk/api:/app/data #将数据库挂载出来方便备份 - networks: - - rustdesk-net - restart: unless-stopped - ``` - - - S6的镜像 - - 如果使用***系统生成的KEY***或者***自定义KEY_PUB,KEY_PRIV***，不需要修改启动脚本，但要在生成KEY后获取到KEY再`docker-compose up -d` - ```yaml - networks: - rustdesk-net: - external: false - services: - rustdesk-server: - container_name: rustdesk-server - ports: - - 21115:21115 - - 21116:21116 - - 21116:21116/udp - - 21117:21117 - - 21118:21118 - - 21119:21119 - image: rustdesk/rustdesk-server-s6:latest - environment: - - RELAY=192.168.1.66:21117 - - ENCRYPTED_ONLY=1 - volumes: - - ./data:/data - restart: unless-stopped - rustdesk-api: - container_name: rustdesk-api - ports: - - 21114:21114 - image: lejianwen/rustdesk-api - environment: - - TZ=Asia/Shanghai - - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116 - - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117 - - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114 - - RUSTDESK_API_RUSTDESK_KEY= #系统生成的KEY - volumes: - - /data/rustdesk/api:/app/data #将数据库挂载 - networks: - - rustdesk-net - restart: unless-stopped - ``` - - 如果使用***自定义KEY***，会需要修改启动脚本，覆盖镜像中的`/etc/s6-overlay/s6-rc.d/hbbr/run`和`/etc/s6-overlay/s6-rc.d/hbbr/run` - 1. 创建`hbbr/run`，自定义KEY才需要 - ```bash - #!/command/with-contenv sh - cd /data - PARAMS= - [ "${ENCRYPTED_ONLY}" = "1" ] && PARAMS="-k ${KEY}" - /usr/bin/hbbr $PARAMS - ``` - 2. 创建`hbbs/run`，自定义KEY才需要 - ```bash - #!/command/with-contenv sh - sleep 2 - cd /data - PARAMS= - [ "${ENCRYPTED_ONLY}" = "1" ] && PARAMS="-k ${KEY}" - /usr/bin/hbbs -r $RELAY $PARAMS - ``` - 3. 修改`docker-compose.yml`中的`s6`部分 - ```yaml - networks: - rustdesk-net: - external: false - services: - rustdesk-server: - container_name: rustdesk-server - ports: - - 21115:21115 - - 21116:21116 - - 21116:21116/udp - - 21117:21117 - - 21118:21118 - - 21119:21119 - image: rustdesk/rustdesk-server-s6:latest - environment: - - RELAY=192.168.1.66:21117 - - ENCRYPTED_ONLY=1 - - KEY= #自定义KEY - volumes: - - ./data:/data - - ./hbbr/run:/etc/s6-overlay/s6-rc.d/hbbr/run - - ./hbbs/run:/etc/s6-overlay/s6-rc.d/hbbs/run - restart: unless-stopped - rustdesk-api: - container_name: rustdesk-api - ports: - - 21114:21114 - image: lejianwen/rustdesk-api - environment: - - TZ=Asia/Shanghai - - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116 - - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117 - - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114 - - RUSTDESK_API_RUSTDESK_KEY= - volumes: - - /data/rustdesk/api:/app/data #将数据库挂载 - networks: - - rustdesk-net - restart: unless-stopped - ``` - -#### nginx反代 - -在`nginx`中配置反代 - -``` -server { - listen ; - server_name ; - location / { - proxy_pass http://; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - } -} -``` -##### HTTPS等更多相关配置参考[wiki](https://github.com/lejianwen/rustdesk-api/wiki/Web-Client-V2-Preview-Document) - +2. 使用`docker compose`，参考[wiki](https://github.com/lejianwen/rustdesk-api/wiki) #### 下载release直接运行 diff --git a/README_EN.md b/README_EN.md index 882b678..677e095 100644 --- a/README_EN.md +++ b/README_EN.md @@ -267,189 +267,7 @@ The prefix for variable names is `RUSTDESK_API`. If environment variables exist, lejianwen/rustdesk-api ``` -2. Using `docker-compose` - - Simple example: - ```yaml - services: - rustdesk-api: - container_name: rustdesk-api - environment: - - RUSTDESK_API_LANG=en - - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116 - - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117 - - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114 - - RUSTDESK_API_RUSTDESK_KEY= - ports: - - 21114:21114 - image: lejianwen/rustdesk-api - volumes: - - /data/rustdesk/api:/app/data # Mount the database for easy backup - networks: - - rustdesk-net - restart: unless-stopped - ``` - - - Example with RustDesk's official Docker Compose file, adding your `rustdesk-api` service: - - If you are using a system-generated KEY, remove the `-k ` 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=` and execute `docker-compose up -d` again. - ```yaml - networks: - rustdesk-net: - external: false - services: - hbbs: - container_name: hbbs - ports: - - 21115:21115 - - 21116:21116 # 自定义 hbbs 映射端口 - - 21116:21116/udp # 自定义 hbbs 映射端口 - - 21118:21118 # web client - image: rustdesk/rustdesk-server - command: hbbs -r -k # 填入个人域名或 IP + hbbr 暴露端口 - volumes: - - ./data:/root # 自定义挂载目录 - networks: - - rustdesk-net - depends_on: - - hbbr - restart: unless-stopped - deploy: - resources: - limits: - memory: 64M - hbbr: - container_name: hbbr - ports: - - 21117:21117 # 自定义 hbbr 映射端口 - - 21119:21119 # web client - image: rustdesk/rustdesk-server - command: hbbr -k - volumes: - - ./data:/root - networks: - - rustdesk-net - restart: unless-stopped - deploy: - resources: - limits: - memory: 64M - rustdesk-api: - container_name: rustdesk-api - environment: - - TZ=Asia/Shanghai - - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116 - - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117 - - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114 - - RUSTDESK_API_RUSTDESK_KEY= - ports: - - 21114:21114 - image: lejianwen/rustdesk-api - volumes: - - /data/rustdesk/api:/app/data #将数据库挂载出来方便备份 - networks: - - rustdesk-net - restart: unless-stopped - ``` - - - S6 image - - - 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. - 1. Create `hbbr/run`, only needed for custom KEY - ```bash - #!/command/with-contenv sh - cd /data - PARAMS= - [ "${ENCRYPTED_ONLY}" = "1" ] && PARAMS="-k ${KEY}" - /usr/bin/hbbr $PARAMS - ``` - 2. Create `hbbs/run`, only needed for custom KEY - ```bash - #!/command/with-contenv sh - sleep 2 - cd /data - PARAMS= - [ "${ENCRYPTED_ONLY}" = "1" ] && PARAMS="-k ${KEY}" - /usr/bin/hbbs -r $RELAY $PARAMS - ``` - 3. Modify the `s6` section in `docker-compose.yml` - ```yaml - networks: - rustdesk-net: - external: false - services: - rustdesk-server: - container_name: rustdesk-server - ports: - - 21115:21115 - - 21116:21116 - - 21116:21116/udp - - 21117:21117 - - 21118:21118 - - 21119:21119 - image: rustdesk/rustdesk-server-s6:latest - environment: - - RELAY=192.168.1.66:21117 - - ENCRYPTED_ONLY=1 - - KEY= #KEY - volumes: - - ./data:/data - - ./hbbr/run:/etc/s6-overlay/s6-rc.d/hbbr/run - - ./hbbs/run:/etc/s6-overlay/s6-rc.d/hbbs/run - restart: unless-stopped - rustdesk-api: - container_name: rustdesk-api - ports: - - 21114:21114 - image: lejianwen/rustdesk-api - environment: - - TZ=Asia/Shanghai - - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116 - - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117 - - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114 - - RUSTDESK_API_RUSTDESK_KEY= - volumes: - - /data/rustdesk/api:/app/data - networks: - - rustdesk-net - restart: unless-stopped - ``` - - 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` - ```yaml - networks: - rustdesk-net: - external: false - services: - rustdesk-server: - container_name: rustdesk-server - ports: - - 21115:21115 - - 21116:21116 - - 21116:21116/udp - - 21117:21117 - - 21118:21118 - - 21119:21119 - image: rustdesk/rustdesk-server-s6:latest - environment: - - RELAY=192.168.1.66:21117 - - ENCRYPTED_ONLY=1 - volumes: - - ./data:/data - restart: unless-stopped - rustdesk-api: - container_name: rustdesk-api - ports: - - 21114:21114 - image: lejianwen/rustdesk-api - environment: - - TZ=Asia/Shanghai - - RUSTDESK_API_RUSTDESK_ID_SERVER=192.168.1.66:21116 - - RUSTDESK_API_RUSTDESK_RELAY_SERVER=192.168.1.66:21117 - - RUSTDESK_API_RUSTDESK_API_SERVER=http://192.168.1.66:21114 - - RUSTDESK_API_RUSTDESK_KEY= - volumes: - - /data/rustdesk/api:/app/data - networks: - - rustdesk-net - restart: unless-stopped - ``` +2. Using `docker-compose`,look [wiki](https://github.com/lejianwen/rustdesk-api/wiki) #### Running from Release @@ -498,21 +316,7 @@ Download the release from [release](https://github.com/lejianwen/rustdesk-api/re 6. Open your browser and visit `http:///_admin/`, with default credentials `admin admin`. Please change the password promptly. -#### nginx reverse proxy -Configure reverse proxy in `nginx` -``` -server { - listen ; - server_name ; - location / { - proxy_pass http://; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - } -} -``` + ## Others - [Change client ID](https://github.com/abdullah-erturk/RustDesk-ID-Changer)