mirror of
https://github.com/rustdesk/doc.rustdesk.com.git
synced 2025-03-01 08:31:49 +01:00
RustDesk
GitHub
commit
651c60de09
@ -22,7 +22,6 @@ You get Priority #1 fast responses and service.
|
||||
# SSH Access
|
||||
To provide SSH access to your server for troubleshooting, please add the following key to ~/username/.ssh/authorized_keys and ensure the file has 600 permissions.
|
||||
|
||||
You may refer to [this](https://www.digitalocean.com/community/tutorials/how-to-configure-ssh-key-based-authentication-on-a-linux-server) tutorial for reference
|
||||
You may refer to this [tutorial](https://www.digitalocean.com/community/tutorials/how-to-configure-ssh-key-based-authentication-on-a-linux-server) for reference.
|
||||
|
||||
`ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDYfY6/reXgLrtwoLiRSyBJ99bDJBe+DrqPvmqGSItF020UrKdIBARD2BtZ4tM8nCbJSghq2poNuoIDaAcsQuRqkiX/rBzCuh+6H1DB1dqB2GTDKM2skN7zE1spdvgpqSPXKRj5sr74cJ/M7oHq81yRfR3K62Qrj5LoZHSS3w2Uxbf82fkX1YNZrgDRpqt+oIpA2L9r43XquYrZYibwQZt5574Ol5y+knf8HAaA35JSHN3XnNdGVIJmA7PsUKt0sHqshsypE1abGdES6yb48DvKTpfpu+NsoR5xSqePEJnjuiT2T/aiP/ps03Azb2HLjUD5oZgVJ6QmgpeZ/Gub/Nj0J68CV7lPYkoGBqUFeHpWFoKO/MB3bUFf4vU8UhHetck+iGOG/uyyBmLewPwIuCU/gZ37d6qx40YZuPdUU2FhbPqYu1OxlwRajIvgZOvKo6n8piyaIUwBQ9Bgd9iGrbGXzqGGt9a8zkzDjzzcNg5h/sbjG44K+m0kbPcH1yrYo7mQjaIzLk7qtH4KWXMlFxFfpfGF9SKm6jATURYdUhhoZ/RCgh7HD+070IhHLJwdzPcUQg8KPhf5Ep3VigN0R/474XsyfohY5W2zKB46TunbhTq79KHv2wPzFHjkikXIVxHOnwPhXBHZSoL7+1cIE8o275KecdfIuhFj6bU99nUzyw== support@rustdesk`
|
||||
|
||||
|
||||
@ -5,14 +5,14 @@ weight: 1
|
||||
|
||||
# RustDesk Documentation
|
||||
|
||||
RustDesk is a full-featured open source remote control alternative for self-hosting and security with minimal configuration. You have full control of your data, with no concerns about security. The Client is open source and theres a choice between the fully featured <b>Professional Server</b> available to purchase on our [website](rustdesk.com) and the basic free and OSS Server based on our <b>Professional Server</b>.
|
||||
RustDesk is a full-featured open source remote control alternative for self-hosting and security with minimal configuration. You have full control of your data, with no concerns about security. The Client is open source and theres a choice between the fully featured <b>Professional Server</b> available to purchase on our [website](https://rustdesk.com) and the basic free and OSS Server based on our <b>Professional Server</b>.
|
||||
|
||||
## Features
|
||||
- Works on Windows, macOS, Linux, iOS, Android, Web.
|
||||
- Supports VP8 / VP9 / AV1 software codecs, and H264 / H265 hardware codecs.
|
||||
- Own your data, easily set up self-hosting solution on your infrastructure.
|
||||
- P2P connection with end-to-end encryption based on NaCl.
|
||||
- No administrative privileges or installation needed for Windows, elevate priviledge locally or from remote on demand.
|
||||
- No administrative privileges or installation needed for Windows, elevate privilege locally or from remote on demand.
|
||||
- We like to keep things simple and will strive to make simpler where possible.
|
||||
|
||||
## GitHub Repos
|
||||
@ -22,4 +22,3 @@ Pro Server Repo: https://github.com/rustdesk/rustdesk-server-pro</br>
|
||||
Docs Repo: https://github.com/rustdesk/doc.rustdesk.com</br>
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
|
||||
|
||||
@ -5,11 +5,11 @@ weight: 6
|
||||
|
||||
You can deploy using a number of methods, some are covered in [Client](/docs/en/client/#configuring-rustdesk)
|
||||
|
||||
Alternatively you can use mass deployment scripts with your RMM, intune etc, the ID and password is output by the script, you should collect this, or split this off into different scripts to collect the ID and password.
|
||||
Alternatively you can use mass deployment scripts with your RMM, Intune etc., the ID and password is output by the script, you should collect this, or split this off into different scripts to collect the ID and password.
|
||||
|
||||
The permanent password can be changed from random to one you prefer using by changing the content inside () after rustdesk_pw to your preferred password.
|
||||
The permanent password can be changed from random to one you prefer using by changing the content inside `()` after `rustdesk_pw` to your preferred password.
|
||||
|
||||
### Powershell
|
||||
### PowerShell
|
||||
|
||||
```ps
|
||||
$ErrorActionPreference= 'silentlycontinue'
|
||||
@ -17,10 +17,10 @@ $ErrorActionPreference= 'silentlycontinue'
|
||||
# Assign the value random password to the password variable
|
||||
$rustdesk_pw = (-join ((65..90) + (97..122) | Get-Random -Count 12 | % {[char]$_}))
|
||||
|
||||
# Get your config string from your Web portal and Fill Below.
|
||||
# Get your config string from your Web portal and Fill Below
|
||||
rustdesk_cfg="configstring"
|
||||
|
||||
####################################Please Do Not Edit Below This Line##########################################
|
||||
################################### 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)) {
|
||||
@ -90,7 +90,7 @@ open -n /Applications/RustDesk.app
|
||||
```
|
||||
|
||||
|
||||
### Mac OS Bash
|
||||
### macOS Bash
|
||||
|
||||
```sh
|
||||
#!/bin/bash
|
||||
@ -98,10 +98,10 @@ open -n /Applications/RustDesk.app
|
||||
# Assign the value random password to the password variable
|
||||
rustdesk_pw=$(openssl rand -hex 4)
|
||||
|
||||
# Get your config string from your Web portal and Fill Below.
|
||||
# Get your config string from your Web portal and Fill Below
|
||||
rustdesk_cfg="configstring"
|
||||
|
||||
####################################Please Do Not Edit Below This Line##########################################
|
||||
################################### Please Do Not Edit Below This Line #########################################
|
||||
|
||||
# Check if the script is being run as root
|
||||
if [[ $EUID -ne 0 ]]; then
|
||||
@ -177,11 +177,10 @@ open -n /Applications/RustDesk.app
|
||||
# Assign a random value to the password variable
|
||||
rustdesk_pw=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 8 | head -n 1)
|
||||
|
||||
|
||||
# Get your config string from your Web portal and Fill Below.
|
||||
# Get your config string from your Web portal and Fill Below
|
||||
rustdesk_cfg="encryptedconfigstring"
|
||||
|
||||
####################################Please Do Not Edit Below This Line##########################################
|
||||
################################### Please Do Not Edit Below This Line #########################################
|
||||
|
||||
# Check if the script is being run as root
|
||||
if [[ $EUID -ne 0 ]]; then
|
||||
@ -189,7 +188,7 @@ if [[ $EUID -ne 0 ]]; then
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# identify OS
|
||||
# Identify OS
|
||||
if [ -f /etc/os-release ]; then
|
||||
# freedesktop.org and systemd
|
||||
. /etc/os-release
|
||||
@ -214,13 +213,13 @@ elif [ -f /etc/lsb-release ]; then
|
||||
OS=$DISTRIB_ID
|
||||
VER=$DISTRIB_RELEASE
|
||||
elif [ -f /etc/debian_version ]; then
|
||||
# Older Debian/Ubuntu/etc.
|
||||
# Older Debian, Ubuntu, etc.
|
||||
OS=Debian
|
||||
VER=$(cat /etc/debian_version)
|
||||
elif [ -f /etc/SuSe-release ]; then
|
||||
# Older SuSE/etc.
|
||||
elif [ -f /etc/SuSE-release ]; then
|
||||
# Older SuSE etc.
|
||||
OS=SuSE
|
||||
VER=$(cat /etc/SuSe-release)
|
||||
VER=$(cat /etc/SuSE-release)
|
||||
elif [ -f /etc/redhat-release ]; then
|
||||
# Older Red Hat, CentOS, etc.
|
||||
OS=RedHat
|
||||
@ -231,9 +230,9 @@ else
|
||||
VER=$(uname -r)
|
||||
fi
|
||||
|
||||
# Install Rustdesk
|
||||
# Install RustDesk
|
||||
|
||||
echo "Installing Rustdesk"
|
||||
echo "Installing RustDesk"
|
||||
if [ "${ID}" = "debian" ] || [ "$OS" = "Ubuntu" ] || [ "$OS" = "Debian" ] || [ "${UPSTREAM_ID}" = "ubuntu" ] || [ "${UPSTREAM_ID}" = "debian" ]; then
|
||||
wget https://github.com/rustdesk/rustdesk/releases/download/1.2.2/rustdesk-1.2.2-x86_64.deb
|
||||
apt-get install -fy ./rustdesk-1.2.2-x86_64.deb > null
|
||||
|
||||
@ -8,13 +8,13 @@ Windows portable programs do not have administrator privileges, which can lead t
|
||||
- The screen cannot be transmitted when the UAC (User Account Control) window pops up.
|
||||
- When an elevated window, such as the Task Manager, pops up, the mouse becomes unresponsive.
|
||||
|
||||
By elevating privileges, RustDesk can create a process with administrator privileges during startup or a session, enabling it to perform screenshotting and mouse operations, thereby avoiding the above problems
|
||||
By elevating privileges, RustDesk can create a process with administrator privileges during startup or a session, enabling it to perform screenshotting and mouse operations, thereby avoiding the above problems.
|
||||
|
||||
### Elevate at startup
|
||||
|
||||
This way, remote users don't need to request elevation when connecting. There are two methods:
|
||||
|
||||
* Method 1: Change the name of the portable program to end with `qs.exe`. Click the left mouse button to run, click "Accept" in the UAC window.
|
||||
* Method 1: Change the name of the portable program to end with `qs.exe`. Click the left mouse button to run, click `Accept` in the UAC window.
|
||||
|
||||
* Method 2: Right-click and run as administrator.
|
||||
|
||||
@ -22,26 +22,25 @@ This way, remote users don't need to request elevation when connecting. There ar
|
||||
|
||||
The controlled end can directly click `Accept and Elevate` when connecting, or click `Elevate` when already connected.
|
||||
|
||||
| connecting | connected |
|
||||
| :-------------------------------------------------: | :-----------------------------------------------: |
|
||||
| Connecting | Connected |
|
||||
| :---: | :---: |
|
||||
|  |  |
|
||||
|
||||
### Request elevation at the control end
|
||||
|
||||
After selecting `Request Elevation` from the action menu, the following dialog box will appear. If you choose `Ask the remote user for authentication`, you won't need to input a username and password, but the user on the remote computer must have administrator privileges. If you select `Transmit the username and password of administrator"`, the user on the remote computer only needs to accept in the UAC window. After sending the request, please wait for the user on the other side to accept the UAC window. Upon confirmation, a success message will appear. Note that **both methods require someone on the controlled end to accept the UAC window**. Therefore, if there is no one available on the other side, elevation should not be requested at the control end.
|
||||
|
||||
| menu | dialog |
|
||||
| :--------------------------------------------: | :-----------------------------------------------: |
|
||||
| Menu | Dialog |
|
||||
| :---: | :---: |
|
||||
|  |  |
|
||||
| **wait** | **success** |
|
||||
| **Wait** | **Success** |
|
||||
|  |  |
|
||||
|
||||
### How to Choose
|
||||
|
||||
| Scenario | Method |
|
||||
| :--------------------------------------: | :--------------------------------------: |
|
||||
| :---: | :---: |
|
||||
| No elevation required | Install the program |
|
||||
| No user available at the controlled end | Rename<br/>*or*<br/> Run with administrator |
|
||||
| User available at the controlled end<br/>*&&*<br/> Immediate elevation when connected<br/> *&&*<br/> Accept-via-click connection | Click `Accept and Elevate` when receiving the connection at the controlled end |
|
||||
| User available at the controlled end<br/>*&&*<br/> elevation as needed | Click `Elevate` on the connection management window at the controlled end<br/>*or*<br/> Request elevation at the control end |
|
||||
|
||||
| User available at the controlled end<br/>*and*<br/> Immediate elevation when connected<br/>*and*<br/> Accept-via-click connection | Click `Accept and Elevate` when receiving the connection at the controlled end |
|
||||
| User available at the controlled end<br/>*and*<br/> Elevation as needed | Click `Elevate` on the connection management window at the controlled end<br/>*or*<br/> Request elevation at the control end |
|
||||
|
||||
@ -9,11 +9,11 @@ The RustDesk client is used on devices to connect via our RustDesk Server either
|
||||
|
||||
### Supported Platforms
|
||||
- Microsoft Windows
|
||||
- Mac OS
|
||||
- macOS
|
||||
- Debian Derivatives (Ubuntu, Mint etc)
|
||||
- Redhat Derivatives (Centos, Rocky etc)
|
||||
- Arch/Manjaro
|
||||
- Opensuse
|
||||
- openSUSE
|
||||
- AppImage / Flatpak
|
||||
- Android
|
||||
- iOS (Not support being controlled)
|
||||
@ -23,23 +23,23 @@ The RustDesk client is used on devices to connect via our RustDesk Server either
|
||||
|
||||
#### Windows
|
||||
|
||||
Download the exe from GitHub and install
|
||||
Download the exe from GitHub and install.
|
||||
|
||||
To install silently call the install exe with `--silent-install`.
|
||||
|
||||
#### Mac OS
|
||||
#### macOS
|
||||
|
||||
Download the dmg file from GitHub more info can be found on the Mac OS page.
|
||||
Download the dmg file from GitHub more info can be found on the macOS page.
|
||||
|
||||
Open the .dmg file and drag `RustDesk` to `Applications`.
|
||||
Open the dmg file and drag `RustDesk` to `Applications`.
|
||||
|
||||
Allow RustDesk to run
|
||||
Allow RustDesk to run.
|
||||
|
||||
Enable permissions requested and follow prompts on the left hand side of RustDesk to finish setup.
|
||||
|
||||
#### Linux
|
||||
|
||||
Please see below instructions to install for the various "flavours" of linux, all installers are on GitHub.
|
||||
Please see below instructions to install for the various "flavours" of Linux, all installers are on GitHub.
|
||||
|
||||
#### Debian Derivatives (>= 16)
|
||||
|
||||
@ -60,7 +60,7 @@ sudo yum localinstall ./rustdesk-<version>.rpm
|
||||
sudo pacman -U ./rustdesk-<version>.pkg.tar.zst
|
||||
```
|
||||
|
||||
#### Opensuse (>= Leap 15.0)
|
||||
#### openSUSE (>= Leap 15.0)
|
||||
|
||||
```sh
|
||||
sudo zypper install --allow-unsigned-rpm ./rustdesk-<version>-suse.rpm
|
||||
@ -69,11 +69,10 @@ sudo zypper install --allow-unsigned-rpm ./rustdesk-<version>-suse.rpm
|
||||
Install apk from our GitHub more info can be found on the Android page.
|
||||
|
||||
### Usage
|
||||
Once installed (or run as a temporary executable) RustDesk will connect to the Public servers (you will see a message at the bottom saying (1) "Ready, For faster connection, please setup your own server). In the Top left you will see your (2) ID and (3) One Time Password and on the (4) Right a box for you to connect to another computer if you know their ID.
|
||||
Once installed (or run as a temporary executable) RustDesk will connect to the Public servers. You will see a message at the bottom saying (1) "Ready, For faster connection, please setup your own server.". In the Top left you will see your (2) ID, (3) One Time Password and on the (4) Right a box for you to connect to another computer if you know their ID.
|
||||
|
||||
|
||||
|
||||
|
||||
To access the settings, click on the (5) 3 dots to the right of ID.
|
||||
|
||||
Under Settings you will find:
|
||||
@ -81,32 +80,31 @@ Under Settings you will find:
|
||||
- Security - Permissions for someone taking control, Password options, ability to change your ID and Advanced Security Settings
|
||||
- Network - Set your own server settings here and proxy
|
||||
- Display - Control the display settings for remote sessions and other default options, sync clipboard etc
|
||||
- Account - This can be used in conjuction with the Pro Server to sign into the API
|
||||
- Account - This can be used in conjunction with the Pro Server to sign into the API
|
||||
- About - Shows information about the software.
|
||||
|
||||
### Configuring RustDesk
|
||||
There is number of ways to configure RustDesk.
|
||||
|
||||
The easiest way is using RustDesk Server Pro you can obtain an encrypted config string, this can be used in conjuction with `--config` to import settings. To do this:
|
||||
1. Open command line on whichever OS you use, to the folder where RustDesk is installed ie C:\program files\RustDesk on windows, /usr/bin on linux.
|
||||
2. Use the command `rustdesk.exe --config your-encrypted-string` eg `rustdesk.exe --config 9JSPSvJzNrBDasJjNSdXOVVBlERDlleoNWZzIHcOJiOikXZr8mcw5yazVGZ0NXdy5CdyciojI0N3boJye`
|
||||
The easiest way is using RustDesk Server Pro you can obtain an encrypted config string, this can be used in conjunction with `--config` to import settings. To do this:
|
||||
1. Open command line on whichever OS you use, to the folder where RustDesk is installed i.e. C:\Program Files\RustDesk on Windows, /usr/bin on Linux.
|
||||
2. Use the command `rustdesk.exe --config your-encrypted-string` e.g. `rustdesk.exe --config 9JSPSvJzNrBDasJjNSdXOVVBlERDlleoNWZzIHcOJiOikXZr8mcw5yazVGZ0NXdy5CdyciojI0N3boJye`
|
||||
|
||||
You can manually setup a client, to do this
|
||||
1. Click on Settings
|
||||
2. Click on Network
|
||||
3. Click Unlock Network Settings
|
||||
You can manually setup a client. To do this:
|
||||
1. Click on Settings.
|
||||
2. Click on Network.
|
||||
3. Click Unlock Network Settings.
|
||||
4. Enter your ID, Relay, API (if using pro) servers and your key.
|
||||
|
||||
|
||||
|
||||
If you manually setup a client, you can retrieve the RustDesk2.toml (in the users folder) file and use `--import-config` in a similar way to the above example.
|
||||
If you manually setup a client, you can retrieve the `RustDesk2.toml` (in the users folder) file and use `--import-config` in a similar way to the above example.
|
||||
|
||||
### Command Line Parameters
|
||||
|
||||
- `--password` can be used to set a permanent password.
|
||||
- `--get-id` can be used to retrieve the ID.
|
||||
- `--set-id` can be used to set an ID, please note IDs should start with a letter.
|
||||
- `--silent-install` can be used to install RustDesk silently on windows.
|
||||
- `--silent-install` can be used to install RustDesk silently on Windows.
|
||||
|
||||
Additional Advanced parameters can be found [here](https://github.com/rustdesk/rustdesk/blob/bdc5cded221af9697eb29aa30babce75e987fcc9/src/core_main.rs#L242)
|
||||
|
||||
|
||||
@ -9,17 +9,17 @@ Enter the ID of the remote device in the home page or select a historical device
|
||||
After the verification is successful, you can control remote device.
|
||||
|
||||
| Home | Successfully connected |
|
||||
| --------------- | -------------------------------------------------------- |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
Input control provides two modes: `mouse mode` and `touch mode`, which can be switched through the lower toolbar.
|
||||
Input control provides two modes: `Mouse mode` and `Touch mode`, which can be switched through the lower toolbar.
|
||||
|
||||
| Mouse settings | Mode selection |
|
||||
| --------------- | -------------------------------------------------------- |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
{{% notice note %}}
|
||||
In `mouse mode`,you can also trigger the remote device's `Right Mouse` with a `Two-Finger Tap`
|
||||
In `Mouse mode`,you can also trigger the remote device's `Right Mouse` with a `Two-Finger Tap`
|
||||
{{% /notice %}}
|
||||
|
||||
### File Transfer (Android)
|
||||
@ -31,7 +31,7 @@ In the device list on the home page, select the device.
|
||||
Long press or tap the menu on the right to select `File Transfer`
|
||||
|
||||
| Home | Successfully connected |
|
||||
| --------------- | -------------------------------------------------------- |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
- The initial directory is the Home directory of the device, you can click <i class="fas fa-home"></i> to quickly return to Home.
|
||||
@ -43,11 +43,11 @@ Long press or tap the menu on the right to select `File Transfer`
|
||||
#### How do I transfer files?
|
||||
|
||||
1. **Long press** on a file or folder in the list to quickly enter the **multiple selection mode**, which can select multiple items.
|
||||
2. After selecting the file(s), switch the `local` / `remote` page. After switching, you will see the `Paste here?` prompt at the bottom of the screen.
|
||||
2. After selecting the file(s), switch the `Local` / `Remote` page. After switching, you will see the `Paste here?` prompt at the bottom of the screen.
|
||||
3. Click the paste file icon in the picture to transfer the selected item(s) to the target directory.
|
||||
|
||||
| Multi-Select Mode | File Paste |
|
||||
| --------------- | -------------------------------------------------------- |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
### Set ID/Relay Server
|
||||
@ -78,14 +78,14 @@ Starting from version 1.1.9, the Android client has added the functions of shari
|
||||
|
||||
#### **Request permissions and start services**
|
||||
|
||||
Click on `Share Screen` from the bottom navigation bar
|
||||
Click on `Share Screen` from the bottom navigation bar.
|
||||
|
||||
Configure various permissions as needed. Every time you start RustDesk, you need to request "Screen Capture" and "Input Control" permissions again.
|
||||
|
||||
|
||||
|
||||
| Permissions | Description |
|
||||
| -- | -- |
|
||||
| --- | --- |
|
||||
| Screen Capture | Whether to enable screen capture sharing permission, the monitoring service will be enabled at the same time as startup |
|
||||
| Input Control* | Whether to allow the controller to control the input of the mobile phone, such as virtual touch screen operation with the mouse |
|
||||
| File transfer* | Whether to enable file transfer permission, after startup, you can remotely control the file system of this phone |
|
||||
@ -98,12 +98,12 @@ Above * represents special permissions. To obtain such permissions, you need to
|
||||
#### **Special Permission Request - File**
|
||||
|
||||
| Requesting Android file permissions will automatically jump to the system settings page |
|
||||
| :---------------: |
|
||||
| :---: |
|
||||
|  |
|
||||
|
||||
#### **Special Permission Request - mouse input**
|
||||
| Step 1 Find "Installed Services" | Step 2 Start RustDesk Input |
|
||||
| -- | -- |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
{{% notice note %}}
|
||||
@ -117,22 +117,22 @@ The system setting page of different vendors may be different, please adjust it
|
||||
- Long press mouse wheel: recently opened apps
|
||||
- Mouse wheel scrolling: simulate vertical sliding
|
||||
|
||||
#### **Start service**
|
||||
#### **Start Service**
|
||||
|
||||
After obtaining the `screen capture` permission, the service will be automatically started. You can also click the `Start service` button to start the service. After the service is started, it can accept desktop control requests from other devices.
|
||||
After obtaining the `Screen Capture` permission, the service will be automatically started. You can also click the `Start Service` button to start the service. After the service is started, it can accept desktop control requests from other devices.
|
||||
|
||||
If the `file transfer` permission is enabled, it can also accept file control requests from other devices.
|
||||
If the `File Transfer` permission is enabled, it can also accept file control requests from other devices.
|
||||
|
||||
After the service is started, a unique ID and random password will be automatically obtained for this device. Other devices can control the phone through the ID and password, or manually confirm when a new request is received.
|
||||
|
||||
| Before starting the service | After starting the service |
|
||||
| -- | -- |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
{{% notice note %}}
|
||||
1. Clicking `Start Service` will enable the `Screen capture` permission by default.
|
||||
2. When the `screen capture` permission is not obtained, other devices cannot issue control requests.
|
||||
3. Except for the `screen capture` permission, the switching of other permissions will only affect the new connection, and will not affect the established connection. If you need to switch permissions for an established connection, please close the current connection first, modify the permissions, and then receive a control request.
|
||||
1. Clicking `Start Service` will enable the `Screen Capture` permission by default.
|
||||
2. When the `Screen Capture` permission is not obtained, other devices cannot issue control requests.
|
||||
3. Except for the `Screen Capture` permission, the switching of other permissions will only affect the new connection, and will not affect the established connection. If you need to switch permissions for an established connection, please close the current connection first, modify the permissions, and then receive a control request.
|
||||
{{% /notice %}}
|
||||
|
||||
##### PC
|
||||
@ -142,5 +142,5 @@ After the service is started, a unique ID and random password will be automatica
|
||||
##### Mobile terminal
|
||||
|
||||
| You can stop the service or close the specified connection at any time | You can receive or initiate chats |
|
||||
| -- | -- |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
@ -24,7 +24,7 @@ sudo yum localinstall ./rustdesk-<version>.rpm
|
||||
sudo pacman -U ./rustdesk-<version>.pkg.tar.zst
|
||||
```
|
||||
|
||||
#### Opensuse (>= Leap 15.0)
|
||||
#### openSUSE (>= Leap 15.0)
|
||||
|
||||
```sh
|
||||
sudo zypper install --allow-unsigned-rpm ./rustdesk-<version>-suse.rpm
|
||||
|
||||
@ -7,7 +7,7 @@ weight: 30
|
||||
## How to build with Docker
|
||||
### This won't work on Windows
|
||||
|
||||
Begin by cloning the repository and building the docker container:
|
||||
Begin by cloning the repository and building the Docker container:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/rustdesk/rustdesk
|
||||
|
||||
@ -23,7 +23,7 @@ Download [rustup-init.exe](https://static.rust-lang.org/rustup/dist/x86_64-pc-wi
|
||||
Go to the folder you want to clone vcpkg and use [git-bash](https://git-scm.com/download/win) to run the following commands, download `vcpkg`, install 64-bit version of `libvpx`, `libyuv` and `opus`.
|
||||
If you don't have `git` installed, get `git` [here](https://git-scm.com/download/win).
|
||||
|
||||
```shell
|
||||
```sh
|
||||
git clone https://github.com/microsoft/vcpkg
|
||||
cd vcpkg
|
||||
git checkout 2023.04.15
|
||||
@ -43,9 +43,9 @@ Desktop versions use [Sciter](https://sciter.com/) for GUI, please download [sci
|
||||
|
||||
### LLVM
|
||||
|
||||
rust-bindgen depends on clang, download [LLVM](https://github.com/llvm/llvm-project/releases) and install, add System environment variable `LIBCLANG_PATH`=`<llvm_install_dir>/bin`.
|
||||
`rust-bindgen` depends on `clang`, download [LLVM](https://github.com/llvm/llvm-project/releases) and install, add System environment variable `LIBCLANG_PATH`=`<llvm_install_dir>/bin`.
|
||||
|
||||
You can download 15.02 of the LLVM binaries here: [64-bit](https://github.com/llvm/llvm-project/releases/download/llvmorg-15.0.2/LLVM-15.0.2-win64.exe) / [32-bit](https://github.com/llvm/llvm-project/releases/download/llvmorg-15.0.2/LLVM-15.0.2-win32.exe)
|
||||
You can download version 15.02 of the LLVM binaries here: [64-bit](https://github.com/llvm/llvm-project/releases/download/llvmorg-15.0.2/LLVM-15.0.2-win64.exe) / [32-bit](https://github.com/llvm/llvm-project/releases/download/llvmorg-15.0.2/LLVM-15.0.2-win32.exe)
|
||||
|
||||
## Build
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ weight: 7
|
||||
## Install your own server with Docker
|
||||
|
||||
### Requirements
|
||||
You need to have Docker/Podman installed to run a rustdesk-server as a docker container, if in doubt install Docker with [this](https://docs.docker.com/engine/install) guide to ensure its the most up to date!
|
||||
You need to have Docker/Podman installed to run a rustdesk-server as a Docker container, if in doubt install Docker with this [guide](https://docs.docker.com/engine/install) to ensure its the most up to date!
|
||||
|
||||
By default, `hbbs` listens on 21115 (TCP) and 21116 (TCP/UDP), 21118 (TCP), and `hbbr` listens on 21117 (TCP), 21119 (TCP). Be sure to open these ports in the firewall. **Please note that 21116 should be enabled both for TCP and UDP**. 21115 is used for the NAT type test, 21116/UDP is used for the ID registration and heartbeat service, 21116/TCP is used for TCP hole punching and connection service, 21117 is used for the Relay services, and 21118 and 21119 are used to support web clients. *If you do not need web client (21118, 21119) support, the corresponding ports can be disabled.*
|
||||
|
||||
@ -33,7 +33,7 @@ If you can not see logs with `-td`, you can see logs via `docker logs hbbs`. Or
|
||||
{{% /notice %}}
|
||||
|
||||
### Docker Compose examples
|
||||
For running the docker files with the `docker-compose.yml` as described here you need to have [**Docker Compose**](https://docs.docker.com/compose/) installed.
|
||||
For running the Docker files with the `docker-compose.yml` as described here you need to have [Docker Compose](https://docs.docker.com/compose/) installed.
|
||||
```yaml
|
||||
version: '3'
|
||||
|
||||
@ -60,4 +60,3 @@ services:
|
||||
network_mode: "host"
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@ Make sure you have got access via SSH or otherwise setup prior setting up the fi
|
||||
ufw allow proto tcp from YOURIP to any port 22
|
||||
```
|
||||
|
||||
#### If you have UFW installed use the following commands to configure the firewall (port 8000 only needed if you want to use the auto generated install files):
|
||||
If you have UFW installed use the following commands to configure the firewall (port 8000 only needed if you want to use the auto generated install files):
|
||||
```
|
||||
ufw allow 21115:21119/tcp
|
||||
ufw allow 8000/tcp
|
||||
@ -27,7 +27,7 @@ ufw allow 21116/udp
|
||||
sudo ufw enable
|
||||
```
|
||||
|
||||
#### Run the following commands:
|
||||
Run the following commands:
|
||||
```
|
||||
wget https://raw.githubusercontent.com/techahold/rustdeskinstall/master/install.sh
|
||||
chmod +x install.sh
|
||||
@ -39,7 +39,6 @@ There is also an update script on [Techahold's](https://github.com/techahold/rus
|
||||
|
||||
Please [Download](https://github.com/rustdesk/rustdesk-server/releases/latest) deb files yourself and install with `apt-get -f install <filename>.deb` or `dpkg -i <filename>.deb`.
|
||||
|
||||
|
||||
## Set up your own server instance manually.
|
||||
|
||||
### STEP 1: Download server-side software programs
|
||||
@ -69,7 +68,7 @@ The hardware requirements are very low; the minimum configuration of a basic clo
|
||||
We suggest you use [PM2](https://pm2.keymetrics.io/) for managing your service.
|
||||
|
||||
#### Option 1
|
||||
Run hbbs/hbbr without PM2
|
||||
Run hbbs/hbbr without PM2.
|
||||
|
||||
```bash
|
||||
./hbbs -r <relay-server-ip[:port]>
|
||||
@ -135,7 +134,6 @@ If there are invalid characters in the key which can not be used in a Windows fi
|
||||
repeat this process until you get valid characters.
|
||||
{{% /notice %}}
|
||||
|
||||
|
||||
## Key
|
||||
|
||||
Different from the old version, the key in this version is mandatory, but you don't need to set it yourself. When `hbbs` runs for the first time, it will automatically generate a pair of encrypted private and public keys (respectively located in the `id_ed25519` and `id_ed25519.pub` files in the running directory), whose main purpose is for communication encryption.
|
||||
|
||||
@ -3,26 +3,22 @@ title: Synology
|
||||
weight: 22
|
||||
---
|
||||
|
||||
> An alterative up-to-date tutorial from third-party is [here](https://mariushosting.com/how-to-install-rustdesk-on-your-synology-nas/)
|
||||
> An alterative up-to-date tutorial from third-party is [here](https://mariushosting.com/how-to-install-rustdesk-on-your-synology-nas/).
|
||||
|
||||
This tutorial is based on latest DSM v6 and v7.
|
||||
|
||||
### Install Docker
|
||||
|
||||
Open package manager and install docker
|
||||
|
||||
| | |
|
||||
| -- | -- |
|
||||
| Open package manager | Install Docker |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
|
||||
### Install RustDesk Server
|
||||
|
||||
| Search rustdesk-server in Docker's registry and install by double click | Installed rustdesk-server image, double click to create rustdesk-server container |
|
||||
| -- | -- |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
|
||||
### Create hbbs container
|
||||
|
||||
As mentioned above, double click on rustdesk-server image to create new container, set it name to `hbbs`.
|
||||
@ -33,19 +29,20 @@ Click on above "Advanced Settings".
|
||||
- Enable auto-restart
|
||||
|
||||
|
||||
- Enable "Use the same network as Docker host", for more about host net, please [check](install/#net-host)
|
||||
- Enable "Use the same network as Docker host", for more about host net, please [check](/docs/en/self-host/rustdesk-server-oss/docker/#net-host)
|
||||
|
||||
|
||||
- Mount a host directory (e.g. `/home/rustdesk/`) to `/root`, hbbs will generate some files (database and `key` files) in this directory which need to be persistent over reboots.
|
||||
|
||||
| Mount | Files generated in the host directory |
|
||||
| -- | -- |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
- Set command
|
||||
{{% notice note %}}
|
||||
Synology's OS is Debian based, so host net (--net=host) works fine, we do not need to map ports with `-p` option.
|
||||
|
||||
`192.168.16.98` is an internal IP used here for demonstration only, please set it to a public IP when you deploy (or you can use your DDNS address if you have configured one in Control Panel - Connectivity - DDNS) and don't forget to open ports on your router and your synology firewall if this is enabled (Control Panel - Connectivity - Firewall)!
|
||||
`192.168.16.98` is an internal IP used here for demonstration only, please set it to a public IP when you deploy (or you can use your DDNS address if you have configured one in "Control Panel -> Connectivity -> DDNS") and don't forget to open ports on your router and your Synology firewall if this is enabled ("Control Panel -> Connectivity -> Firewall")!
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
@ -67,9 +64,9 @@ Please repeat above `hbbs` steps, but name the container `hbbr` and command (for
|
||||
|
||||
|
||||
| Double click on container and check log | Double confirm hbbs/hbbr using host network |
|
||||
| -- | -- |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
### Retrieve your Key
|
||||
|
||||
Browse to the folder setup before using File Station, download id_ed25519.pub and open with a text editor to via your key.
|
||||
Browse to the folder setup before using File Station, download `id_ed25519.pub` and open with a text editor to via your key.
|
||||
|
||||
@ -33,19 +33,19 @@ If you've done everything correctly the folder `C:\Program Files\NSSM` (in this
|
||||
drive but you can use whatever drive you installed Windows to or whatever path you desire) should
|
||||
only contain the file `nssm.exe`.
|
||||
|
||||
We will be using `C:\Program Files\NSSM` in this example
|
||||
We will be using `C:\Program Files\NSSM` in this example.
|
||||
|
||||
Open Command prompt and run `nssm` if you see a help page you are ready to move onto the next step
|
||||
Open Command prompt and run `nssm` if you see a help page you are ready to move onto the next step.
|
||||
|
||||
### Run hbbr and hbbs
|
||||
Download the Windows version of [server program](https://github.com/rustdesk/rustdesk-server/releases).
|
||||
Unzip the program to the `C:\Program Files\RustDesk Server` (or anywhere you desire just make sure it
|
||||
doesn't change after the service is installed). now get back to Command prompt
|
||||
doesn't change after the service is installed). Now get back to Command prompt.
|
||||
|
||||
We will be using `C:\Program Files\RustDesk Server` in this example
|
||||
We will be using `C:\Program Files\RustDesk Server` in this example.
|
||||
```cmd
|
||||
nssm install "RustDesk hbbs service" "C:\Program Files\RustDesk Server\hbbs.exe" -r 0.0.0.0 -k _
|
||||
nssm install "RustDesk hbbr Service" "C:\Program Files\RustDesk Server\hbbr.exe" -k _
|
||||
nssm install "RustDesk hbbr service" "C:\Program Files\RustDesk Server\hbbr.exe" -k _
|
||||
```
|
||||
**Note:**
|
||||
- You can change `RustDesk hbbs service` to whatever you desire to name hbbs the service
|
||||
@ -82,7 +82,7 @@ nssm start <Desired hbbr servicename>
|
||||
### Install Node.js
|
||||
|
||||
Please [download](https://nodejs.org/dist/v16.14.2/node-v16.14.2-x86.msi) and install Node.js.
|
||||
Node.js is the runtime environment of PM2, so you need to install Node.js first。
|
||||
Node.js is the runtime environment of PM2, so you need to install Node.js first.
|
||||
|
||||
### Install PM2
|
||||
|
||||
@ -99,7 +99,7 @@ pm2-startup install
|
||||
Download the Windows version of [server program](https://github.com/rustdesk/rustdesk-server/releases). Unzip the program to the C: drive. Run the following four commands (take care to edit the `-r` parameter):
|
||||
|
||||
```cmd
|
||||
cd c:\rustdesk-server-windows-x64
|
||||
cd C:\rustdesk-server-windows-x64
|
||||
pm2 start hbbs.exe -- -r <The host where hbbr is running>
|
||||
pm2 start hbbr.exe
|
||||
pm2 save
|
||||
|
||||
@ -5,7 +5,7 @@ weight: 6
|
||||
|
||||
### Docker
|
||||
|
||||
Install Docker with [this](https://docs.docker.com/engine/install) guide to ensure its the most up to date!
|
||||
Install Docker with this [guide](https://docs.docker.com/engine/install) to ensure its the most up to date!
|
||||
|
||||
Run the following commands:
|
||||
```bash
|
||||
@ -14,7 +14,7 @@ sudo docker run --name hbbs -v `pwd`:/root -td --net=host --restart unless-stopp
|
||||
sudo docker run --name hbbr -v `pwd`:/root -td --net=host --restart unless-stopped rustdesk/rustdesk-server-pro hbbr
|
||||
```
|
||||
{{% notice note %}}
|
||||
The above example uses `sudo` and `--net=host`, this will not work on windows please remove these commands, if you remove `--net=host` please check below.
|
||||
The above example uses `sudo` and `--net=host`, this will not work on Windows please remove these commands, if you remove `--net=host` please check below.
|
||||
{{% /notice %}}
|
||||
|
||||
```bash
|
||||
@ -26,9 +26,9 @@ sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -td --r
|
||||
|
||||
### Docker Compose
|
||||
|
||||
With Docker Compose you HAVE to use `network_mode: "host"`. Install Docker using [this](https://docs.docker.com/engine/install) guide to ensure its the most up to date!
|
||||
With Docker Compose you HAVE to use `network_mode: "host"`. Install Docker using this [guide](https://docs.docker.com/engine/install) to ensure its the most up to date!
|
||||
|
||||
Copy the below into docker-compose.yml
|
||||
Copy the below into `docker-compose.yml`.
|
||||
|
||||
```yaml
|
||||
version: '3'
|
||||
|
||||
@ -31,19 +31,19 @@ weight: 600
|
||||
2. Copy and paste the command into your Linux terminal.
|
||||
3. Follow the prompts as they guide you through the upgrade.
|
||||
|
||||
## I installed with the scripts, how can I start and stop services?
|
||||
## I installed with the script, how can I start and stop services?
|
||||
The services use systemd so can be started and stopped using `sudo systemctl stop|start|restart rustdesk-hbbs|rustdesk-hbbr` e.g. `sudo systemctl restart rustdesk-hbbs`.
|
||||
|
||||
## I installed with the scripts, how can I view the Linux logs?
|
||||
## I installed with the script, how can I view the Linux logs?
|
||||
The logs are stored in /var/log/rustdesk-server, you can view them using `tail /var/log/rustdesk-server/hbbs.log` or `tail /var/log/rustdesk-server/hbbs.error`.
|
||||
|
||||
## I installed with the scripts, how can I check the status of the RustDesk services?
|
||||
## I installed with the script, how can I check the status of the RustDesk services?
|
||||
To check the status `sudo systemctl status rustdesk-hbbs|rustdesk-hbbr` e.g. `sudo systemctl status rustdesk-hbbs`.
|
||||
|
||||
## How can I install RustDesk Server Pro on Windows?
|
||||
1. Get your license from [https://rustdesk.com/pricing.html](https://rustdesk.com/pricing.html), check [license](/docs/en/self-host/rustdesk-server-pro/license) page for more details.
|
||||
2. Download the the windows installer from [GitHub](https://github.com/rustdesk/rustdesk-server-pro/releases/latest).
|
||||
3. Unzip the windows installer.
|
||||
2. Download the the Windows installer from [GitHub](https://github.com/rustdesk/rustdesk-server-pro/releases/latest).
|
||||
3. Unzip the Windows installer.
|
||||
4. Run the Installer and follow the steps on screen.
|
||||
5. Once its completed open RustDesk Server.
|
||||
6. Follow the prompts as they guide you through the install.
|
||||
@ -53,25 +53,24 @@ To check the status `sudo systemctl status rustdesk-hbbs|rustdesk-hbbr` e.g. `su
|
||||
10. Enter your license code purchased in step 1.
|
||||
|
||||
## Can I use IIS as a reverse proxy?
|
||||
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)
|
||||
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).
|
||||
|
||||
### Application Request Routing
|
||||
|
||||
1. Under the IIS Server Host open Application Request Routing:
|
||||
2. Go to Server Proxy Settings
|
||||
1. Under the IIS Server Host open Application Request Routing.
|
||||
2. Go to Server Proxy Settings.
|
||||
3. Enable proxy and all settings will appear, you can leave them as the defaults.
|
||||
4. Save the settings and we can go to the next step. URL rewrite.
|
||||
4. Save the settings and we can go to the next step: URL rewrite.
|
||||
|
||||
### URL rewrite
|
||||
1. Open the site on IIS on the left pane and double-click on URL rewrite
|
||||
2. Click Add rules
|
||||
3. Disable dynamic compression from under compression.
|
||||
4. Set up a new reverse proxy rule
|
||||
1. Open the site on IIS on the left pane and double-click on URL rewrite.
|
||||
2. Click `Add rules`.
|
||||
3. Disable dynamic compression under compression.
|
||||
4. Set up a new reverse proxy rule.
|
||||
5. Setup the local address (the 21114 address) \
|
||||
Inbound Rule – the rustdesk internal 21114 address \
|
||||
Outbound Rules – From: rustdesk internal 21114 address and To is the external address. \
|
||||
Inbound Rule – the RustDesk internal 21114 address \
|
||||
Outbound Rules – From is the RustDesk internal 21114 address and To is the external address. \
|
||||
Note – no http / https before the addresses – they are automatically handled. Also, ensure all the addresses are accessible both internally and externally.
|
||||
|
||||
## How can I change the admin password?
|
||||
@ -92,8 +91,8 @@ 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?
|
||||
Sure, this script can help, replace `youraddress` and `yourkey` with your address and key for your RustDesk Server Pro Address and Key
|
||||
```
|
||||
Sure, this script can help, replace `youraddress` and `yourkey` with your address and key for your RustDesk Server Pro Address and Key.
|
||||
```ps
|
||||
$ErrorActionPreference= 'silentlycontinue'
|
||||
|
||||
$rdver = ((Get-ItemProperty "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\RustDesk\").Version)
|
||||
@ -143,7 +142,7 @@ net start rustdesk
|
||||
|
||||
## How can I get RustDesk IDs from agents on my network or using an RMM type system?
|
||||
On Windows you can use the following PowerShell script:
|
||||
```
|
||||
```ps
|
||||
$ErrorActionPreference= 'silentlycontinue'
|
||||
|
||||
Start-Process "$env:ProgramFiles\RustDesk\RustDesk.exe" --get-id
|
||||
@ -154,7 +153,7 @@ Write-Output $rustdesk_id
|
||||
|
||||
## How can I set a persistent password on an agent on my network or using an RMM type system?
|
||||
On Windows you can use the following PowerShell script:
|
||||
```
|
||||
```ps
|
||||
$ErrorActionPreference = 'silentlycontinue'
|
||||
|
||||
net stop rustdesk > null
|
||||
@ -184,19 +183,19 @@ Please file via [GitHub](https://github.com/rustdesk/rustdesk-server-pro/issues)
|
||||
2. We want to be here and still making great progress in years to come.
|
||||
3. The open source version will continue to be open source and we encourage others to make developments in line with the AGPL license.
|
||||
|
||||
## I cant connect to devices in different groups, why is this?
|
||||
## I can't connect to devices in different groups, why is this?
|
||||
This is easily sorted, you need to allow cross-group access.
|
||||
1. Add new Groups.
|
||||
2. Click Edit.
|
||||
1. Add new groups.
|
||||
2. Click `Edit`.
|
||||
3. Select the relevant groups you want access (it automatically adds them in the corresponding group).
|
||||
|
||||
## How do I get configs automatically?
|
||||
## How can I get configs automatically?
|
||||
Configs are generated automatically.
|
||||
1. Download the newest clients from [GitHub](https://github.com/rustdesk/rustdesk/releases/latest).
|
||||
2. On the main page in the web console click on Windows EXE.
|
||||
2. On the main page in the web console click on `Windows EXE`.
|
||||
3. Fill in the host and API (if different from your config).
|
||||
4. Click Submit.
|
||||
5. Scan QR code on Android and rename exe to what has been generated.
|
||||
4. Click `Submit`.
|
||||
5. Scan QR Code on Android and rename exe to what has been generated.
|
||||
|
||||
## Do you offer hosting for RustDesk Server Pro?
|
||||
Please get in touch with our [sales](mailto://sales@rustdesk.com) team.
|
||||
@ -209,8 +208,8 @@ Ensure API is set on both the device being controlled and the machine controllin
|
||||
On the left hand side click on `Logs`.
|
||||
|
||||
## How can I uninstall RustDesk Server Pro?
|
||||
Run the following commands
|
||||
```
|
||||
Run the following commands:
|
||||
```sh
|
||||
sudo systemctl stop rustdesk-hbbs.service
|
||||
sudo systemctl disable rustdesk-hbbs.service
|
||||
sudo systemctl stop rustdesk-hbbr.service
|
||||
@ -223,7 +222,7 @@ sudo rm /usr/bin/hbbr
|
||||
sudo rm -rf /var/lib/rustdesk-server/
|
||||
sudo rm -rf /var/log/rustdesk-server/
|
||||
```
|
||||
If the script installed nginx then remove using
|
||||
```
|
||||
If the script installed Nginx then remove using:
|
||||
```sh
|
||||
sudo apt remove nginx
|
||||
```
|
||||
|
||||
@ -9,7 +9,7 @@ Install the server after choosing your preferred option between Docker or Direct
|
||||
|
||||
* [ ] Change your admin password.
|
||||
* [ ] Read FAQs
|
||||
* [ ] Setup Email.
|
||||
* [ ] Setup Email
|
||||
|
||||
### Setup Users and Groups
|
||||
|
||||
@ -24,6 +24,5 @@ Install the server after choosing your preferred option between Docker or Direct
|
||||
|
||||
## At least every 60 days
|
||||
|
||||
* [ ] Server [OS updates]
|
||||
* [ ] Server (OS updates)
|
||||
* [ ] RustDesk Updates
|
||||
|
||||
|
||||
@ -35,15 +35,15 @@ Don't forget to get your license from [https://rustdesk.com/pricing.html](https:
|
||||
|
||||
### Manual Installation
|
||||
|
||||
Almost the same as [the open source version](/docs/en/self-host/install/), but you do not need to run hbbs/hbbr with any arguments, these can be set later in web console.
|
||||
Almost the same as [the open source version](https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/install/), but you do not need to run hbbs/hbbr with any arguments, these can be set later in web console.
|
||||
|
||||
- `-k _` is set by default
|
||||
- `-r <server:host>` is not needed any more if the relay server runs on the same machine with hbbs, and you can set multiple relay servers in the web console
|
||||
|
||||
### Ports Required
|
||||
|
||||
You need port 21114-21119 TCP and 21116 UDP open, please ensure these ports are setup when you set firewall rules and docker port mapping.
|
||||
You need port 21114-21119 TCP and 21116 UDP open, please ensure these ports are setup when you set firewall rules and Docker port mapping.
|
||||
|
||||
{{% notice note %}}
|
||||
You should use a proxy like nginx to deliver this over HTTPS requiring port 443 to be opened.
|
||||
You should use a proxy like Nginx to deliver this over HTTPS requiring port 443 to be opened.
|
||||
{{% /notice %}}
|
||||
|
||||
@ -16,7 +16,7 @@ Features:
|
||||
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.
|
||||
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>
|
||||
@ -26,21 +26,21 @@ Non-administrator users can also login to browse their device and logs, change t
|
||||
|
||||
## Windows EXE is where the configs are shown
|
||||
|
||||
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`**.
|
||||
|
||||
## Creating a new user other than the default `admin` user.
|
||||
## Creating a new user other than the default `admin` user
|
||||
1. Create another account with `administrator` enabled.
|
||||
2. Log in with the new administrative account.
|
||||
3. Delete the `admin` on `Users` page.
|
||||
|
||||
## Setting up multiple relay servers.
|
||||
## Setting up multiple relay servers
|
||||
1. Go to `Settings` on the left hand menu.
|
||||
2. Click on `Relay` on the sub-menu.
|
||||
3. Click `+` next to `Relay Servers`.
|
||||
4. Enter the Relay server DNS address or IP address in the box which now shows and press Enter.
|
||||
5. If you have more than one Relay server you can keep clicking `+` and adapt the Geo settings is required (remember and copy your key to the other servers).
|
||||
|
||||
## Set or change the license.
|
||||
## Set or change the license
|
||||
1. Go to `Settings` on the left hand menu.
|
||||
2. Click on `License` on the sub-menu.
|
||||
3. Click `Edit` and paste in your license code.
|
||||
@ -49,7 +49,7 @@ For Windows clients, you can leave out the custom server configuration and put t
|
||||
## Viewing Logs
|
||||
On the left hand side click on `Logs`.
|
||||
|
||||
## Setup Emails.
|
||||
## Setup Emails
|
||||
Gmail in this example
|
||||
|
||||
1. Go to `Settings` on the left hand menu.
|
||||
@ -62,6 +62,6 @@ Gmail in this example
|
||||
8. Click `Check` to save.
|
||||
|
||||
## Searching for a device
|
||||
1. Go to Devices
|
||||
2. In the Device Name Search Field type in the name and click Query or hit enter
|
||||
3. To use a wildcard add % at the start, end or both of the search term.
|
||||
1. Go to Devices.
|
||||
2. In the Device Name Search Field type in the name and click `Query` or hit enter.
|
||||
3. To use a wildcard add `%` at the start, end or both of the search term.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user