rustdeskRustDesk Server Program
Configuration & environment variables
Self-host your own RustDesk server, it is free and open source.
How to build manually
cargo build --release
Three executables will be generated in target/release.
- hbbs - RustDesk ID/Rendezvous server
- hbbr - RustDesk relay server
- rustdesk-utils - RustDesk CLI utilities
You can find updated binaries on the Releases page.
Configuration
hbbs and hbbr can be configured with command-line flags, environment
variables, or an .env / config file. Run hbbs --help or hbbr --help to see
the available flags.
The most common options:
| Option | Flag | Env var | Applies to | Purpose |
|---|---|---|---|---|
| Key | -k |
KEY |
hbbs, hbbr | Server key; -k _ requires encryption |
| Port | -p |
PORT |
hbbs, hbbr | Listening port (hbbs 21116, hbbr 21117) |
| Relay servers | -r |
RELAY-SERVERS |
hbbs | Relay address given to clients, e.g. your domain |
| Force relay | — | ALWAYS_USE_RELAY |
hbbs | Y disables direct connections |
| Log level | — | RUST_LOG |
hbbs, hbbr | e.g. debug (default info) |
See docs/environment-variables.md for the full list of variables, the file/flag/env precedence rules, database and relay bandwidth tuning, Docker image variables, and examples.
If you want extra features, RustDesk Server Pro might suit you better.
If you want to develop your own server, rustdesk-server-demo might be a better and simpler start for you than this repo.
Installation
Please follow this doc