mirror of
https://github.com/rustdesk/rustdesk-server.git
synced 2026-08-27 04:28:08 +00:00
rustdesk
60 lines
2.4 KiB
Markdown
60 lines
2.4 KiB
Markdown
# RustDesk Server Program
|
|
|
|
[](https://github.com/rustdesk/rustdesk-server/actions/workflows/build.yaml)
|
|
|
|
[**Download**](https://github.com/rustdesk/rustdesk-server/releases)
|
|
|
|
[**Manual**](https://rustdesk.com/docs/en/self-host/)
|
|
|
|
[**Configuration & environment variables**](docs/environment-variables.md)
|
|
|
|
[**FAQ**](https://github.com/rustdesk/rustdesk/wiki/FAQ)
|
|
|
|
[**How to migrate OSS to Pro**](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/installscript/#convert-from-open-source)
|
|
|
|
Self-host your own RustDesk server, it is free and open source.
|
|
|
|
> [!IMPORTANT]
|
|
> **Need more features?** [RustDesk Server Pro](https://rustdesk.com/pricing.html) might suit you better.
|
|
>
|
|
> **Want to develop your own server?** Start with [rustdesk-server-demo](https://github.com/rustdesk/rustdesk-server-demo), a simpler starting point than this repository.
|
|
|
|
## How to build manually
|
|
|
|
```bash
|
|
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](https://github.com/rustdesk/rustdesk-server/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](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](https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/)
|