mirror of
https://github.com/rustdesk/doc.rustdesk.com.git
synced 2024-12-26 17:09:14 +01:00
RustDesk
GitHub
commit
67b7605383
@ -20,7 +20,7 @@ We can help with lots of problems, installations and configurations. Fully manag
|
||||
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 permissions `600`.
|
||||
To provide SSH access to your server for troubleshooting, please add the following key to `~/username/.ssh/authorized_keys` and ensure the file has permissions `600`.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@ -29,7 +29,7 @@ To install silently call the install exe with `--silent-install`.
|
||||
|
||||
#### macOS
|
||||
|
||||
Download the dmg file from GitHub more info can be found on the macOS page.
|
||||
Download the dmg file from GitHub more info can be found on the [macOS page](/docs/en/client/mac/).
|
||||
|
||||
Open the dmg file and drag `RustDesk` to `Applications`.
|
||||
|
||||
@ -66,14 +66,14 @@ sudo pacman -U ./rustdesk-<version>.pkg.tar.zst
|
||||
sudo zypper install --allow-unsigned-rpm ./rustdesk-<version>-suse.rpm
|
||||
```
|
||||
#### Android
|
||||
Install apk from our GitHub more info can be found on the Android page.
|
||||
Install apk from our GitHub more info can be found on the [Android page](/docs/en/client/android/).
|
||||
|
||||
### 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.
|
||||
|
||||
|
||||
|
||||
To access the settings, click on the (5) 3 dots to the right of ID.
|
||||
To access the settings, click on the (5) Menu button [ ⋮ ] to the right of ID.
|
||||
|
||||
Under Settings you will find:
|
||||
- General - Service Control, Theme, Hardware Codec, Audio, Recording and Language
|
||||
@ -87,8 +87,8 @@ Under Settings you will find:
|
||||
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 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`
|
||||
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.
|
||||
|
||||
@ -102,12 +102,12 @@ Above * represents special permissions. To obtain such permissions, you need to
|
||||
|  |
|
||||
|
||||
#### **Special Permission Request - mouse input**
|
||||
| Step 1 Find "Installed Services" | Step 2 Start RustDesk Input |
|
||||
| Step 1: Find "Installed Services" | Step 2: Start RustDesk Input |
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|
||||
{{% notice note %}}
|
||||
The system setting page of different vendors may be different, please adjust it according to your system page
|
||||
The system setting page of different vendors may be different, please adjust it according to your system page.
|
||||
{{% /notice %}}
|
||||
|
||||
**Remote mouse control shortcuts:**
|
||||
|
||||
@ -66,7 +66,7 @@ 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
|
||||
```
|
||||
### 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:
|
||||
```
|
||||
@ -80,7 +80,7 @@ In order for everything to work you'll need to generate Flutter Rust Bridge, in
|
||||
~/.cargo/bin/flutter_rust_bridge_codegen --rust-input ./src/flutter_ffi.rs --dart-output ./flutter/lib/generated_bridge.dart
|
||||
```
|
||||
|
||||
If everything worked fine, you should see something like this in your's terminal window:
|
||||
If everything worked fine, you should see something like this in your terminal window:
|
||||
```yaml
|
||||
2023/02/27 20:44:39 [INFO] Success!
|
||||
2023/02/27 20:44:39 [INFO] Now go and use it :)
|
||||
@ -153,9 +153,9 @@ Then install `cargo-ndk` it is required to generate `librustdesk.so` file:
|
||||
cargo install cargo-ndk
|
||||
```
|
||||
|
||||
Now it's time to run `ndk_arm64.sh`, this script contains code that build's Rust for Flutter, it requires `NDK` in version `r23c`.
|
||||
Now it's time to run `ndk_arm64.sh`. This script contains code that builds Rust for Flutter, it requires `NDK` in version `r23c`.
|
||||
|
||||
You could download it [here](https://dl.google.com/android/repository/android-ndk-r23c-linux.zip), you'll be required to install it manually or follow this [instruction](https://developer.android.com/studio/projects/install-ndk). This file is quite heavy so this process might take a while, it mostly depends on your internet connection.
|
||||
You could download it [here](https://dl.google.com/android/repository/android-ndk-r23c-linux.zip). You'll be required to install it manually or follow this [instruction](https://developer.android.com/studio/projects/install-ndk). This file is quite heavy so this process might take a while, it mostly depends on your internet connection.
|
||||
|
||||
Just remember to set **ANDROID_NDK_HOME** variable and check if it's valid.
|
||||
|
||||
|
||||
@ -82,4 +82,6 @@ VCPKG_ROOT=$HOME/vcpkg cargo run
|
||||
|
||||
### 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.
|
||||
|
||||
@ -4,14 +4,14 @@ weight: 20
|
||||
---
|
||||
|
||||
{{% notice note %}}
|
||||
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 %}}
|
||||
|
||||
## Dependencies
|
||||
|
||||
### 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.
|
||||
|
||||
### Rust develop environment
|
||||
@ -20,8 +20,8 @@ Download [rustup-init.exe](https://static.rust-lang.org/rustup/dist/x86_64-pc-wi
|
||||
|
||||
### 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`.
|
||||
If you don't have `git` installed, get `git` [here](https://git-scm.com/download/win).
|
||||
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).
|
||||
|
||||
```sh
|
||||
git clone https://github.com/microsoft/vcpkg
|
||||
@ -39,13 +39,13 @@ Add System environment variable `VCPKG_ROOT`=`<path>\vcpkg`. The `<path>` should
|
||||
|
||||
### 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
|
||||
|
||||
`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
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ There are a number of ways to configure RustDesk clients to use your own self-ho
|
||||
|
||||
### Manual Config
|
||||
|
||||
In the main RustDesk Client home click on the 3 dots 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 [ ⋮ ] 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.
|
||||
|
||||
|
||||
|
||||
@ -30,20 +30,20 @@ hbbs.example.com:21116
|
||||
|
||||
### 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
|
||||
2. Using the above machine go to Settings then Network and unlock
|
||||
3. Click on `Export Server Config`
|
||||
4. Paste the copied string into Notepad or similar
|
||||
5. Go to new client, copy the above to clipboard
|
||||
6. Go to Settings then Network in RustDesk Client, unlock and click `Import Server Config`
|
||||
7. It will automatically paste the settings in
|
||||
8. Click `Apply`
|
||||
1. Use the steps [above](/docs/en/self-host/client-configuration/#manual-config) to configure RustDesk Client on a Device.
|
||||
2. Using the above machine go to Settings then Network and unlock.
|
||||
3. Click on `Export Server Config`.
|
||||
4. Paste the copied string into Notepad or similar.
|
||||
5. Go to new client, copy the above to clipboard.
|
||||
6. Go to Settings then Network in RustDesk Client, unlock and click `Import Server Config`.
|
||||
7. It will automatically paste the settings in.
|
||||
8. Click `Apply`.
|
||||
|
||||
### Automatic Config
|
||||
|
||||
The easiest way to setup automatically is using deployment scripts found [here](https://rustdesk.com/docs/en/self-host/client-deployment/).
|
||||
|
||||
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 then reverse it using [this site](https://string-functions.com/reverse.aspx).
|
||||
|
||||
@ -62,5 +62,4 @@ 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 %}}
|
||||
|
||||
|
||||
### [Hardcoding](/docs/en/self-host/client-configuration/hardcode-settings/)
|
||||
|
||||
@ -4,6 +4,6 @@ weight: 400
|
||||
pre: "<b>2.4.1 </b>"
|
||||
---
|
||||
|
||||
RustDesk has successfully been integrated into a number of other projects, please see some below. If your project wants to integrate with RustDesk or you have already integrated RustDesk please let us know via support@rustdesk.com and we can add to our docs.
|
||||
RustDesk has successfully been integrated into a number of other projects, please see some below. If your project wants to integrate with RustDesk or you have already integrated RustDesk please let us know via [email](mailto:support@rustdesk.com) and we can add to our docs.
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
|
||||
@ -8,13 +8,13 @@ weight: 7
|
||||
### 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!
|
||||
|
||||
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.*
|
||||
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.*
|
||||
|
||||
- TCP (**21115, 21116, 21117, 21118, 21119**)
|
||||
- UDP (**21116**)
|
||||
|
||||
### Docker examples
|
||||
```bash
|
||||
```sh
|
||||
sudo docker image pull rustdesk/rustdesk-server
|
||||
sudo docker run --name hbbs -v `pwd`:/root -td --net=host rustdesk/rustdesk-server hbbs -r <relay-server-ip[:port]>
|
||||
sudo docker run --name hbbr -v `pwd`:/root -td --net=host rustdesk/rustdesk-server hbbr
|
||||
|
||||
@ -90,7 +90,7 @@ PM2 requires Node.js v16+, if you fail to run PM2 (e.g. you can not see `hbbs`/`
|
||||
The `-r` parameter of `hbbs` is not mandatory, it is just convenient for you not to specify a relay server on the controlled client side. You do not need to specify port if you are using default 21117 port. The relay server specified by the client has a higher priority than this.
|
||||
{{% /notice %}}
|
||||
|
||||
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.*
|
||||
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.*
|
||||
|
||||
- TCP (**21115, 21116, 21117, 21118, 21119**)
|
||||
- UDP (**21116**)
|
||||
|
||||
@ -24,12 +24,12 @@ This tutorial is based on latest DSM v6 and v7.
|
||||
As mentioned above, double click on rustdesk-server image to create new container, set it name to `hbbs`.
|
||||
|
||||
|
||||
Click on above "Advanced Settings".
|
||||
Click on above `Advanced Settings`.
|
||||
|
||||
- Enable auto-restart
|
||||
|
||||
|
||||
- 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](/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.
|
||||
|
||||
@ -24,7 +24,7 @@ Please [download](https://nssm.cc/release/nssm-2.24.zip) and extract NSSM select
|
||||
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
|
||||
`Program Files\NSSM` (NSSM once started as a service, it cannot be moved from the directory it was placed in.
|
||||
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.
|
||||
|
||||
### Checking if NSSM is installed properly
|
||||
@ -37,7 +37,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.
|
||||
|
||||
### Run hbbr and hbbs
|
||||
Download the Windows version of [server program](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
|
||||
doesn't change after the service is installed). Now get back to Command prompt.
|
||||
|
||||
@ -95,7 +95,7 @@ pm2-startup install
|
||||
|
||||
### Run hbbr and hbbs
|
||||
|
||||
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):
|
||||
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):
|
||||
|
||||
```cmd
|
||||
cd C:\rustdesk-server-windows-x64
|
||||
|
||||
@ -13,7 +13,7 @@ Kindly written up by [@I-Am-Skoot](https://github.com/I-Am-Skoot/RustDeskNPMDock
|
||||
|
||||
#### Assumptions
|
||||
This example is an All in One for hosting just RustDesk services only. This can be expanded to a more flexible solution by splitting the NPM into it's own Docker Compose.
|
||||
- DMZ network 192.168.1.0/24
|
||||
- DMZ Network: 192.168.1.0/24
|
||||
- NPM (External): 192.168.1.250
|
||||
- LAN Network: 10.0.0.0/24
|
||||
- RSBackend Network: 192.168.254.0/29
|
||||
@ -21,7 +21,7 @@ This example is an All in One for hosting just RustDesk services only. This can
|
||||
- HBBS: 192.168.254.2
|
||||
- HBBR: 192.168.254.3
|
||||
- Docker Host: Linux
|
||||
- Each application has a dedicated folder in /opt/
|
||||
- Each application has a dedicated folder in `/opt/`.
|
||||
- Hostname: uniquehostname (Change This)
|
||||
- DNS Name: rustdesk.example.com
|
||||
|
||||
@ -30,7 +30,7 @@ Make modifications to the examples as needed.
|
||||
### Prepare Docker
|
||||
You must have Docker already installed this guide does not go into the specifics of that.
|
||||
|
||||
You will need to create a network for the RustServer Backend and the DMZ.
|
||||
You will need to create a network for the RustDesk Server Backend and the DMZ.
|
||||
For each application you use with the NPM (Nginx Proxy Manager) you should have a dedicated backend network to isolate it.
|
||||
|
||||
```
|
||||
@ -47,18 +47,19 @@ For each application you use with the NPM (Nginx Proxy Manager) you should have
|
||||
|
||||
### Setup Firewall
|
||||
Configure the following Port forwarding/NAT ports from your public IP to the NPM Server.
|
||||
- 21114 => 8080 TCP
|
||||
- 21115 => 21115 TCP
|
||||
- 21116 => 21116 TCP/UDP
|
||||
- 21117 => 21117 TCP
|
||||
- 21118 => 21118 TCP
|
||||
- 21119 => 21119 TCP
|
||||
- 443 => 443 TCP # If you want to use SSL
|
||||
- 21114 => 8080 TCP
|
||||
- 21115 => 21115 TCP
|
||||
- 21116 => 21116 TCP/UDP
|
||||
- 21117 => 21117 TCP
|
||||
- 21118 => 21118 TCP
|
||||
- 21119 => 21119 TCP
|
||||
- 443 => 443 TCP # If you want to use SSL
|
||||
|
||||
### Setup Docker Compose
|
||||
This will start a container with NPM and the correct networks.
|
||||
|
||||
Docker-Compose.yaml
|
||||
Copy the below into docker-compose.yaml.
|
||||
|
||||
```
|
||||
version: '3.5'
|
||||
services:
|
||||
@ -78,7 +79,7 @@ services:
|
||||
container_name: rustdesk_hbbs
|
||||
image: rustdesk/rustdesk-server-pro:latest
|
||||
command: hbbs -k _
|
||||
hostname: uniquehostname #Change This
|
||||
hostname: uniquehostname # Change This
|
||||
volumes:
|
||||
- /opt/rustdeskserver:/root
|
||||
networks:
|
||||
@ -88,7 +89,6 @@ services:
|
||||
- hbbr
|
||||
restart: unless-stopped
|
||||
|
||||
|
||||
hbbr:
|
||||
container_name: rustdesk_hbbr
|
||||
image: rustdesk/rustdesk-server-pro:latest
|
||||
@ -117,12 +117,12 @@ Configure Stream Hosts for the following Ports:
|
||||
- 80 => 127.0.0.1:8080 TCP # catches local traffic
|
||||
|
||||
Configure Proxy Host:
|
||||
- Domain Name: rustdesk.example.com
|
||||
- Scheme: http
|
||||
- Forward Hostname / IP: 192.168.254.2
|
||||
- Forward Port: 21114
|
||||
- Block Common Exploits: Checked
|
||||
- Optional: Configure SSL **DO NOT REQUIRE - Client needs to be able to communicate without SSL.**
|
||||
- Domain Name: rustdesk.example.com
|
||||
- Scheme: http
|
||||
- Forward Hostname / IP: 192.168.254.2
|
||||
- Forward Port: 21114
|
||||
- Block Common Exploits: Checked
|
||||
- Optional: Configure SSL **(DO NOT REQUIRE - Client needs to be able to communicate without SSL.)**
|
||||
|
||||
### Setup RustDesk Server
|
||||
Connect to Server interface http://rustdesk.example.com or https://rustdesk.example.com if you have configured SSL for web interface.
|
||||
|
||||
@ -8,16 +8,18 @@ weight: 6
|
||||
Install Docker with this [guide](https://docs.docker.com/engine/install) to ensure its the most up to date!
|
||||
|
||||
Run the following commands:
|
||||
```bash
|
||||
|
||||
```sh
|
||||
sudo docker image pull rustdesk/rustdesk-server-pro
|
||||
sudo docker run --name hbbs -v `pwd`:/root -td --net=host --restart unless-stopped rustdesk/rustdesk-server-pro hbbs
|
||||
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.
|
||||
{{% /notice %}}
|
||||
|
||||
```bash
|
||||
```sh
|
||||
macaddrhbbs=$(echo -n A0-62-2F; dd bs=1 count=3 if=/dev/random 2>/dev/null |hexdump -v -e '/1 "-%02X"')
|
||||
sudo docker image pull rustdesk/rustdesk-server-pro
|
||||
sudo docker run --name hbbs -p 21114:21114 -p 21115:21115 -p 21116:21116 -p 21116:21116/udp -p 21118:21118 -v `pwd`:/root -td --mac-address="$macaddrhbbs" --restart unless-stopped rustdesk/rustdesk-server-pro hbbs
|
||||
@ -57,4 +59,4 @@ services:
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
The run `docker compose up -d`
|
||||
The run `docker compose up -d`.
|
||||
|
||||
@ -61,10 +61,10 @@ To check the status `sudo systemctl status rustdesk-hbbs|rustdesk-hbbr` e.g. `su
|
||||
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.
|
||||
### 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 under compression.
|
||||
4. Set up a new reverse proxy rule.
|
||||
|
||||
@ -35,7 +35,7 @@ Don't forget to get your license from [https://rustdesk.com/pricing.html](https:
|
||||
|
||||
### 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
|
||||
- `-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
|
||||
|
||||
@ -16,9 +16,9 @@ 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.
|
||||
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,7 +26,7 @@ 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
|
||||
1. Create another account with `administrator` enabled.
|
||||
@ -37,7 +37,7 @@ For Windows clients, you can leave out the custom server configuration and put t
|
||||
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.
|
||||
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).
|
||||
|
||||
## Set or change the license
|
||||
@ -63,5 +63,5 @@ Gmail in this example
|
||||
|
||||
## 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.
|
||||
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.
|
||||
|
||||
@ -21,7 +21,7 @@ What it does:
|
||||
- Installs executables into /usr/bin
|
||||
- Download and extract RustDesk Pro Services to the above folder
|
||||
- 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
|
||||
|
||||
@ -49,7 +49,7 @@ What it does:
|
||||
- Delete /var/log/rustdesk and create /var/log/rustdesk-server
|
||||
- Download and extract RustDesk Pro Services to the above folder
|
||||
- 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
|
||||
|
||||
@ -69,7 +69,7 @@ Or run the backup script `./backup.sh --schedule`. This will schedule the backup
|
||||
To Restore do the following:
|
||||
```
|
||||
wget https://raw.githubusercontent.com/rustdesk/rustdesk-server-pro/main/restore.sh
|
||||
chmod +x
|
||||
chmod +x restore.sh
|
||||
```
|
||||
Copy the backup file into the same folder as the restore.sh file and then run `./restore.sh`.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user