
Configure RustDesk Client for a Private ID/Relay Server
This guide explains how to configure a local RustDesk client to connect to a private RustDesk ID and relay server. The example values below are generic placeholders. Use the server details supplied by your administrator.
Server Details
| Field | What to Enter |
|---|---|
| ID Server | YOUR-ID-SERVER-HOSTNAME-OR-IP |
| Relay Server | YOUR-RELAY-SERVER-HOSTNAME-OR-IP |
| API Server | Leave blank unless your administrator specifically provides an API URL. |
| Key | YOUR-RUSTDESK-SERVER-PUBLIC-KEY |
Before You Start
- Make sure RustDesk is installed on the computer you are configuring.
- Ask your administrator for the correct ID server, relay server, and public key.
- You may need the computer administrator password to unlock RustDesk network settings.
Step-by-Step Setup
- Open RustDesk.
Launch RustDesk from Applications, the Start menu, Launchpad, or the Dock. - Open Settings.
Click the menu button in RustDesk, then choose Settings. - Go to Network.
In the Settings sidebar, click Network. - Unlock network settings if required.
Click Unlock network settings. If prompted, enter the computer administrator password. - Open ID/Relay server settings.
Click ID/Relay server. - Fill in the fields.
Enter the ID Server, Relay Server, and Key supplied by your administrator. Leave API Server blank unless instructed otherwise. - Save the settings.
Click OK, Apply, Save, or the confirmation button shown in your RustDesk version. - Confirm the connection.
Return to the RustDesk home screen. The status should show Ready.
Important Notes
- Do not include
http://orhttps://in the ID Server or Relay Server fields unless your administrator explicitly tells you to. - Do not paste extra spaces before or after the server address or key.
- The public key must match the private RustDesk server exactly. A wrong key can cause a key mismatch or connection failure.
Troubleshooting
| Problem | What to Try |
|---|---|
| Network settings are locked | Click Unlock network settings and enter the administrator password. |
| Client does not become Ready | Recheck the ID Server, Relay Server, and Key. Confirm there are no extra spaces. |
| API Server or port 21114 error | Open ID/Relay server settings and make sure API Server is blank unless your administrator provides an API endpoint. |
| Remote connection is slow or fails | Confirm the private server firewall allows the required RustDesk ports. |
| Key mismatch | Paste the key again exactly as provided by your administrator. |
Other Languages: A Chinese version is available through the WHMCS multi-language article translation.
