rustdesk-server/README-ZH.md

自行构建 • Docker • S6-overlay • 密钥 • Debian • 环境参数
[English] | [Deutsch] | [Nederlands] | [繁体中文]

RustDesk Server Program

下载

说明文件

FAQ

自行搭建属于你的RustDesk服务器,所有的一切都是免费且开源的

如何自行构建

cargo build --release

执行后会在target/release目录下生成三个对应平台的可执行程序

• hbbs - RustDesk ID/会和服务器
• hbbr - RustDesk 中继服务器
• rustdesk-utils - RustDesk 命令行工具

您可以在 releases 页面中找到最新的服务端软件。

如果您需要额外的功能支持，RustDesk 专业版服务器 获取更适合您。

如果您想开发自己的服务器，rustdesk-server-demo 应该会比直接使用这个仓库更简单快捷。

Docker 镜像

Docker镜像会在每次 GitHub 发布新的release版本时自动构建。我们提供两种类型的镜像。

Classic 传统镜像

这个类型的镜像是基于 ubuntu-20.04 进行构建，镜像仅包含两个主要的可执行程序（hbbr 和 hbbs）。它们可以通过以下tag在 Docker Hub 上获得：

架构	image:tag
amd64	rustdesk/rustdesk-server:latest
arm64v8	rustdesk/rustdesk-server:latest-arm64v8

您可以使用以下命令，直接通过 docker run 來启动这些镜像：

docker run --name hbbs --net=host -v "$PWD/data:/root" -d rustdesk/rustdesk-server:latest hbbs -r <relay-server-ip[:port]> 
docker run --name hbbr --net=host -v "$PWD/data:/root" -d rustdesk/rustdesk-server:latest hbbr 

或不使用 --net=host 参数启动， 但这样 P2P 直连功能将无法工作。

对于使用了 SELinux 的系统，您需要将 /root 替换为 /root:z，以保证容器的正常运行。或者，也可以通过添加参数 --security-opt label=disable 来完全禁用 SELinux 容器隔离。

docker run --name hbbs -p 21115:21115 -p 21116:21116 -p 21116:21116/udp -p 21118:21118 -v "$PWD/data:/root" -d rustdesk/rustdesk-server:latest hbbs -r <relay-server-ip[:port]> 
docker run --name hbbr -p 21117:21117 -p 21119:21119 -v "$PWD/data:/root" -d rustdesk/rustdesk-server:latest hbbr 

relay-server-ip 参数是运行这些容器的服务器的 IP 地址（或 DNS 名称）。如果你不想使用 21117 作为 hbbr 的服务端口,可使用可选参数 port 进行指定。

您也可以使用 docker-compose 进行构建,以下为配置示例：

version: '3'

networks:
  rustdesk-net:
    external: false

services:
  hbbs:
    container_name: hbbs
    ports:
      - 21115:21115
      - 21116:21116
      - 21116:21116/udp
      - 21118:21118
    image: rustdesk/rustdesk-server:latest
    command: hbbs -r rustdesk.example.com:21117
    volumes:
      - ./data:/root
    networks:
      - rustdesk-net
    depends_on:
      - hbbr
    restart: unless-stopped

  hbbr:
    container_name: hbbr
    ports:
      - 21117:21117
      - 21119:21119
    image: rustdesk/rustdesk-server:latest
    command: hbbr
    volumes:
      - ./data:/root
    networks:
      - rustdesk-net
    restart: unless-stopped

编辑第16行来指定你的中继服务器 （默认端口监听在 21117 的那一个）。 如果需要的话，您也可以编辑 volume 信息 (第 18 和 33 行)。

（感谢 @lukebarone 和 @QuiGonLeong 协助提供的 docker-compose 配置示例）

基于 S6-overlay 的镜像

这些镜像是针对 busybox:stable 构建的，并添加了可执行程序（hbbr 和 hbbs）以及 S6-overlay。 它们可以使用以下tag在 Docker hub 上获取：

