doc.rustdesk.com/content/self-host/client-configuration/_index.en.md

66 lines
2.9 KiB
Markdown
Raw Normal View History

2023-08-28 22:05:14 +02:00
---
2023-08-29 05:37:35 +02:00
title: Client Configuration
weight: 300
2023-08-29 05:45:11 +02:00
pre: "<b>2.3. </b>"
2023-08-28 22:05:14 +02:00
---
### Overview
There are a number of ways to configure RustDesk clients to use your own self-hosted server, we will cover some below.
### Manual Config
2023-09-05 00:01:31 +02:00
In the main RustDesk Client home click on the Menu button [ &#8942; ] next to your ID then click on Network, you can now unlock the settings using elevated privileges and set your ID, Relay, API and Keys.
2023-08-28 22:05:14 +02:00
2023-08-28 22:15:42 +02:00
![image](/docs/en/self-host/client-configuration/images/network-config.png)
2023-08-29 05:37:35 +02:00
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
```
2023-08-30 13:25:28 +02:00
### Setup Using Import or Export
2023-09-05 00:01:31 +02:00
1. Use the steps [above](/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`.
2023-08-29 05:37:35 +02:00
2023-08-28 22:32:32 +02:00
### Automatic Config
2023-08-31 21:56:30 +02:00
The easiest way to setup automatically is using deployment scripts found [here](https://rustdesk.com/docs/en/self-host/client-deployment/).
2023-08-28 22:32:32 +02:00
2023-09-05 00:01:31 +02:00
You can fix the Password is required and use a reverse Base64 string in the format `{"host":"HOSTADDRESS","key":"HOSTKEY","api":"http://HOSTADDRESS:21114"}` to automatically configure the clients, this is available automatically with RustDesk Server Pro via the console.
2023-08-30 13:25:28 +02:00
You can also use the steps from [above](/docs/en/self-host/client-configuration/#setup-using-import-or-export) to export the string then reverse it using [this site](https://string-functions.com/reverse.aspx).
2023-08-28 22:32:32 +02:00
2023-08-29 05:37:35 +02:00
#### Put config in rustdesk.exe file name (Windows only)
2023-08-28 22:32:32 +02:00
2023-08-29 05:37:35 +02:00
Change `rustdesk.exe` to rustdesk-`host=<host-ip-or-name>,key=<public-key-string>`.exe, e.g. rustdesk-`host=192.168.1.137,key=xfdsfsd32=32`.exe. You can see the config result in the About Window below.
2023-08-28 22:32:32 +02:00
2023-08-29 05:37:35 +02:00
<a name="invalidchar"></a>
{{% notice note %}}
You need to set both `host` and `key`, missing either one will not work.
2023-08-28 22:32:32 +02:00
2023-08-29 05:37:35 +02:00
Optionally add a `,` (comma) character after the key, before the `.exe` part as a delimiter, to avoid the key being mangled if Windows or the browser renames the file when downloading duplicated names.
2023-08-28 22:32:32 +02:00
2023-08-29 05:37:35 +02:00
If there are invalid characters in the key which can not be used in a Windows file name, please remove the
`id_ed25519` file from your server and restart `hbbs`/`hbbr`. This will cause the `id_ed25519.pub` file to regenerate. You may need to
repeat this process until you get valid characters.
{{% /notice %}}
2023-08-28 22:32:32 +02:00
2023-08-29 05:37:35 +02:00
### [Hardcoding](/docs/en/self-host/client-configuration/hardcode-settings/)