mirror of
https://github.com/rustdesk/doc.rustdesk.com.git
synced 2024-12-27 09:29:18 +01:00
RustDesk
GitHub
commit
8f87ef68c9
@ -5,7 +5,7 @@ pre: "<b>1. </b>"
|
||||
---
|
||||
|
||||
### Introduction
|
||||
The RustDesk client is used on devices to connect via our RustDesk Server either open source or Pro, it is available to download from [GitHub](https://github.com/rustdesk/rustdesk/releases/latest).
|
||||
The RustDesk Client is used on devices to connect via our RustDesk Server either open source or Pro, it is available to download from [GitHub](https://github.com/rustdesk/rustdesk/releases/latest).
|
||||
|
||||
### Supported Platforms
|
||||
- Microsoft Windows
|
||||
|
||||
@ -16,7 +16,7 @@ Go to https://github.com/rustdesk/rustdesk/fork and click "Create fork".
|
||||
{{% notice note %}}
|
||||
You only need to do this if you want to change the default server and public key.
|
||||
|
||||
The server URL and key you are using is hidden from other users on GitHub however they can download your client and connect to your server. If you require a fully private repo you can import the RustDesk client repo using https://github.com/new/import. **If you use a private repo you have limited amounts of builds you can create per month, if you need more you will need to have a paid GitHub account.**
|
||||
The server URL and key you are using is hidden from other users on GitHub however they can download your client and connect to your server. If you require a fully private repo you can import the RustDesk Client repo using https://github.com/new/import. **If you use a private repo you have limited amounts of builds you can create per month, if you need more you will need to have a paid GitHub account.**
|
||||
{{% /notice %}}
|
||||
|
||||
On your fork you just created go to "Settings -> Secrets and variables -> Actions".
|
||||
@ -39,7 +39,7 @@ Once workflows are enabled you can go to “Actions”.
|
||||
|
||||
On the left, select "Flutter Nightly Build". Then on the right, click "Enable workflow".
|
||||
|
||||
Finally you can click "Run workflow" to build the RustDesk clients for all of the supported platforms.
|
||||
Finally you can click "Run workflow" to build the RustDesk Clients for all of the supported platforms.
|
||||
|
||||
## Enable upload permissions for workflows
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ pre: "<b>2.3. </b>"
|
||||
|
||||
### Overview
|
||||
|
||||
There are a number of ways to configure RustDesk clients to use your own self-hosted server, we will cover some below.
|
||||
There are a number of ways to configure RustDesk Clients to use your own self-hosted server, we will cover some below.
|
||||
|
||||
### Manual Config
|
||||
|
||||
@ -45,13 +45,13 @@ The easiest way to setup automatically is using deployment scripts found [here](
|
||||
|
||||
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.
|
||||
|
||||
You can also use the steps from [above](/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.
|
||||
You can also use the steps from [above](/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.
|
||||
|
||||
#### 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.
|
||||
|
||||
As a Pro user you will be able to retrieve the whole encrypted string from the web console https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console/ then download and rename the RustDesk Client exe, you can upload this somewhere easy for your customers to use.
|
||||
As a Pro user you will be able to retrieve the whole encrypted string from the [web console](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console/) then download and rename the RustDesk Client exe, you can upload this somewhere easy for your customers to use.
|
||||
|
||||
<a name="invalidchar"></a>
|
||||
{{% notice note %}}
|
||||
@ -77,9 +77,9 @@ After that you can enter the client ID and password of the machine you want to t
|
||||
### Address book (RustDesk Server Pro)
|
||||
To add devices to your address book, after you have connected to a device they will be in your recent sessions, next to the device you can now click the Menu button [ ⋮ ] and add to your address book, if you have saved the password and set permanent passwords on the client this will also be synced across devices you log in to to allow access from anywhere.
|
||||
|
||||
You can add and assign Tags in your address book to help organise devices as well as search for them.
|
||||
You can add and assign Tags in your address book to help organize devices as well as search for them.
|
||||
|
||||
## Group (RustDesk Server Pro)
|
||||
### Group (RustDesk Server Pro)
|
||||
By default once signed in all devices connected to your RustDesk Server Pro will show up in group, (you will still need the passwords for unattended access but all devices are now there), it will show any other users in your group and if you assign cross group access in the web console it will show users in those groups as well https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console/#add-new-groups.
|
||||
|
||||
If you would like to add devices to your own addressbook, you can click on the 3 dots next to the device and click Add to Addressbook.
|
||||
If you would like to add devices to your own address book, you can click on the Menu button [ ⋮ ] next to the device and click `Add to address book`.
|
||||
|
||||
@ -24,8 +24,10 @@ $rustdesk_cfg="configstring"
|
||||
################################### Please Do Not Edit Below This Line #########################################
|
||||
|
||||
# Run as administrator and stays in the current directory
|
||||
if (-Not ([Security.Principal.WindowsPrincipal][Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)) {
|
||||
if ([int](Get-CimInstance -Class Win32_OperatingSystem | Select-Object -ExpandProperty BuildNumber) -ge 6000) {
|
||||
if (-Not ([Security.Principal.WindowsPrincipal][Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator))
|
||||
{
|
||||
if ([int](Get-CimInstance -Class Win32_OperatingSystem | Select-Object -ExpandProperty BuildNumber) -ge 6000)
|
||||
{
|
||||
Start-Process PowerShell -Verb RunAs -ArgumentList "-NoProfile -ExecutionPolicy Bypass -Command `"cd '$pwd'; & '$PSCommandPath';`"";
|
||||
Exit;
|
||||
}
|
||||
@ -239,7 +241,6 @@ if [ -f /etc/os-release ]; then
|
||||
UPSTREAM_ID="$(echo ${ID_LIKE,,} | sed s/\"//g | cut -d' ' -f1)"
|
||||
fi
|
||||
|
||||
|
||||
elif type lsb_release >/dev/null 2>&1; then
|
||||
# linuxbase.org
|
||||
OS=$(lsb_release -si)
|
||||
@ -294,7 +295,6 @@ rustdesk --config $rustdesk_cfg
|
||||
|
||||
systemctl restart rustdesk
|
||||
|
||||
|
||||
echo "..............................................."
|
||||
# Check if the rustdesk_id is not empty
|
||||
if [ -n "$rustdesk_id" ]; then
|
||||
|
||||
@ -15,7 +15,8 @@ weight: 100
|
||||
```ps
|
||||
$ErrorActionPreference= 'silentlycontinue'
|
||||
|
||||
If (!(Test-Path C:\Temp)) {
|
||||
if (!(Test-Path C:\Temp))
|
||||
{
|
||||
New-Item -ItemType Directory -Force -Path C:\Temp > null
|
||||
}
|
||||
|
||||
@ -62,12 +63,13 @@ cd $env:ProgramFiles\RustDesk\
|
||||
|
||||
## Create Script to be used as a Check
|
||||
|
||||
```
|
||||
```ps
|
||||
$ErrorActionPreference= 'silentlycontinue'
|
||||
|
||||
$confirmation_file = "C:\program files\RustDesk\rdrunonce.txt"
|
||||
$confirmation_file = "C:\Program Files\RustDesk\rdrunonce.txt"
|
||||
|
||||
if ([System.IO.File]::Exists($confirmation_file)) {
|
||||
if ([System.IO.File]::Exists($confirmation_file))
|
||||
{
|
||||
echo "Confirmation file exists"
|
||||
exit 0
|
||||
}
|
||||
@ -76,14 +78,13 @@ else
|
||||
echo "Confirmation file doesn't exists"
|
||||
exit 1
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## RustDesk Set and Get Password (Collector Script needs Custom Agent Field) to run on Check Failure
|
||||
```
|
||||
```ps
|
||||
$ErrorActionPreference= 'silentlycontinue'
|
||||
|
||||
$confirmation_file = "C:\program files\RustDesk\rdrunonce.txt"
|
||||
$confirmation_file = "C:\Program Files\RustDesk\rdrunonce.txt"
|
||||
|
||||
net stop rustdesk > null
|
||||
$ProcessActive = Get-Process rustdesk -ErrorAction SilentlyContinue
|
||||
@ -99,7 +100,6 @@ Write-Output $rustdesk_pw
|
||||
net start rustdesk > null
|
||||
|
||||
New-Item $confirmation_file > null
|
||||
|
||||
```
|
||||
|
||||
## RustDesk URL Action
|
||||
|
||||
@ -58,8 +58,7 @@ A simple way to check is using telnet. To test in the Linux terminal type `telne
|
||||
Your mail server may not be using port 25. Please make sure you are using the correct ports.
|
||||
|
||||
## Can I deploy RustDesk using PowerShell or similar?
|
||||
Sure, you can find scripts to aid deployment here https://rustdesk.com/docs/en/self-host/client-deployment/
|
||||
|
||||
Sure, you can find scripts to aid deployment [here](https://rustdesk.com/docs/en/self-host/client-deployment/).
|
||||
|
||||
## I have installed RustDesk Server Pro manually but the API web console isn't behind SSL, how can I secure this?
|
||||
Use a proxy like Nginx, the simple install script has one, it's really simple. [This is how we do it](https://github.com/rustdesk/rustdesk-server-pro/blob/493ad90daf8815c3052ff4d0d4aa9cc07e411efa/install.sh#L252).
|
||||
@ -130,11 +129,11 @@ $rdver = ((Get-ItemProperty "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Un
|
||||
if ($rdver -eq "1.2.2")
|
||||
{
|
||||
write-output "RustDesk $rdver is the newest version."
|
||||
|
||||
exit
|
||||
}
|
||||
|
||||
If (!(Test-Path C:\Temp)) {
|
||||
if (!(Test-Path C:\Temp))
|
||||
{
|
||||
New-Item -ItemType Directory -Force -Path C:\Temp > null
|
||||
}
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ RustDesk Server Pro has more features compared to the open source version.
|
||||
- Multiple relay servers (automatically selects your closest relay)
|
||||
|
||||
{{% notice note %}}
|
||||
RustDesk client >= 1.2.0 required
|
||||
RustDesk Client >= 1.2.0 required
|
||||
{{% /notice %}}
|
||||
|
||||
## Download
|
||||
|
||||
@ -14,36 +14,38 @@ Features:
|
||||
## Log in
|
||||
|
||||
The default port of the web console is 21114. Enter `http://<hbbs host>:21114` in the browser to enter the console page, as shown in the following figure. The default administrator username/password is admin/test1234:
|
||||
|
||||
|
||||
|
||||
If you need HTTPS support, please install a web server such as `Nginx` or use `IIS` for Windows.
|
||||
|
||||
After logging in please be sure to change the password, select `Settings` in the account menu in the upper right corner to enter the password modification page, as shown in the following figure. You can also create another administrator account and delete this one. You'd better enable email login verification.
|
||||
|
||||
<a name=console-home></a>
|
||||
|
||||
|
||||
Non-administrator users can also login to browse their device and logs, change their user settings.
|
||||
|
||||
## Automatic Configs
|
||||
By Clicking on Windows EXE you will be able to get the configs for your own RustDesk server Pro, this will help configure your clients
|
||||
By Clicking on `Windows EXE` you will be able to get the configs for your own RustDesk Server Pro, this will help configure your clients.
|
||||
|
||||
For Windows clients, you can leave out the custom server configuration and put the configuration information in the `rustdesk.exe` filename instead. As shown above, please go to the console welcome page and click on `Windows EXE`. **Client >=1.1.9 Required**.
|
||||
For Windows clients, you can leave out the custom server configuration and put the configuration information in the `rustdesk.exe` filename instead. As shown above, please go to the console welcome page and click on `Windows EXE`. **Client >=1.1.9 Required.**
|
||||
|
||||
You can use this in conjuction with [client config](https://rustdesk.com/docs/en/self-host/client-configuration/) and [deployment scripts](https://rustdesk.com/docs/en/self-host/client-deployment/) to setup your clients.
|
||||
|
||||
## Creating a new user other than the default `admin` user
|
||||
1. Click On Users on the left hand menu
|
||||
1. Click On `Users` on the left hand menu.
|
||||
2. Create another account with `administrator` enabled.
|
||||
3. Log in with the new administrative account.
|
||||
4. Delete the `admin` on `Users` page.
|
||||
|
||||
## Creating a new users
|
||||
1. Click On Users on the left hand menu
|
||||
## Creating a new user
|
||||
1. Click On `Users` on the left hand menu.
|
||||
2. Create a new user.
|
||||
3. Select what group they should be in (if you need to add new groups please keep reading).
|
||||
|
||||
## Add New Groups
|
||||
1. Click On Groups on the left hand menu
|
||||
## Add a new Group
|
||||
1. Click On `Groups` on the left hand menu.
|
||||
2. Create a new group.
|
||||
3. Once created you can allow groups access each other, Click `Edit`.
|
||||
4. Select the relevant groups you want access (it automatically adds them in the corresponding group).
|
||||
@ -77,9 +79,9 @@ Gmail in this example
|
||||
8. Click `Check` to save.
|
||||
|
||||
## Assign Device Users and Groups to Devices
|
||||
The User is the RustDesk User logged in on the device or assigned to the device by clicking edit next to the device click in the User box and drop down to select your user, this will auto assign the group based on the group the user as been assigned to.
|
||||
The User is the RustDesk User logged in on the device or assigned to the device by clicking `Edit` next to the device, click in the `User` box and drop down to select your user, this will auto assign the group based on the group the user as been assigned to.
|
||||
|
||||
This can also be done via the API at command line on deployment or later by calling the rustdesk executable followed by `--assign --token <generatedtoken> --user_name <username>` (you need to go to `Settings` - `Tokens` - Create and create a token with Device permissions first to do this). An example if this on windows would be `"C:\program files\RustDesk\rustdesk.exe" --assign --token <generatedtoken> --user_name <newuser>`.
|
||||
This can also be done via the API at command line on deployment or later by calling the RustDesk executable followed by `--assign --token <generatedtoken> --user_name <username>`. You need to go to "Settings -> Tokens -> Create" and create a token with Device permissions first to do this. An example of this on windows would be `"C:\Program Files\RustDesk\rustdesk.exe" --assign --token <generatedtoken> --user_name <newuser>`.
|
||||
|
||||
## Searching for a device
|
||||
1. Go to Devices.
|
||||
|
||||
@ -16,9 +16,9 @@ weight: 2
|
||||
9. Log in with the username `admin` and password `test1234`.
|
||||
10. Enter your license code purchased in step 1.
|
||||
|
||||
## Use IIS as Proxy
|
||||
### Use IIS as Proxy
|
||||
|
||||
Please ensure Dynamic Content Compression is installed (this is an IIS Feature which can be installed with Server Roles)
|
||||
Please ensure `Dynamic Content Compression` is installed (this is an IIS Feature which can be installed with Server Roles).
|
||||
1. Open IIS (Or install it).
|
||||
2. Create a new website for RustDesk with the bindings (Ideally 443) and relevant certificate. Basic settings should point this to a blank folder. (If you use the default site, make sure there are no other files in the folder).
|
||||
3. On IIS, install [Application Request Routing](https://www.iis.net/downloads/microsoft/application-request-routing) and [URL Rewrite](https://learn.microsoft.com/en-us/iis/extensions/url-rewrite-module/using-the-url-rewrite-module).
|
||||
@ -42,10 +42,10 @@ Note: No http / https before the addresses – they are automatically handled. A
|
||||
|
||||
### Compression
|
||||
|
||||
1. Disable dynamic compression
|
||||
1. Disable `Dynamic Content Compression`.
|
||||
|
||||
### Troubleshooting
|
||||
If you have an error 500.52 add the mentioned variables: [https://techcommunity.microsoft.com/t5/iis-support-blog/iis-acting-as-reverse-proxy-where-the-problems-start/ba-p/846259](https://techcommunity.microsoft.com/t5/iis-support-blog/iis-acting-as-reverse-proxy-where-the-problems-start/ba-p/846259)
|
||||
|
||||
You maybe need to change your SSL Settings to Require SSL -> Ignore
|
||||
If you have an error 500.52 add the mentioned variables: [IIS acting as reverse proxy: Where the problems start](https://techcommunity.microsoft.com/t5/iis-support-blog/iis-acting-as-reverse-proxy-where-the-problems-start/ba-p/846259).
|
||||
|
||||
You maybe need to change your SSL Settings to "Require SSL -> Ignore".
|
||||
|
||||
@ -19,7 +19,7 @@ You will be required to enter license in the web console, or change license late
|
||||
|
||||
## Renew/upgrade license
|
||||
|
||||
You can find renew/upgrade as below via the self service license portal please go to [https://rustdesk.com/self-host/account/](https://rustdesk.com/self-host/account/)
|
||||
Renew/upgrade license can be found via the [self-service license portal](https://rustdesk.com/self-host/account/) as described below.
|
||||
|
||||
| License page with renew/upgrade actions | Upgrade window |
|
||||
| --- | --- |
|
||||
|
||||
@ -5,11 +5,11 @@ weight: 16
|
||||
|
||||
## Configuration
|
||||
|
||||
1. Sign in to the [Azure portal](portal.azure.com).
|
||||
1. Sign in to the [Azure portal](https://portal.azure.com).
|
||||
2. Search for and select **Microsoft Entra ID**.
|
||||
3. In the left menu, select [**App registrations**](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/RegisteredApps), click **New registration**.
|
||||
|
||||
4. Open the RustDesk Pro console, in the **Settings** page, click the **OIDC** module. Then copy the **Callback url**. **Note**: The **Callback url** is not editable, the `Path` part is fixed to `api/oidc/callback`, and the `Protocol://Host:Port` part is the origin of the current web page. If you open it through the address `http://localhost:8000/<path>`, then the **Callback url** is `http://localhost:8000/api/oidc/callback`. If you open it through the address `https://192.168.0.1:8000/<path>` is opened, then the **Callback url** is `https://192.168.0.1:8000/api/oidc/callback`. Because Azure must use `https://` or `http://localhost`, please select the appropriate address to open your RustDesk Pro console.
|
||||
4. Open the RustDesk Pro console, in the **Settings** page, click the **OIDC** module. Then copy the **Callback URL**. **Note**: The **Callback URL** is not editable, the `Path` part is fixed to `api/oidc/callback`, and the `Protocol://Host:Port` part is the origin of the current web page. If you open it through the address `http://localhost:8000/<path>`, then the **Callback URL** is `http://localhost:8000/api/oidc/callback`. If you open it through the address `https://192.168.0.1:8000/<path>` is opened, then the **Callback URL** is `https://192.168.0.1:8000/api/oidc/callback`. Because Azure must use `https://` or `http://localhost`, please select the appropriate address to open your RustDesk Pro console.
|
||||
|
||||
|
||||
5. Input the **Name**, select the **Supported account types**, and paste the **Redirect URI** from RustDesk Pro.
|
||||
@ -18,7 +18,7 @@ weight: 16
|
||||
|
||||
7. In Azure, select the application you want to use, click **Overview**, and copy the **Application (client) ID**.
|
||||
|
||||
8. In RustDesk Pro, paste the **Client id**.
|
||||
8. In RustDesk Pro, paste the **Client ID**.
|
||||
|
||||
9. In Azure, **Certificates & secrets**, create a new or select a client secret, usually New.
|
||||
|
||||
@ -26,16 +26,15 @@ weight: 16
|
||||
|
||||
11. In RustDesk Pro, paste the value for the client secret.
|
||||
|
||||
12. In RustDesk Pro, fill in the **Issuer** field, `https://login.microsoftonline.com/<Directory (tenant) ID>/v2.0`. Please replace `Directory (tenant) ID` with your **Directory (tenant) ID**. The **Directory (tenant) ID** is in Azure's app **Overview** panel.
|
||||
12. In RustDesk Pro, fill in the **Issuer** field with `https://login.microsoftonline.com/<Directory (tenant) ID>/v2.0`. Please replace `Directory (tenant) ID` with your **Directory (tenant) ID**. The **Directory (tenant) ID** is in Azure's app **Overview** panel.
|
||||
|
||||
|
||||
13. In Azure, select "Authentication" menu. Then set up authorization, by choosing **ID tokens (used for implicit and hybrid flows)**.
|
||||
13. In Azure, select **Authentication** menu. Then set up authorization, by choosing **ID tokens (used for implicit and hybrid flows)**.
|
||||
|
||||
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
## Refs
|
||||
## References
|
||||
|
||||
- [openid-settings](https://learn.microsoft.com/en-us/power-pages/security/authentication/openid-settings)
|
||||
- [v2-protocols-oidc](https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-protocols-oidc)
|
||||
- [Set up an OpenID Connect provider with Azure AD](https://learn.microsoft.com/en-us/power-pages/security/authentication/openid-settings)
|
||||
- [OpenID Connect on the Microsoft identity platform](https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-protocols-oidc)
|
||||
|
||||
@ -4,4 +4,4 @@ weight: 16
|
||||
---
|
||||
|
||||
- Use your existing Google, Okta, Facebook, Azure, Github, Gitlab, etc. accounts to easily create and log in to your RustDesk Pro account.
|
||||
- Spec. [openid-connect-core-1_0](https://openid.net/specs/openid-connect-core-1_0.html)
|
||||
- For the specification see [OpenID Connect Core 1.0 incorporating errata set 1](https://openid.net/specs/openid-connect-core-1_0.html).
|
||||
|
||||
Loading…
Reference in New Issue
Block a user