extern/doc.rustdesk.com
1
0
Fork 1
mirror of https://github.com/rustdesk/doc.rustdesk.com.git synced 2025-06-20 17:57:47 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #327 from Mr-Update/patch-11

Browse Source 
Small corrections
This commit is contained in:
RustDesk 2023-10-22 12:58:34 +08:00 committed by GitHub
commit 5de213ef0f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 137 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
content/client/_index.en.md
View File

@ -29,7 +29,7 @@ To install silently call the install exe with `--silent-install`.
#### macOS #### macOS
Download the dmg file from GitHub more info can be found on the [macOS page](/docs/en/client/mac/). Download the dmg file from GitHub more info can be found on the [macOS page](https://rustdesk.com/docs/en/client/mac/).
Open the dmg file and drag `RustDesk` to `Applications`. Open the dmg file and drag `RustDesk` to `Applications`.
@ -66,7 +66,7 @@ sudo pacman -U ./rustdesk-<version>.pkg.tar.zst
sudo zypper install --allow-unsigned-rpm ./rustdesk-<version>-suse.rpm sudo zypper install --allow-unsigned-rpm ./rustdesk-<version>-suse.rpm
``` ```
#### Android #### Android
Install apk from our GitHub more info can be found on the [Android page](/docs/en/client/android/). Install apk from our GitHub more info can be found on the [Android page](https://rustdesk.com/docs/en/client/android/).
#### iOS (iPhone, iPad) #### iOS (iPhone, iPad)
Download the app from the [App Store](https://apps.apple.com/us/app/rustdesk-remote-desktop/id1581225015). Download the app from the [App Store](https://apps.apple.com/us/app/rustdesk-remote-desktop/id1581225015).
@ -74,7 +74,7 @@ Download the app from the [App Store](https://apps.apple.com/us/app/rustdesk-rem
### Usage ### 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 set up your own server". In the Top left you will see your (2) ID, (3) One Time Password and on the Right a (4) 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 set up your own server". In the Top left you will see your (2) ID, (3) One Time Password and on the Right a (4) box for you to connect to another computer if you know their ID.
![image](/docs/en/client/images/client.png) ![](/docs/en/client/images/client.png)
To access the settings, click on the (5) Menu button [ &#8942; ] to the right of ID. To access the settings, click on the (5) Menu button [ &#8942; ] to the right of ID.
@ -99,7 +99,7 @@ You can manually setup a client. To do this:
3. Click Unlock Network Settings. 3. Click Unlock Network Settings.
4. Enter your ID, Relay, API (if using pro) servers and your key. 4. Enter your ID, Relay, API (if using pro) servers and your key.
![image](/docs/en/client/images/network-settings.png) ![](/docs/en/client/images/network-settings.png)
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.
@ -112,3 +112,4 @@ If you manually setup a client, you can retrieve the `RustDesk2.toml` (in the us
Additional Advanced parameters can be found [here](https://github.com/rustdesk/rustdesk/blob/bdc5cded221af9697eb29aa30babce75e987fcc9/src/core_main.rs#L242). Additional Advanced parameters can be found [here](https://github.com/rustdesk/rustdesk/blob/bdc5cded221af9697eb29aa30babce75e987fcc9/src/core_main.rs#L242).
{{% children depth="1" showhidden="true" %}} {{% children depth="1" showhidden="true" %}}

37
content/dev/build/android/_index.en.md
View File

@ -4,7 +4,7 @@ weight: 22
--- ---
{{% notice note %}} {{% notice note %}}
This tutorial suppose that you are **familiar** with [Android NDK](https://developer.android.com/ndk/downloads), [Rust](https://rustup.rs/) and [Flutter](https://flutter.dev/). If you are not, please skip. This tutorial suppose that you are **familiar** with [Android NDK](https://developer.android.com/ndk/downloads), [Flutter](https://flutter.dev/) and [Rust](https://rustup.rs/). If you are not, please skip.
Or you can go further but at your own risk. Or you can go further but at your own risk.
{{% /notice %}} {{% /notice %}}
@ -12,7 +12,7 @@ Or you can go further but at your own risk.
It is possible to build RustDesk Android on **Windows** and **macOS** but this instruction is still under active development. It is possible to build RustDesk Android on **Windows** and **macOS** but this instruction is still under active development.
{{% /notice %}} {{% /notice %}}
## Introduction ### Introduction
Here you will learn how to prepare your environment to such an extent that you will be able to successfully build the application and enable yourself to work on the code through, for example, Android Studio. Here you will learn how to prepare your environment to such an extent that you will be able to successfully build the application and enable yourself to work on the code through, for example, Android Studio.
@ -22,22 +22,22 @@ It is possible to build, run end edit Android version on Windows, but it require
By "patched" I mean directory in state like before running `flutter build` on Linux machine. By "patched" I mean directory in state like before running `flutter build` on Linux machine.
## Assumptions ### Assumptions
- You are using **Ubuntu 20.04** or later (due to fact that this tutorial is based on this version) - You are using **Ubuntu 20.04** or later (due to fact that this tutorial is based on this version)
- You have working internet connection - You have working internet connection
- You already installed [**Flutter**](https://docs.flutter.dev/get-started/install/linux), [**vcpkg**](https://github.com/microsoft/vcpkg) and [**Rust**](https://www.rust-lang.org/tools/install) - You already installed [**Flutter**](https://docs.flutter.dev/get-started/install/linux), [**Rust**](https://www.rust-lang.org/tools/install) and [**vcpkg**](https://github.com/microsoft/vcpkg)
- You cloned [RustDesk repository](https://github.com/rustdesk/rustdesk) - You cloned [RustDesk repository](https://github.com/rustdesk/rustdesk)
- You know what are you doing - You know what are you doing
## System ### System
This part of tutorial is based on clean **Ubuntu 20.04** instance with prerequisites like **Flutter**, **Rust** and **vcpkg** already installed and configured. This part of tutorial is based on clean **Ubuntu 20.04** instance with prerequisites like **Flutter**, **Rust** and **vcpkg** already installed and configured.
If you missing any of these prerequisites, obtain and configure them, then return back here. If you missing any of these prerequisites, obtain and configure them, then return back here.
## Instruction ### Instruction
This is step-to-step instruction. This is step-to-step instruction.
## Generating Bridge 🌉 ### Generating Bridge 🌉
Due to fact that this project is based on [Flutter Rust Bridge](https://cjycode.com/flutter_rust_bridge/index.html) you should first generate it, you can achieve it by running following commands. Due to fact that this project is based on [Flutter Rust Bridge](https://cjycode.com/flutter_rust_bridge/index.html) you should first generate it, you can achieve it by running following commands.
@ -65,7 +65,7 @@ sudo apt install ca-certificates -y
sudo apt update -y sudo apt update -y
sudo apt install -y g++ gcc git curl wget nasm yasm libgtk-3-dev clang cmake libclang-dev ninja-build llvm-dev libclang-10-dev llvm-10-dev pkg-config sudo apt install -y g++ gcc git curl wget nasm yasm libgtk-3-dev clang cmake libclang-dev ninja-build llvm-dev libclang-10-dev llvm-10-dev pkg-config
``` ```
### Installing Flutter Rust Bridge dependencies #### Installing Flutter Rust Bridge dependencies
At this step you'll install additional dependencies required by [Flutter Rust Bridge](https://cjycode.com/flutter_rust_bridge/index.html) also you'll download Flutter dependencies from `pubspec.yaml` file. At this step you'll install additional dependencies required by [Flutter Rust Bridge](https://cjycode.com/flutter_rust_bridge/index.html) also you'll download Flutter dependencies from `pubspec.yaml` file.
This might take some time depending on your internet connection speed and overall desktop performance: This might take some time depending on your internet connection speed and overall desktop performance:
@ -73,7 +73,7 @@ This might take some time depending on your internet connection speed and overal
cargo install flutter_rust_bridge_codegen cargo install flutter_rust_bridge_codegen
pushd flutter && flutter pub get && popd pushd flutter && flutter pub get && popd
``` ```
### Generating bridge files #### Generating bridge files
In order for everything to work you'll need to generate Flutter Rust Bridge, in order to do it simply run: In order for everything to work you'll need to generate Flutter Rust Bridge, in order to do it simply run:
``` ```
@ -86,9 +86,9 @@ If everything worked fine, you should see something like this in your terminal w
2023/02/27 20:44:39 [INFO] Now go and use it :) 2023/02/27 20:44:39 [INFO] Now go and use it :)
``` ```
## Building RustDesk for Android 📱 ### Building RustDesk for Android 📱
### Installing dependencies #### Installing dependencies
At this step you might require some additional dependencies, you could install them by running this: At this step you might require some additional dependencies, you could install them by running this:
``` ```
@ -100,7 +100,7 @@ You might also need to activate ffigen:
dart pub global activate ffigen 5.0.1 dart pub global activate ffigen 5.0.1
``` ```
### Downloading additional dependencies #### Downloading additional dependencies
For this tutorial we prepared some dependencies for you, feel free to use them. It requires `vcpkg` to be installed, in this case at `/opt`: For this tutorial we prepared some dependencies for you, feel free to use them. It requires `vcpkg` to be installed, in this case at `/opt`:
``` ```
@ -110,7 +110,7 @@ sudo tar xzf dep.tar.gz
popd popd
``` ```
#### Warning ##### Warning
It requires vcpkg directory to be at `$HOME`, if `Building rustdesk lib` part of this instruction will throw errors like: It requires vcpkg directory to be at `$HOME`, if `Building rustdesk lib` part of this instruction will throw errors like:
```yaml ```yaml
error: failed to run custom build command for `magnum-opus v0.4.0 (https://github.com/rustdesk/magnum-opus#79be072c)` error: failed to run custom build command for `magnum-opus v0.4.0 (https://github.com/rustdesk/magnum-opus#79be072c)`
@ -133,13 +133,13 @@ sudo tar xzf dep.tar.gz
popd popd
``` ```
### Disabling Flutter Rust Bridge build #### Disabling Flutter Rust Bridge build
You'll might need to disable building Flutter Rust Bridge from `build.rs` file, you can do it by running: You'll might need to disable building Flutter Rust Bridge from `build.rs` file, you can do it by running:
``` ```
sed -i "s/gen_flutter_rust_bridge();/\/\//g" build.rs sed -i "s/gen_flutter_rust_bridge();/\/\//g" build.rs
``` ```
### Building rustdesk lib #### Building rustdesk lib
At this step you'll build `librustdesk.so` file. At this step you'll build `librustdesk.so` file.
First, add triplet to rust: First, add triplet to rust:
@ -164,7 +164,7 @@ Then simply run:
./flutter/ndk_arm64.sh ./flutter/ndk_arm64.sh
``` ```
### Moving generated library into jniLibs directory #### Moving generated library into jniLibs directory
If you generated `librustdesk.so` then create proper directory: If you generated `librustdesk.so` then create proper directory:
``` ```
mkdir -p ./flutter/android/app/src/main/jniLibs/arm64-v8a mkdir -p ./flutter/android/app/src/main/jniLibs/arm64-v8a
@ -174,7 +174,7 @@ And just copy it there:
cp ./target/aarch64-linux-android/release/liblibrustdesk.so ./flutter/android/app/src/main/jniLibs/arm64-v8a/librustdesk.so cp ./target/aarch64-linux-android/release/liblibrustdesk.so ./flutter/android/app/src/main/jniLibs/arm64-v8a/librustdesk.so
``` ```
### Building RustDesk #### Building RustDesk
It's the last step, now you will build your version of RustDesk apk. It's the last step, now you will build your version of RustDesk apk.
If you done everything correctly you'll be able to build it with ease. If you done everything correctly you'll be able to build it with ease.
@ -211,8 +211,9 @@ If your result is like `✓ Built build/app` then ignore it, it just means that
{{% /notice %}} {{% /notice %}}
### Optional #### Optional
If you want you might move builded app somewhere else, feel free to run: If you want you might move builded app somewhere else, feel free to run:
``` ```
mv build/app/outputs/flutter-apk/app-arm64-v8a-release.apk ../rustdesk-release.apk mv build/app/outputs/flutter-apk/app-arm64-v8a-release.apk ../rustdesk-release.apk
``` ```

23
content/dev/build/linux/_index.en.md
View File

@ -3,7 +3,7 @@ title: Linux
weight: 10 weight: 10
--- ---
## Dependencies ### Dependencies
Desktop versions use [Sciter](https://sciter.com/) for GUI, please download Sciter dynamic library yourself. Desktop versions use [Sciter](https://sciter.com/) for GUI, please download Sciter dynamic library yourself.
@ -11,38 +11,38 @@ Desktop versions use [Sciter](https://sciter.com/) for GUI, please download Scit
[Linux](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.lnx/x64/libsciter-gtk.so) | [Linux](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.lnx/x64/libsciter-gtk.so) |
[macOS](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.osx/libsciter.dylib) [macOS](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.osx/libsciter.dylib)
## Raw steps to build ### Raw steps to build
- Prepare your Rust development env and C++ build env - Prepare your Rust development env and C++ build env
- Install [vcpkg](https://github.com/microsoft/vcpkg), and set `VCPKG_ROOT` env variable correctly - Install [vcpkg](https://github.com/microsoft/vcpkg) and set `VCPKG_ROOT` env variable correctly
- Windows: `vcpkg install libvpx:x64-windows-static libyuv:x64-windows-static opus:x64-windows-static aom:x64-windows-static` - Windows: `vcpkg install libvpx:x64-windows-static libyuv:x64-windows-static opus:x64-windows-static aom:x64-windows-static`
- Linux/macOS: `vcpkg install libvpx libyuv opus aom` - Linux/macOS: `vcpkg install libvpx libyuv opus aom`
- Run `cargo run` - Run `cargo run`
## How to build on Linux ### How to build on Linux
### Ubuntu 18 (Debian 10) #### Ubuntu 18 (Debian 10)
```sh ```sh
sudo apt install -y g++ gcc git curl wget nasm yasm libgtk-3-dev clang libxcb-randr0-dev libxdo-dev libxfixes-dev libxcb-shape0-dev libxcb-xfixes0-dev libasound2-dev libpulse-dev cmake sudo apt install -y g++ gcc git curl wget nasm yasm libgtk-3-dev clang libxcb-randr0-dev libxdo-dev libxfixes-dev libxcb-shape0-dev libxcb-xfixes0-dev libasound2-dev libpulse-dev cmake
``` ```
### Fedora 28 (CentOS 8) #### Fedora 28 (CentOS 8)
```sh ```sh
sudo yum -y install gcc-c++ git curl wget nasm yasm gcc gtk3-devel clang libxcb-devel libxdo-devel libXfixes-devel pulseaudio-libs-devel cmake alsa-lib-devel sudo yum -y install gcc-c++ git curl wget nasm yasm gcc gtk3-devel clang libxcb-devel libxdo-devel libXfixes-devel pulseaudio-libs-devel cmake alsa-lib-devel
``` ```
### Arch (Manjaro) #### Arch (Manjaro)
```sh ```sh
sudo pacman -Syu --needed unzip git cmake gcc curl wget yasm nasm zip make pkg-config clang gtk3 xdotool libxcb libxfixes alsa-lib pulseaudio sudo pacman -Syu --needed unzip git cmake gcc curl wget yasm nasm zip make pkg-config clang gtk3 xdotool libxcb libxfixes alsa-lib pulseaudio
``` ```
### Install vcpkg #### Install vcpkg
```sh ```sh
git clone https://github.com/microsoft/vcpkg git clone https://github.com/microsoft/vcpkg
@ -54,7 +54,7 @@ export VCPKG_ROOT=$HOME/vcpkg
vcpkg/vcpkg install libvpx libyuv opus aom vcpkg/vcpkg install libvpx libyuv opus aom
``` ```
### Fix libvpx (for Fedora) #### Fix libvpx (for Fedora)
```sh ```sh
cd vcpkg/buildtrees/libvpx/src cd vcpkg/buildtrees/libvpx/src
@ -67,7 +67,7 @@ cp libvpx.a $HOME/vcpkg/installed/x64-linux/lib/
cd cd
``` ```
### Build #### Build
```sh ```sh
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
@ -80,8 +80,9 @@ mv libsciter-gtk.so target/debug
VCPKG_ROOT=$HOME/vcpkg cargo run VCPKG_ROOT=$HOME/vcpkg cargo run
``` ```
### Change Wayland to X11 (Xorg) #### Change Wayland to X11 (Xorg)
~~RustDesk does not support Wayland.~~ Check this [guide](https://docs.fedoraproject.org/en-US/quick-docs/configuring-xorg-as-default-gnome-session/) to configuring Xorg as the default GNOME session. ~~RustDesk does not support Wayland.~~ Check this [guide](https://docs.fedoraproject.org/en-US/quick-docs/configuring-xorg-as-default-gnome-session/) to configuring Xorg as the default GNOME session.
RustDesk now has experimental Wayland support. You may need to download the [nightly version](https://github.com/rustdesk/rustdesk/releases/tag/nightly) to enable this feature. RustDesk now has experimental Wayland support. You may need to download the [nightly version](https://github.com/rustdesk/rustdesk/releases/tag/nightly) to enable this feature.

19
content/dev/build/windows/_index.en.md
View File

@ -7,18 +7,18 @@ weight: 20
The command line commands here must be run in Git Bash not command prompt or you will get syntax errors. The command line commands here must be run in Git Bash not command prompt or you will get syntax errors.
{{% /notice %}} {{% /notice %}}
## Dependencies ### Dependencies
### C++ build environment #### C++ build environment
Download [MSVC](https://visualstudio.microsoft.com/) and install. Download [MSVC](https://visualstudio.microsoft.com/) and install.
Select `Windows` as Developer machine OS and check `C++`, then download Visual Studio Community version and install. The installation may take a while. Select `Windows` as Developer machine OS and check `C++`, then download Visual Studio Community version and install. The installation may take a while.
### Rust develop environment #### Rust develop environment
Download [rustup-init.exe](https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe) and run it as administrator to install `rust`. Download [rustup-init.exe](https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe) and run it as administrator to install `rust`.
### vcpkg #### vcpkg
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`. 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). If you don't have `Git` installed, get `Git` [here](https://git-scm.com/download/win).
@ -37,19 +37,19 @@ Add System environment variable `VCPKG_ROOT`=`<path>\vcpkg`. The `<path>` should
![](/docs/en/dev/build/windows/images/env.png) ![](/docs/en/dev/build/windows/images/env.png)
### Sciter #### Sciter
Desktop versions use [Sciter](https://sciter.com/) for GUI, please download [sciter.dll](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.win/x64/sciter.dll). Desktop versions use [Sciter](https://sciter.com/) for GUI, please download [sciter.dll](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.win/x64/sciter.dll).
### LLVM #### 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 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). 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 ### Build
### Default #### Default
```sh ```sh
git clone https://github.com/rustdesk/rustdesk git clone https://github.com/rustdesk/rustdesk
@ -59,3 +59,4 @@ wget https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.win/x64/sci
mv sciter.dll target/debug mv sciter.dll target/debug
cargo run cargo run
``` ```

6
content/self-host/_index.en.md
View File

@ -8,11 +8,11 @@ If you are using RustDesk you should have your own RustDesk Server, these docs w
Support is available via our [Discord](https://discord.com/invite/nDceKgxnkV) for OSS and [email](mailto:support@rustdesk.com) for Pro. Support is available via our [Discord](https://discord.com/invite/nDceKgxnkV) for OSS and [email](mailto:support@rustdesk.com) for Pro.
## Basic Setup ### Basic Setup
https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/install/#set-up-your-own-server-instance-manually https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/install/#set-up-your-own-server-instance-manually
## Ports Required ### Ports Required
Ports required for RustDesk Server self-hosting depends largely on your environment and what you want to do with RustDesk. The Examples shown throughout the docs will have generally have all ports suggested to be opened. Ports required for RustDesk Server self-hosting depends largely on your environment and what you want to do with RustDesk. The Examples shown throughout the docs will have generally have all ports suggested to be opened.
@ -26,7 +26,7 @@ Additionally TCP ports `21118` and `21119` can be opened if you want to use the
For Pro users without an SSL Proxy you will need to open TCP port `21114` for the API to work alternatively using an SSL Proxy open TCP port `443`. For Pro users without an SSL Proxy you will need to open TCP port `21114` for the API to work alternatively using an SSL Proxy open TCP port `443`.
## Test Ports are opened ### Test Ports are opened
To check ports are opened and working you can use `test-netconnection domain.com -p 21115` with PowerShell or [CanYouSeeMe.org](https://canyouseeme.org/). To check ports are opened and working you can use `test-netconnection domain.com -p 21115` with PowerShell or [CanYouSeeMe.org](https://canyouseeme.org/).

22
content/self-host/client-configuration/_index.en.md
View File

@ -12,7 +12,7 @@ There are a number of ways to configure RustDesk Clients to use your own self-ho
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. 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.
![image](/docs/en/self-host/client-configuration/images/network-config.png) ![](/docs/en/self-host/client-configuration/images/network-config.png)
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). 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).
@ -34,17 +34,18 @@ As a `Pro` user you will be able to retrieve the `Key` from the [web console](ht
![](/docs/en/self-host/rustdesk-server-pro/console/images/console-home.png?v2) ![](/docs/en/self-host/rustdesk-server-pro/console/images/console-home.png?v2)
#### Set `API server` ### Set `API Server`
This is for `Pro` user only. When you can log in on web console, but fail to log in on RustDesk client, it probably you have not set `API serer` correctly.
If your API server does not run on default `21114` port, please specify `API Server` explicitly. This is for `Pro` user only. When you can log in on web console, but fail to log in on RustDesk client, it probably you have not set `API Server` correctly.
e.g. your API server runs on default https port, please specify `API Server` with `https://hbbs.example.com`.
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). If your API Server does not run on default `21114` port, please specify `API Server` explicitly.
e.g. your API Server runs on default https port, please specify `API Server` with `https://hbbs.example.com`.
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).
### Setup Using Import or Export ### Setup Using Import or Export
1. Use the steps [above](/docs/en/self-host/client-configuration/#manual-config) to configure RustDesk Client on a Device. 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. 2. Using the above machine go to Settings then Network and unlock.
3. Click on `Export Server Config`. 3. Click on `Export Server Config`.
4. Paste the copied string into Notepad or similar. 4. Paste the copied string into Notepad or similar.
@ -59,7 +60,7 @@ 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 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](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.
#### Put config in rustdesk.exe file name (Windows only) #### Put config in rustdesk.exe file name (Windows only)
@ -80,8 +81,8 @@ 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. repeat this process until you get valid characters.
{{% /notice %}} {{% /notice %}}
### [Hardcoding](https://rustdesk.com/docs/en/self-host/client-configuration/hardcode-settings/)
### [Hardcoding](/docs/en/self-host/client-configuration/hardcode-settings/)
### Logging your user in (RustDesk Server Pro) ### Logging your user in (RustDesk Server Pro)
To sign in with RustDesk Server Pro, ensure your client is setup correctly, click on `Settings` and click `Account` and then `Login`, enter username and password and then Login. To sign in with RustDesk Server Pro, ensure your client is setup correctly, click on `Settings` and click `Account` and then `Login`, enter username and password and then Login.
@ -97,6 +98,7 @@ To add devices to your address book, after you have connected to a device they w
You can add and assign Tags in your address book to help organize 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. 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](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console/#add-new-groups) as well.
If you would like to add devices to your own address book, you can click on the Menu button [ &#8942; ] next to the device and click `Add to address book`. If you would like to add devices to your own address book, you can click on the Menu button [ &#8942; ] next to the device and click `Add to address book`.

5
content/self-host/client-configuration/hardcode-settings/_index.en.md
View File

@ -5,7 +5,7 @@ weight: 49
### Custom Server ### Custom Server
{{% notice note %}} {{% notice note %}}
To hardcode custom server settings into your executables you must [build](/docs/en/dev/build/) the client yourself on your machine or [with GitHub Actions](/docs/en/dev/build/all/). To hardcode custom server settings into your executables you must [build](https://rustdesk.com/docs/en/dev/build/) the client yourself on your machine or [with GitHub Actions](https://rustdesk.com/docs/en/dev/build/all/).<br>
**Noted**: [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners) for Arm are used in our GitHub actions, please set it up yourself. **Noted**: [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners) for Arm are used in our GitHub actions, please set it up yourself.
{{% /notice %}} {{% /notice %}}
{{% notice note %}} {{% notice note %}}
@ -25,9 +25,10 @@ rustdesk.my-domain.com
``` ```
#### RS_PUB_KEY #### RS_PUB_KEY
This variable will be your public key, more information on the key is available [here](/docs/en/self-host/install/#key). This variable will be your public key, more information on the key is available [here](https://rustdesk.com/docs/en/self-host/install/#key).
This should be a string such as This should be a string such as
``` ```
OeVuKk5nlHiXp+APNn0Y3pC1Iwpwn44JGqrQCsWqmBw= OeVuKk5nlHiXp+APNn0Y3pC1Iwpwn44JGqrQCsWqmBw=
``` ```

2
content/self-host/client-deployment/_index.en.md
View File

@ -4,7 +4,7 @@ weight: 400
pre: "<b>2.4. </b>" pre: "<b>2.4. </b>"
--- ---
You can deploy using a number of methods, some are covered in [Client Configuration](/docs/en/self-host/client-configuration/). You can deploy using a number of methods, some are covered in [Client Configuration](https://rustdesk.com/docs/en/self-host/client-configuration/).
Alternatively you can use mass deployment scripts with your RMM, Intune, etc. The ID and password are output by the script. You should collect this or split it 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 are output by the script. You should collect this or split it into different scripts to collect the ID and password.

8
content/self-host/rustdesk-server-oss/Docker/_index.en.md
View File

@ -3,9 +3,9 @@ title: Docker
weight: 7 weight: 7
--- ---
## Install your own server with Docker ### Install your own server with Docker
### Requirements #### Requirements
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! 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), 21116 (TCP/UDP) and 21118 (TCP), `hbbr` listens on 21117 (TCP) and 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.* By default, `hbbs` listens on 21115 (TCP), 21116 (TCP/UDP) and 21118 (TCP), `hbbr` listens on 21117 (TCP) and 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.*
@ -13,7 +13,7 @@ By default, `hbbs` listens on 21115 (TCP), 21116 (TCP/UDP) and 21118 (TCP), `hbb
- TCP (**21115, 21116, 21117, 21118, 21119**) - TCP (**21115, 21116, 21117, 21118, 21119**)
- UDP (**21116**) - UDP (**21116**)
### Docker examples #### Docker examples
```sh ```sh
sudo docker image pull rustdesk/rustdesk-server sudo docker image pull rustdesk/rustdesk-server
@ -33,7 +33,7 @@ If `--net=host` works fine, the `-p` options are not used. If on Windows, leave
If you can not see logs with `-td`, you can see logs via `docker logs hbbs`. Or you can run with `-it`, `hbbs/hbbr` will not run as daemon mode. If you can not see logs with `-td`, you can see logs via `docker logs hbbs`. Or you can run with `-it`, `hbbs/hbbr` will not run as daemon mode.
{{% /notice %}} {{% /notice %}}
### Docker Compose examples #### 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 ```yaml
version: '3' version: '3'

29
content/self-host/rustdesk-server-oss/install/_index.en.md
View File

@ -3,15 +3,15 @@ title: Installation
weight: 1 weight: 1
--- ---
## Install your own server as systemd service using a simple to run install script ### Install your own server as systemd service using a simple to run install script
Script is hosted on [Techahold](https://github.com/techahold/rustdeskinstall) and supported on our [Discord](https://discord.com/invite/nDceKgxnkV). Script is hosted on [Techahold](https://github.com/techahold/rustdeskinstall) and supported on our [Discord](https://discord.com/invite/nDceKgxnkV).
Currently the script will download and setup the Relay and Signal Servers (hbbr and hbbs), generate configs and host them on a password protected web page for simple deployment to clients. Currently the script will download and setup the Relay and Signal Servers (hbbr and hbbs), generate configs and host them on a password protected web page for simple deployment to clients.
### Requirements #### Requirements
You need to have Linux installed, script is tested working with CentOS Linux 7/8, Ubuntu 18/20 and Debian. A server with 1 CPU, 1 GB and 10 GB disk is plenty to run RustDesk. You need to have Linux installed, script is tested working with CentOS Linux 7/8, Ubuntu 18/20 and Debian. A server with 1 CPU, 1 GB RAM and 10 GB disk is plenty to run RustDesk.
#### How to Install the server ##### How to Install the server
Please setup your firewall on your server prior to running the script. Please setup your firewall on your server prior to running the script.
Make sure you have got access via SSH or otherwise setup prior setting up the firewall. The example commands for UFW (Debian based) are: Make sure you have got access via SSH or otherwise setup prior setting up the firewall. The example commands for UFW (Debian based) are:
@ -35,13 +35,13 @@ chmod +x install.sh
``` ```
There is also an update script on [Techahold's](https://github.com/techahold/rustdeskinstall) repository. There is also an update script on [Techahold's](https://github.com/techahold/rustdeskinstall) repository.
## Install your own server as systemd service using deb file for debian distros ### Install your own server as systemd service using deb file for debian distros
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`. 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. ### Set up your own server instance manually.
### STEP 1: Download server-side software programs #### STEP 1: Download server-side software programs
[Download](https://github.com/rustdesk/rustdesk-server/releases/latest). [Download](https://github.com/rustdesk/rustdesk-server/releases/latest).
@ -59,15 +59,15 @@ There are two executables and a folder:
They are built on CentOS Linux 7, tested on CentOS Linux 7/8 and Ubuntu 18/20. They are built on CentOS Linux 7, tested on CentOS Linux 7/8 and Ubuntu 18/20.
#### Server Requirements ##### Server Requirements
The hardware requirements are very low; the minimum configuration of a basic cloud server is enough, and the CPU and memory requirements are minimal. You can also use a Raspberry Pi or something similar. Regarding the network size, if the TCP hole punching direct connection fails, the relay traffic will be consumed. The traffic of a relay connection is between 30 K/s and 3 M/s (1920x1080 screen) depending on the resolution settings and screen update. If it is only for office work demand, the traffic is around 100 K/s. The hardware requirements are very low; the minimum configuration of a basic cloud server is enough, and the CPU and memory requirements are minimal. You can also use a Raspberry Pi or something similar. Regarding the network size, if the TCP hole punching direct connection fails, the relay traffic will be consumed. The traffic of a relay connection is between 30 K/s and 3 M/s (1920x1080 screen) depending on the resolution settings and screen update. If it is only for office work demand, the traffic is around 100 K/s.
### STEP 2: Run hbbs and hbbr on your server #### STEP 2: Run hbbs and hbbr on your server
We suggest you use [PM2](https://pm2.keymetrics.io/) for managing your service. We suggest you use [PM2](https://pm2.keymetrics.io/) for managing your service.
#### Option 1 ##### Option 1
Run hbbs/hbbr without PM2. Run hbbs/hbbr without PM2.
```bash ```bash
@ -75,7 +75,7 @@ Run hbbs/hbbr without PM2.
./hbbr ./hbbr
``` ```
#### Option 2 ##### Option 2
Run hbbs/hbbr with PM2. Run hbbs/hbbr with PM2.
```bash ```bash
@ -97,7 +97,7 @@ By default, `hbbs` listens on 21115 (TCP), 21116 (TCP/UDP) and 21118 (TCP), `hbb
Please run with the `-h` option to see help if you want to choose your own port. Please run with the `-h` option to see help if you want to choose your own port.
### STEP 3: Set hbbs/hbbr address on client-side #### STEP 3: Set hbbs/hbbr address on client-side
Click on the Menu button [ &#8942; ] on the right side of ID as shown below, and choose "ID/Relay Server". Click on the Menu button [ &#8942; ] on the right side of ID as shown below, and choose "ID/Relay Server".
@ -119,7 +119,7 @@ hbbs.example.com:21116
![](/docs/en/self-host/rustdesk-server-oss/install/images/server-set-window.png) ![](/docs/en/self-host/rustdesk-server-oss/install/images/server-set-window.png)
#### Put config in rustdesk.exe file name (Windows only) ##### 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. 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.
@ -134,7 +134,7 @@ 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. repeat this process until you get valid characters.
{{% /notice %}} {{% /notice %}}
## Key ### 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. 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.
@ -160,3 +160,4 @@ You could create keys manually in hbbs and copy them to hbbr before starting the
Or you could stop the hbbr container and copy the keys from hbbs to the hbbr folder, and then restart the container. Or you could stop the hbbr container and copy the keys from hbbs to the hbbr folder, and then restart the container.
{{% /notice %}} {{% /notice %}}

3
content/self-host/rustdesk-server-oss/synology/_index.en.md
View File

@ -29,7 +29,7 @@ Click on above `Advanced Settings`.
- Enable auto-restart - Enable auto-restart
![](/docs/en/self-host/rustdesk-server-oss/synology/images/auto-restart.png) ![](/docs/en/self-host/rustdesk-server-oss/synology/images/auto-restart.png)
- 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). - Enable `Use the same network as Docker Host`, for more about host net, please [check](https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/docker/#net-host).
![](/docs/en/self-host/rustdesk-server-oss/synology/images/host-net.png) ![](/docs/en/self-host/rustdesk-server-oss/synology/images/host-net.png)
- 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 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.
@ -70,3 +70,4 @@ Please repeat above `hbbs` steps, but name the container `hbbr` and command (for
### Retrieve your Key ### 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.

23
content/self-host/rustdesk-server-oss/windows/_index.en.md
View File

@ -3,7 +3,7 @@ title: Windows & PM2 or NSSM
weight: 20 weight: 20
--- ---
## A crossroads ### A crossroads
You now either have two choices, you can either use PM2 (easier) or NSSM (a bit harder) to start the RustDesk server You now either have two choices, you can either use PM2 (easier) or NSSM (a bit harder) to start the RustDesk server
There are some benefits to using NSSM: There are some benefits to using NSSM:
- Backwards compatibility with older Windows (Windows Server 2008 R2/Windows 7 and earlier although untested). - Backwards compatibility with older Windows (Windows Server 2008 R2/Windows 7 and earlier although untested).
@ -17,9 +17,9 @@ While the benefits of PM2 include:
- You logon regularly to the user that created the RustDesk startup entry - You logon regularly to the user that created the RustDesk startup entry
- More user friendly - More user friendly
## Installing using NSSM ### Installing using NSSM
### Installing NSSM #### Installing NSSM
Please [download](https://nssm.cc/release/nssm-2.24.zip) and extract NSSM select the appropriate Please [download](https://nssm.cc/release/nssm-2.24.zip) and extract NSSM select the appropriate
architecture to your Windows system (if x86 use the contents of the win32 folder, if x64 use the architecture to your Windows system (if x86 use the contents of the win32 folder, if x64 use the
contents of win64 folder). It is also best practice to move the binary of NSSM into the contents of win64 folder). It is also best practice to move the binary of NSSM into the
@ -27,7 +27,7 @@ contents of win64 folder). It is also best practice to move the binary of NSSM i
thus it is best to tuck it away in `Program Files`) directory of your Installation drive (Usually the C: drive). thus it is best to tuck it away in `Program Files`) directory of your Installation drive (Usually the C: drive).
It is also advisable to add the path (such as `C:\Program Files\NSSM`) to the path variable. It is also advisable to add the path (such as `C:\Program Files\NSSM`) to the path variable.
### Checking if NSSM is installed properly #### Checking if NSSM is installed properly
If you've done everything correctly the folder `C:\Program Files\NSSM` (in this example I use the C: If you've done everything correctly the folder `C:\Program Files\NSSM` (in this example I use the C:
drive but you can use whatever drive you installed Windows to or whatever path you desire) should drive but you can use whatever drive you installed Windows to or whatever path you desire) should
only contain the file `nssm.exe`. only contain the file `nssm.exe`.
@ -36,7 +36,7 @@ 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 #### Run hbbr and hbbs
Download the Windows version of [RustDesk Server](https://github.com/rustdesk/rustdesk-server/releases). Download the Windows version of [RustDesk Server](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 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.
@ -74,16 +74,16 @@ nssm start <Desired hbbr servicename>
(The method above has been tested on Windows Server Core 2022 Standard). (The method above has been tested on Windows Server Core 2022 Standard).
## or ### or
## Installing using PM2 ### Installing using PM2
### Install Node.js #### Install Node.js
Please [download](https://nodejs.org/dist/v16.14.2/node-v16.14.2-x86.msi) and 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 #### Install PM2
Enter belows in `cmd.exe`, press the <kbd>Enter</kbd> key for each line, and run them line by line. Enter belows in `cmd.exe`, press the <kbd>Enter</kbd> key for each line, and run them line by line.
@ -93,7 +93,7 @@ npm install pm2-windows-startup -g
pm2-startup install pm2-startup install
``` ```
### Run hbbr and hbbs #### Run hbbr and hbbs
Download the Windows version of [RustDesk Server](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): Download the Windows version of [RustDesk Server](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):
@ -104,9 +104,10 @@ pm2 start hbbr.exe
pm2 save pm2 save
``` ```
### View the log #### View the log
```cmd ```cmd
pm2 log hbbr pm2 log hbbr
pm2 log hbbs pm2 log hbbs
``` ```

15
content/self-host/rustdesk-server-pro/FAQ/_index.en.md
View File

@ -4,7 +4,7 @@ weight: 600
--- ---
### How can I install with the Simple Install Script? ### How can I install with the Simple Install Script?
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. 1. Get your license from [https://rustdesk.com/pricing.html](https://rustdesk.com/pricing.html), check [license](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/) page for more details.
2. Spin up a VPS, bare metal or Linux VM. 2. Spin up a VPS, bare metal or Linux VM.
3. If you want to use DNS and SSL create a DNS name i.e. `rustdesk.yourdomain.com`. 3. If you want to use DNS and SSL create a DNS name i.e. `rustdesk.yourdomain.com`.
4. Go to [this page](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/installscript/#install). 4. Go to [this page](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/installscript/#install).
@ -15,7 +15,7 @@ weight: 600
9. Enter your license code purchased in step 1. 9. Enter your license code purchased in step 1.
### How can I convert from RustDesk Server Open Source to RustDesk Server Pro? ### How can I convert from RustDesk Server Open Source to RustDesk Server Pro?
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. 1. Get your license from [https://rustdesk.com/pricing.html](https://rustdesk.com/pricing.html), check [license](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/) page for more details.
2. Open TCP port 21114. 2. Open TCP port 21114.
3. Log into your RustDesk Server. 3. Log into your RustDesk Server.
4. If you didn't already use DNS and want to use SSL create a DNS name i.e. `rustdesk.yourdomain.com`. 4. If you didn't already use DNS and want to use SSL create a DNS name i.e. `rustdesk.yourdomain.com`.
@ -143,9 +143,10 @@ Invoke-WebRequest "https://github.com/rustdesk/rustdesk/releases/download/1.2.2/
Start-Process .\rustdesk.exe --silent-install -wait Start-Process .\rustdesk.exe --silent-install -wait
``` ```
### `Key mismatch` error. ### `Key mismatch` error
Please configure your client with correct key. https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/relay/ Please configure your client with [correct key](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/relay/).
### `Failed to connect to relay server` error
Please make sure `hbbr` is running. More information about `hbbr`, you can find [here](https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/install/).
If your `hbbr` does not run on the same machine of `hbbs`, or you have multiple relay servers, or you do not run it on default port `21117`, you have to tell it to `hbbs` explicitly. Please check [here](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/relay/).
## `Failed to connect to relay server` error.
Please make sure `hbbr` is running. More inforamtion about `hbbr`, you can find here, https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/install/.
If your `hbbr` does not run on the same machine of `hbbs`, or you have multiple relay servers, or you do not run it on default port `21117`, you have to tell it to `hbbs` explictly. please check here, https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/relay/

13
content/self-host/rustdesk-server-pro/_index.en.md
View File

@ -19,31 +19,32 @@ RustDesk Server Pro has more features compared to the open source version.
RustDesk Client >= 1.2.0 required RustDesk Client >= 1.2.0 required
{{% /notice %}} {{% /notice %}}
## Download ### Download
[https://github.com/rustdesk/rustdesk-server-pro/releases/latest](https://github.com/rustdesk/rustdesk-server-pro/releases/latest) [https://github.com/rustdesk/rustdesk-server-pro/releases/latest](https://github.com/rustdesk/rustdesk-server-pro/releases/latest)
## Installation ### Installation
### Simple Install #### Simple Install
To make life easy, we have developed scripts which take care of everything (install/upgrade/convert from open source) [Simple Install Script](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/installscript/). To make life easy, we have developed scripts which take care of everything (install/upgrade/convert from open source) [Simple Install Script](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/installscript/).
{{% notice note %}} {{% notice note %}}
Don't forget to 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. Don't forget to get your license from [https://rustdesk.com/pricing.html](https://rustdesk.com/pricing.html), check [license](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/) page for more details.
{{% /notice %}} {{% /notice %}}
### Manual Installation #### Manual Installation
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. 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 - `-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 - `-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 #### 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 %}} {{% 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 %}} {{% /notice %}}

31
content/self-host/rustdesk-server-pro/console/_index.en.md
View File

@ -11,7 +11,7 @@ Features:
- Update settings - Update settings
- Manage client settings sync strategies - Manage client settings sync strategies
## Log in ### 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: 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:
@ -26,51 +26,51 @@ After logging in please be sure to change the password, select `Settings` in the
Non-administrator users can also login to browse their device and logs, change their user settings. Non-administrator users can also login to browse their device and logs, change their user settings.
## Automatic Configs ### 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. You can use this in conjunction 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 ### 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. 2. Create another account with `administrator` enabled.
3. Log in with the new administrative account. 3. Log in with the new administrative account.
4. Delete the `admin` on `Users` page. 4. Delete the `admin` on `Users` page.
## Creating a new user ### Creating a new user
1. Click On `Users` on the left hand menu. 1. Click On `Users` on the left hand menu.
2. Create a new user. 2. Create a new user.
3. Select what group they should be in (if you need to add new groups please keep reading). 3. Select what group they should be in (if you need to add new groups please keep reading).
## Add a new Group ### Add a new Group
1. Click On `Groups` on the left hand menu. 1. Click On `Groups` on the left hand menu.
2. Create a new group. 2. Create a new group.
3. Once created you can allow groups access each other, Click `Edit`. 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). 4. Select the relevant groups you want access (it automatically adds them in the corresponding group).
## Setting up multiple relay servers ### Setting up multiple relay servers
1. Go to `Settings` on the left hand menu. 1. Go to `Settings` on the left hand menu.
2. Click on `Relay` on the sub-menu. 2. Click on `Relay` on the submenu.
3. Click `+` next to `Relay Servers`. 3. Click `+` next to `Relay Servers`.
4. Enter the Relay server DNS address or IP address in the box which now shows and press <kbd>Enter</kbd>. 4. Enter the Relay server DNS address or IP address in the box which now shows and press <kbd>Enter</kbd>.
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). 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. 1. Go to `Settings` on the left hand menu.
2. Click on `License` on the sub-menu. 2. Click on `License` on the submenu.
3. Click `Edit` and paste in your license code. 3. Click `Edit` and paste in your license code.
4. Click `OK`. 4. Click `OK`.
## Viewing Logs ### Viewing Logs
On the left hand side click on `Logs`. On the left hand side click on `Logs`.
## Setup Emails ### Setup Emails
Gmail in this example Gmail in this example
1. Go to `Settings` on the left hand menu. 1. Go to `Settings` on the left hand menu.
2. Click on `SMTP` on the sub-menu. 2. Click on `SMTP` on the submenu.
3. Enter the SMTP address `smtp.gmail.com`. 3. Enter the SMTP address `smtp.gmail.com`.
4. Enter the Port 587 in `SMTP Port`. 4. Enter the Port 587 in `SMTP Port`.
5. Enter the Gmail account i.e. `myrustdeskserver@gmail.com` in `Mail Account`. 5. Enter the Gmail account i.e. `myrustdeskserver@gmail.com` in `Mail Account`.
@ -78,12 +78,13 @@ Gmail in this example
7. Enter your Gmail account i.e. `myrustdeskserver@gmail.com` in `From`. 7. Enter your Gmail account i.e. `myrustdeskserver@gmail.com` in `From`.
8. Click `Check` to save. 8. Click `Check` to save.
## Assign Device Users and Groups to Devices ### 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 of 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 ### Searching for a device
1. Go to Devices. 1. Go to Devices.
2. In the Device Name Search Field type in the name and click `Query` or hit <kbd>Enter</kbd>. 2. In the Device Name Search Field type in the name and click `Query` or hit <kbd>Enter</kbd>.
3. To use a wildcard add `%` at the start, end or both of the search term. 3. To use a wildcard add `%` at the start, end or both of the search term.

13
content/self-host/rustdesk-server-pro/installscript/_index.en.md
View File

@ -4,10 +4,10 @@ weight: 10
--- ---
{{% notice note %}} {{% notice note %}}
Don't forget to 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. Don't forget to get your license from [https://rustdesk.com/pricing.html](https://rustdesk.com/pricing.html), check [license](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/) page for more details.
{{% /notice %}} {{% /notice %}}
## Install ### Install
Copy and paste the above command into your Linux terminal to install RustDesk Server Pro. Copy and paste the above command into your Linux terminal to install RustDesk Server Pro.
@ -23,7 +23,7 @@ What it does:
- Create systemd services for hbbs and hbbr (service names are rustdesk-hbbs.service and rustdesk-hbbr.service) - Create systemd services for hbbs and hbbr (service names are rustdesk-hbbs.service and rustdesk-hbbr.service)
- If you choose Domain, it will install Nginx and Certbot, allowing the API to be available on port 443 (HTTPS) and get an SSL certificate over port 80, it is automatically renewed - If you choose Domain, it will install Nginx and Certbot, allowing the API to be available on port 443 (HTTPS) and get an SSL certificate over port 80, it is automatically renewed
## Upgrade ### Upgrade
Copy and paste the above command into your Linux terminal to upgrade your existing RustDesk Server Pro Installation, this could also be saved locally and scheduled with cron. Copy and paste the above command into your Linux terminal to upgrade your existing RustDesk Server Pro Installation, this could also be saved locally and scheduled with cron.
@ -34,7 +34,7 @@ What it does:
- Checks for new versions of RustDesk Server Pro - Checks for new versions of RustDesk Server Pro
- If it finds a new version, it removes the API files and downloads new executables and API files - If it finds a new version, it removes the API files and downloads new executables and API files
## Convert from open source ### Convert from open source
Copy and paste the above command into your Linux terminal to convert from RustDesk Server to RustDesk Server Pro. Copy and paste the above command into your Linux terminal to convert from RustDesk Server to RustDesk Server Pro.
@ -51,7 +51,7 @@ What it does:
- Create systemd services for hbbs and hbbr (service names are rustdesk-hbbs.service and rustdesk-hbbr.service) - Create systemd services for hbbs and hbbr (service names are rustdesk-hbbs.service and rustdesk-hbbr.service)
- If you choose Domain, it will install Nginx and Certbot, allowing the API to be available on port 443 (HTTPS) and get an SSL certificate over port 80, it is automatically renewed - If you choose Domain, it will install Nginx and Certbot, allowing the API to be available on port 443 (HTTPS) and get an SSL certificate over port 80, it is automatically renewed
## Backup/Restore ### Backup/Restore
To make life easy we have created a backup and restore script, this will take the keys, all configuration and database and create a tar file which can be saved to else where. To make life easy we have created a backup and restore script, this will take the keys, all configuration and database and create a tar file which can be saved to else where.
@ -73,4 +73,5 @@ chmod +x restore.sh
``` ```
Copy the backup file into the same folder as the restore.sh file and then run `./restore.sh`. Copy the backup file into the same folder as the restore.sh file and then run `./restore.sh`.
This will restore your server to how it was prior, you will need to revoke your [license](/docs/en/self-host/rustdesk-server-pro/license) to move it to the restored server. This will restore your server to how it was prior, you will need to revoke your [license](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/) to move it to the restored server.

2
content/self-host/rustdesk-server-pro/installscript/windows/_index.en.md
View File

@ -5,7 +5,7 @@ weight: 2
### Install ### Install
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. 1. Get your license from [https://rustdesk.com/pricing.html](https://rustdesk.com/pricing.html), check [license](https://rustdesk.com/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). 2. Download the the Windows installer from [GitHub](https://github.com/rustdesk/rustdesk-server-pro/releases/latest).
3. Unzip the Windows installer. 3. Unzip the Windows installer.
4. Run the Installer and follow the steps on screen. 4. Run the Installer and follow the steps on screen.