架構	version	image:tag
multiarch	latest	rustdesk/rustdesk-server-s6:latest
amd64	latest	rustdesk/rustdesk-server-s6:latest-amd64
i386	latest	rustdesk/rustdesk-server-s6:latest-i386
arm64v8	latest	rustdesk/rustdesk-server-s6:latest-arm64v8
armv7	latest	rustdesk/rustdesk-server-s6:latest-armv7
multiarch	2	rustdesk/rustdesk-server-s6:2
amd64	2	rustdesk/rustdesk-server-s6:2-amd64
i386	2	rustdesk/rustdesk-server-s6:2-i386
arm64v8	2	rustdesk/rustdesk-server-s6:2-arm64v8
armv7	2	rustdesk/rustdesk-server-s6:2-armv7
multiarch	2.0.0	rustdesk/rustdesk-server-s6:2.0.0
amd64	2.0.0	rustdesk/rustdesk-server-s6:2.0.0-amd64
i386	2.0.0	rustdesk/rustdesk-server-s6:2.0.0-i386
arm64v8	2.0.0	rustdesk/rustdesk-server-s6:2.0.0-arm64v8
armv7	2.0.0	rustdesk/rustdesk-server-s6:2.0.0-armv7

强烈建议您使用major version 或 latest tag 的 multiarch 架构的镜像。

S6-overlay 在此处作为监控程序，用以保证两个进程的运行，因此使用此镜像，您无需运行两个容器。

您可以使用 docker run 命令直接启动镜像，如下：

docker run --name rustdesk-server \ 
  --net=host \
  -e "RELAY=rustdeskrelay.example.com" \
  -e "ENCRYPTED_ONLY=1" \
  -v "$PWD/data:/data" -d rustdesk/rustdesk-server-s6:latest

或刪去 --net=host 参数， 但 P2P 直连功能将无法工作。

docker run --name rustdesk-server \
  -p 21115:21115 -p 21116:21116 -p 21116:21116/udp \
  -p 21117:21117 -p 21118:21118 -p 21119:21119 \
  -e "RELAY=rustdeskrelay.example.com" \
  -e "ENCRYPTED_ONLY=1" \
  -v "$PWD/data:/data" -d rustdesk/rustdesk-server-s6:latest

或着您也可以使用 docker-compose 文件:

version: '3'

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=rustdesk.example.com:21117"
      - "ENCRYPTED_ONLY=1"
    volumes:
      - ./data:/data
    restart: unless-stopped

对于此容器镜像，除了在下面的环境变量部分指定的变量之外，您还可以使用以下环境变量

环境变量	是否可选	描述
RELAY	否	运行此容器的宿主机的 IP 地址/ DNS 名称
ENCRYPTED_ONLY	是	如果设置为 "1"，将不接受未加密的连接。
KEY_PUB	是	密钥对中的公钥（Public Key）
KEY_PRIV	是	密钥对中的私钥（Private Key）

基于 S6-overlay 镜像的密钥管理

您可以将密钥对保存在 Docker volume 中，但我们建议不要将密钥写入文件系統中；因此，我们提供了一些方案。

在容器启动时，会检查密钥对是否存在（/data/id_ed25519.pub 和 /data/id_ed25519），如果其中一個密钥不存在，则会从环境变量或 Docker Secret 中重新生成它。 然后检查密钥对的可用性：如果公钥和私钥不匹配，容器将停止运行。 如果您未提供密钥，hbbs 将会在默认位置生成一个。

使用 ENV 存储密钥对

您可以使用 Docker 环境变量來存储密钥。如下：

docker run --name rustdesk-server \ 
  --net=host \
  -e "RELAY=rustdeskrelay.example.com" \
  -e "ENCRYPTED_ONLY=1" \
  -e "DB_URL=/db/db_v2.sqlite3" \
  -e "KEY_PRIV=FR2j78IxfwJNR+HjLluQ2Nh7eEryEeIZCwiQDPVe+PaITKyShphHAsPLn7So0OqRs92nGvSRdFJnE2MSyrKTIQ==" \
  -e "KEY_PUB=iEyskoaYRwLDy5+0qNDqkbPdpxr0kXRSZxNjEsqykyE=" \
  -v "$PWD/db:/db" -d rustdesk/rustdesk-server-s6:latest

