custom client in doc

This commit is contained in:
rustdesk
2024-03-17 02:08:06 +08:00
parent 316b2b8148
commit aee1169c54
3 changed files with 16 additions and 12 deletions
@@ -8,7 +8,11 @@ pre: "<b>2.3. </b>"
There are a number of ways to configure RustDesk Clients to use your own self-hosted server, we will cover some below.
### 1. Manual Config
### 1. Custom client generator (Pro only)
![](images/web_console_custom_client_config.jpeg)
### 2. Manual Config
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.
@@ -43,7 +47,7 @@ e.g. your API Server runs on default https port, please specify `API Server` wit
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).
### 2. Setup Using Import or Export
### 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.
@@ -54,7 +58,7 @@ If you still can not confirm the value of `API Server`, please go to the welcome
7. It will automatically paste the settings in.
8. Click `Apply`.
### 3. Automatic Config
### 4. Automatic Config
The easiest way to setup automatically is using deployment scripts found [here](https://rustdesk.com/docs/en/self-host/client-deployment/).
@@ -62,7 +66,7 @@ You can fix the Password is required and use a reverse Base64 string in the form
You can also use the steps from [above](https://rustdesk.com/docs/en/self-host/client-configuration/#setup-using-import-or-export) to export the string, remove any `=` at the start or end of the string. Restart RustDesk Client if settings don't show.
### 4. Put config in rustdesk.exe file name (Windows only)
### 5. Put config in rustdesk.exe file name (Windows only)
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.
@@ -93,9 +97,9 @@ We have noticed that in some cases, when double downloaded, something like `copy
By adding `--` at the end right after our config string, even if something is added to the file name, it won't corrupt the config string, and RustDesk will correctly retrieve it.
### 5. [Hardcoding Custom Settings](https://rustdesk.com/docs/en/self-host/client-configuration/hardcode-settings/)
### 6. [Hardcoding Custom Settings](https://rustdesk.com/docs/en/self-host/client-configuration/hardcode-settings/)
### 6. Use command line `--config`
### 7. 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).