mirror of
https://github.com/rustdesk/doc.rustdesk.com.git
synced 2026-04-07 16:26:25 +00:00
105 lines
5.7 KiB
Markdown
105 lines
5.7 KiB
Markdown
---
|
|
title: Client Configuration
|
|
description: "Configure RustDesk clients for self-hosted servers. Features custom client generator (Pro) for branded apps with your logo, manual configuration, import/export settings, and enterprise deployment strategies."
|
|
keywords: ["rustdesk client configuration", "custom client generator", "rustdesk branded client", "rustdesk white label", "rustdesk enterprise deployment", "rustdesk client setup", "custom rustdesk app", "rustdesk pro client", "rustdesk configuration management", "rustdesk corporate branding"]
|
|
weight: 300
|
|
pre: "<b>2.3. </b>"
|
|
---
|
|
|
|
## What is the best way to configure RustDesk clients for a self-hosted server?
|
|
|
|
The best configuration method depends on how many devices you manage and whether you use RustDesk Server Pro. For Pro deployments, the Custom Client Generator is usually the best option because it preloads server settings and branding. For smaller or OSS deployments, manual configuration, import/export, or scripted deployment are usually faster.
|
|
|
|
## Which client configuration method should you choose?
|
|
|
|
| Method | Best for | Why you would use it |
|
|
| --- | --- | --- |
|
|
| Custom client generator | RustDesk Server Pro teams | Creates preconfigured clients with your server settings, branding, and signing workflow |
|
|
| Manual config | Testing and small deployments | Fastest way to connect a few clients to a self-hosted server |
|
|
| Import or export | Reusing a known-good setup | Copies the same server settings from one client to another |
|
|
| Deployment scripts | RMM, Intune, or large rollouts | Installs RustDesk and applies config automatically at scale |
|
|
| `--config` command line | Managed installs and automation | Applies a config string non-interactively during scripted setup |
|
|
|
|
## What values do most clients need?
|
|
|
|
Most self-hosted RustDesk clients only need a few values:
|
|
|
|
- `ID Server`: required, usually your `hbbs` host or IP
|
|
- `Key`: required for encrypted connections to your self-hosted server
|
|
- `API Server`: needed for Pro account login and web console features
|
|
- `Relay Server`: often optional because RustDesk can infer it unless you want to set it explicitly
|
|
|
|
## 1. Custom client generator (Pro only, basic plan or custom plan)
|
|
|
|
You can have your own name, logo, icon, configuration, be signed and more.
|
|
|
|
Currently, Windows X64, Mac Arm64 / X64, [Linux](https://twitter.com/rustdesk/status/1788905463678951787), Android Arm 64 are supported.
|
|
|
|
[Video](https://twitter.com/rustdesk/status/1769171628426944539)
|
|
|
|
|
|
|
|
|
|
## 2. Manual Config
|
|
|
|
In the main RustDesk Client home click on the Menu button [ ⋮ ] next to your ID then click on Network, you can now unlock the settings using elevated privileges and set your `ID`, `Relay`, `API` and `Key`. It's important to note that this `Key` is the public key used for connection encryption, distinct from the license key provided with your Pro version purchase.
|
|
|
|
|
|
|
|
Enter the `hbbs` host or IP Address in the **ID Server** input box (local side + remote side). The other two addresses can be left blank, RustDesk will automatically deduce (if not specially set), and the Relay Server refers to `hbbr` (port 21117).
|
|
|
|
e.g.
|
|
|
|
```nolang
|
|
hbbs.example.com
|
|
```
|
|
|
|
or
|
|
|
|
```nolang
|
|
hbbs.example.com:21116
|
|
```
|
|
|
|
### Set `Key`
|
|
|
|
In order to establish an encrypted connection to your self-hosted server, you need to enter its public key. The key is usually generated on the first run of `hbbs` and can be found in the file `id_ed25519.pub` in your working directory / data folder.
|
|
|
|
As a `Pro` user you will additionally be able to retrieve the `Key` from the [web console](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console/).
|
|
|
|
|
|
|
|
### Set `API Server`
|
|
|
|
This is for `Pro` user only. When you can log in on web console, but fail to log in on RustDesk client, it probably you have not set `API Server` correctly.
|
|
|
|
If your API Server does not run on default `21114` port (you may not add this port to firewall if you come from open source version), please specify `API Server` explicitly.
|
|
e.g. your API Server runs on default HTTPS port, please specify `API Server` with `https://hbbs.example.com`.
|
|
|
|
If you still can not confirm the value of `API Server`, please go to the welcome page of web console, the `API Server` is shown in above picture (The input box with `API:` label).
|
|
|
|
## 3. Setup Using Import or Export
|
|
|
|
1. Use the steps [above](https://rustdesk.com/docs/en/self-host/client-configuration/#manual-config) to configure RustDesk Client on a Device.
|
|
2. Using the above machine go to Settings then Network and unlock.
|
|
3. Click on `Export Server Config`.
|
|
4. Paste the copied string into Notepad or similar.
|
|
5. Go to new client, copy the above to clipboard.
|
|
6. Go to Settings then Network in RustDesk Client, unlock and click `Import Server Config`.
|
|
7. It will automatically paste the settings in.
|
|
8. Click `Apply`.
|
|
|
|
## 4. Automatic Config
|
|
|
|
The easiest way to setup automatically is using deployment scripts found [here](https://rustdesk.com/docs/en/self-host/client-deployment/).
|
|
|
|
## 5. Import config from `Pro` via clipboard
|
|
|
|
|
|
|
|
https://github.com/rustdesk/rustdesk-server-pro/discussions/372#discussioncomment-10473298
|
|
|
|
## 6. Use command line `--config`
|
|
`rustdesk.exe --config <config-string>`
|
|
|
|
You can get the config string from web console (you can see it on above picture) or from RustDesk client "Settings → Network" ([here](https://github.com/rustdesk/rustdesk/discussions/7118) is a discussion about this).
|