version: '3'

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=rustdesk.example.com:21117"
      - "ENCRYPTED_ONLY=1"
      - "DB_URL=/db/db_v2.sqlite3"
      - "KEY_PRIV=FR2j78IxfwJNR+HjLluQ2Nh7eEryEeIZCwiQDPVe+PaITKyShphHAsPLn7So0OqRs92nGvSRdFJnE2MSyrKTIQ=="
      - "KEY_PUB=iEyskoaYRwLDy5+0qNDqkbPdpxr0kXRSZxNjEsqykyE="
    volumes:
      - ./db:/db
    restart: unless-stopped

使用 Docker Secret 來保存密钥对

您还可以使用 Docker Secret 來保存密钥。 如果您使用 docker-compose 或 docker swarm，推荐您使用。 只需按照以下示例操作：

cat secrets/id_ed25519.pub | docker secret create key_pub -
cat secrets/id_ed25519 | docker secret create key_priv -
docker service create --name rustdesk-server \
  --secret key_priv --secret key_pub \
  --net=host \
  -e "RELAY=rustdeskrelay.example.com" \
  -e "ENCRYPTED_ONLY=1" \
  -e "DB_URL=/db/db_v2.sqlite3" \
  --mount "type=bind,source=$PWD/db,destination=/db" \
  rustdesk/rustdesk-server-s6:latest

version: '3'

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=rustdesk.example.com:21117"
      - "ENCRYPTED_ONLY=1"
      - "DB_URL=/db/db_v2.sqlite3"
    volumes:
      - ./db:/db
    restart: unless-stopped
    secrets:
      - key_pub
      - key_priv

secrets:
  key_pub:
    file: secrets/id_ed25519.pub
  key_priv:
    file: secrets/id_ed25519      

如何生成密钥对

加密需要一对密钥；您可以按照前面所述提供它，但需要一个工具去生成密钥对。

您可以使用以下命令生成一对密钥：

/usr/bin/rustdesk-utils genkeypair

如果您沒有（或不想）在系统上安装 rustdesk-utils 套件，您可以使用 Docker 执行相同的命令：

docker run --rm --entrypoint /usr/bin/rustdesk-utils  rustdesk/rustdesk-server-s6:latest genkeypair

运行后的输出内容如下：

Public Key:  8BLLhtzUBU/XKAH4mep3p+IX4DSApe7qbAwNH9nv4yA=
Secret Key:  egAVd44u33ZEUIDTtksGcHeVeAwywarEdHmf99KM5ajwEsuG3NQFT9coAfiZ6nen4hfgNICl7upsDA0f2e/jIA==

.deb 套件

每个可执行文件都有单独的 .deb 套件可供使用，您可以在 releases 页面中找到它們。 這些套件适用于以下发行版：

• Ubuntu 22.04 LTS
• Ubuntu 20.04 LTS
• Ubuntu 18.04 LTS
• Debian 11 bullseye
• Debian 10 buster

ENV 环境变量

可以使用这些环境变量参数來配置 hbbs 和 hbbr。 您可以像往常一样指定参数，或者使用 .env 文件。

参数	可执行文件	描述
ALWAYS_USE_RELAY	hbbs	如果设定为 "Y"，将关闭直接点对点连接功能
DB_URL	hbbs	数据库配置
DOWNGRADE_START_CHECK	hbbr	降级检查之前的延迟是啊尽（以秒为单位）
DOWNGRADE_THRESHOLD	hbbr	降级检查的阈值（bit/ms）
KEY	hbbs/hbbr	如果设置了此参数，将强制使用指定密钥对，如果设为 "_"，则强制使用任意密钥
LIMIT_SPEED	hbbr	速度限制（以Mb/s为单位）
PORT	hbbs/hbbr	监听端口（hbbs为21116，hbbr为21117）
RELAY_SERVERS	hbbs	运行hbbr的机器的IP地址/DNS名称（用逗号分隔）
RUST_LOG	all	设置 debug level (error|warn|info|debug|trace)
SINGLE_BANDWIDTH	hbbr	单个连接的最大带宽（以Mb/s为单位）
TOTAL_BANDWIDTH	hbbr	最大总带宽（以Mb/s为单位）