Configuration & environment variables
Self-host your own RustDesk server, it is free and open source.
Important
Need more features? RustDesk Server Pro might suit you better.
Want to develop your own server? Start with rustdesk-server-demo, a simpler starting point than this repository.
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.
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 | hbbs loads/generates one by default |
| Bind address | -b |
BIND |
hbbs, hbbr | Local IP address to listen on (default: all interfaces; requires 1.1.17+) |
| Port | -p |
PORT |
hbbs, hbbr | Listening port (hbbs 21116, hbbr 21117) |
| Relay servers | -r |
RELAY-SERVERS |
hbbs | Override when the relay uses a different address or a non-standard port |
| 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.
Please follow this doc