rustdesk-server README

The project's README from github.com/rustdesk/rustdesk-server. As one markdown file: README.md.

RustDesk Server Program

build

Download

Manual

Configuration & environment variables

FAQ

How to migrate OSS to Pro

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.

How to build manually

cargo build --release

Three executables will be generated in target/release.

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 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.

Installation

Please follow this doc

rustdesk-server (rustdesk/rustdesk-server)

self-hosting
Searching Database…

What is this?The server program for RustDesk, a remote desktop tool: run it to self-host your own RustDesk infrastructure instead of relying on the free public servers. It is open source.
So is this the whole remote desktop app, or just the server half?Only the server half. Building it produces three executables: hbbs (the ID/Rendezvous server), hbbr (the relay server) and rustdesk-utils (CLI utilities) — you still use the RustDesk client app to connect.
How do I get it running?Build from source (executables land in target/release), grab prebuilt ones from the Releases page, or run the Docker image — the repo ships a docker-compose file for hbbs and hbbr.
What does the machine running it need?Very little: both are single Rust binaries. They listen on default ports 21116 (hbbs) and 21117 (hbbr), so those must be open; the -p flag or PORT env var changes them.
Is the free server enough, or will I hit limits that RustDesk Server Pro covers?This repo is the free open-source server; if you need more features, the README suggests RustDesk Server Pro might suit you better as a separate product.
Does my remote-desktop traffic pass through RustDesk's servers if I run this?No — self-hosting is the point: the ID and relay roles run on your own machine, so sessions go through infrastructure you control.
What do hbbs and hbbr each do?hbbs is the ID/Rendezvous server: it introduces RustDesk clients to each other so they can connect. hbbr is the relay that forwards session traffic when the clients cannot connect directly.
Why self-host this instead of using the default RustDesk service?Your remote-desktop sessions then run over infrastructure you control instead of a third-party server, and the program itself is free and open source — that is the README's whole pitch.
Is there a simpler starting point if I want to write my own server?Yes — the README points developers to rustdesk-server-demo, described as a simpler starting point than this repository.
Can I deploy it with Docker?Yes. The repo includes a docker-compose setup, and Docker image variables are documented in docs/environment-variables.md alongside the flag/env precedence rules and tuning notes.
What are similar projects?sshdesk, mRemoteNG, xpra, omnyssh, xpipe, rustdesk, dashbeam, bitbang
Creator
rustdesk
Size
1.9 MB
Stars
10.6K
Age
6y
Commits · 90 Days