hangyvv/rustdesk-api-s6 repository overview

⁠RustDesk API S6

RustDesk API S6 is a self-hosted RustDesk container image built on s6-overlay⁠. It bundles the RustDesk API service together with the hbbs and hbbr servers into a single compact runtime with proper service supervision.

• Source repository: https://github.com/HanGYvv/rustdesk-api⁠
• Docker Hub: hangyvv/rustdesk-api-s6
• GHCR: ghcr.io/hangyvv/rustdesk-api-s6

⁠Highlights

• All-in-one RustDesk deployment: API + hbbs + hbbr in one image
• Built with s6-overlay for reliable service supervision and health checks
• Automatic key-pair handling via the server's /data volume
• API configured through RUSTDESK_API_* environment variables

⁠Exposed ports

⁠Environment variables

The API is configured entirely through environment variables prefixed with RUSTDESK_API_ (dots in config keys become underscores, e.g. the config key rustdesk.id-server maps to RUSTDESK_API_RUSTDESK_ID_SERVER). The RELAY and ENCRYPTED_ONLY variables are passed through to the bundled hbbs / hbbr server.

Any other config key can be overridden the same way, for example RUSTDESK_API_APP_REGISTER or RUSTDESK_API_GORM_TYPE.

⁠Quick start

docker run -d \
  --name rustdesk-api \
  -e RUSTDESK_API_RUSTDESK_ID_SERVER=<id-server>:21116 \
  -e RUSTDESK_API_RUSTDESK_RELAY_SERVER=<relay-server>:21117 \
  -e RUSTDESK_API_RUSTDESK_API_SERVER=http://<host>:21114 \
  -e RUSTDESK_API_RUSTDESK_KEY=<public-key> \
  -e RELAY=<relay-server>:21117 \
  -p 21114:21114 \
  -p 21115-21119:21115-21119 \
  -p 21116:21116/udp \
  -v rustdesk-data:/data \
  -v rustdesk-api-data:/app/data \
  hangyvv/rustdesk-api-s6:latest

⁠docker-compose

services:
  rustdesk-api:
    image: hangyvv/rustdesk-api-s6:latest
    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://127.0.0.1:21114
      - RUSTDESK_API_RUSTDESK_KEY=123456789
      - RELAY=relay.example.com
    ports:
      - "21114:21114"
      - "21115-21119:21115-21119"
      - "21116:21116/udp"
    volumes:
      - rustdesk-data:/data
      - rustdesk-api-data:/app/data
    restart: unless-stopped

volumes:
  rustdesk-data:
  rustdesk-api-data:

⁠Data & keys

All persistent state lives under two volumes:

• /data — the server key pair (id_ed25519 / id_ed25519.pub) and server data. The API reads the public key from here by default.
• /app/data — the API database and runtime data.

Back both volumes up to preserve your server identity and API data across container recreation.