docs tidy etc
@@ -9,6 +9,8 @@ chapter: true
|
||||
|
||||
# Self-host
|
||||
|
||||
Please join our [Discord](https://discord.com/invite/nDceKgxnkV) if you would like to talk with us about self-hosting your own [open source RustDesk Server](https://github.com/rustdesk/rustdesk-server).
|
||||
If you are using RustDesk you should have your own RustDesk Server, these docs will help you on your RustDesk journey.
|
||||
|
||||
Support is available via our [Discord](https://discord.com/invite/nDceKgxnkV) for OSS and [email](mailto:support@rustdesk.com) for Pro.
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
---
|
||||
title: Clientseitige Einstellungen
|
||||
weight: 40
|
||||
---
|
||||
|
||||
[hbbs/hbbr-Adresse auf der Client-Seite einstellen](/docs/de/self-host/install/#schritt-3-hbbshbbr-adresse-auf-der-client-seite-einstellen)
|
||||
@@ -1,6 +0,0 @@
|
||||
---
|
||||
title: Client-Side Settings
|
||||
weight: 40
|
||||
---
|
||||
|
||||
[Set hbbs/hbbr address on client-side](/docs/en/self-host/install/#step-3--set-hbbshbbr-address-on-client-side)
|
||||
@@ -1,6 +0,0 @@
|
||||
---
|
||||
title: Ajustes-Cliente
|
||||
weight: 40
|
||||
---
|
||||
|
||||
[Establecer dirección hbbs/hbbr en el lado del cliente](/docs/es/self-host/install/#paso-3-establecer-la-dirección-hbbshbbr-en-el-lado-del-cliente)
|
||||
@@ -1,7 +0,0 @@
|
||||
---
|
||||
title: Configuration côté client
|
||||
weight: 40
|
||||
---
|
||||
|
||||
[Configurer les adresses hbbs/hbbr côté client](/docs/fr/self-host/install/#étape-3--définir-ladresse-ip-hbbshbbr-côté-client)
|
||||
##
|
||||
@@ -1,6 +0,0 @@
|
||||
---
|
||||
title: Client-Side Settings
|
||||
weight: 40
|
||||
---
|
||||
|
||||
[English](/docs/en/self-host/client)
|
||||
@@ -1,6 +0,0 @@
|
||||
---
|
||||
title: クライアント側の設定
|
||||
weight: 40
|
||||
---
|
||||
|
||||
[クライアント側で hbbs/hbbr のアドレスを設定する](/docs/ja/self-host/install/#step-3--クライアント側でhbbshbbrのアドレスを設定する)
|
||||
@@ -1,6 +0,0 @@
|
||||
---
|
||||
title: Klant-Zijde Instellingen
|
||||
weight: 40
|
||||
---
|
||||
|
||||
[Stel hbbs/hbbr adres in aan klantzijde](/docs/nl/zelf-host/installeer/#stap-3 - instellen-hbbshbbr-adres-op-klant-zijde)
|
||||
@@ -1,6 +0,0 @@
|
||||
---
|
||||
title: Client-Side Settings
|
||||
weight: 40
|
||||
---
|
||||
|
||||
[English](/docs/en/self-host/client)
|
||||
@@ -1,6 +0,0 @@
|
||||
---
|
||||
title: Настройки на клиенте
|
||||
weight: 40
|
||||
---
|
||||
|
||||
[Настройки адреса hbbs/hbbr на стороне клиента](/docs/ru/self-host/install/#step-3--set-hbbshbbr-address-on-client-side)
|
||||
@@ -1,5 +0,0 @@
|
||||
---
|
||||
title: 客户端设置
|
||||
weight: 40
|
||||
---
|
||||
[在客户端设置 hbbs/hbbr 地址](/docs/zh-cn/self-host/install/#步骤3-在客户端设置-hbbshbbr-地址)
|
||||
@@ -1,6 +0,0 @@
|
||||
---
|
||||
title: 客戶端設置
|
||||
weight: 40
|
||||
---
|
||||
|
||||
[在客戶端設置 hbbs/hbbr 地址](/docs/zh-tw/self-host/install/#步驟3-在客戶端設置-hbbshbbr-地址)
|
||||
@@ -1,100 +0,0 @@
|
||||
---
|
||||
title: Pro
|
||||
weight: 100
|
||||
---
|
||||
|
||||
Self-host Pro has more features compared to the open source version.
|
||||
|
||||
- OIDC, LDAP, 2FA (email verification)
|
||||
- Address book
|
||||
- Rename
|
||||
- Log management
|
||||
- Device management
|
||||
- Settings sync
|
||||
- Permission control
|
||||
- Multiple relay servers (automatically selects your closest relay)
|
||||
|
||||
{{% notice note %}}
|
||||
RustDesk client >= 1.2.0 required
|
||||
{{% /notice %}}
|
||||
|
||||
## Download
|
||||
|
||||
[https://github.com/rustdesk/rustdesk-server-pro/releases/latest](https://github.com/rustdesk/rustdesk-server-pro/releases/latest)
|
||||
|
||||
## Installation
|
||||
|
||||
### 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/pro/installscript/).
|
||||
|
||||
{{% 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/pro/license) page for more details.
|
||||
{{% /notice %}}
|
||||
|
||||
### Manual Installation
|
||||
|
||||
Almost as the same as [the open source version](/docs/en/self-host/install/), but you do not need to run hbbs/hbbr with any arguments, all 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
|
||||
|
||||
### One more port (or use a proxy)
|
||||
|
||||
One more TCP port `21114` is added for web console, please also add this port when you set firewall rules and docker port mapping.
|
||||
|
||||
### Docker
|
||||
|
||||
Install Docker with (this)[https://docs.docker.com/engine/install/] guide.
|
||||
|
||||
Run the following commands:
|
||||
```bash
|
||||
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
|
||||
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
|
||||
sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -td --restart unless-stopped rustdesk/rustdesk-server-pro hbbr
|
||||
```
|
||||
|
||||
### Docker Compose
|
||||
|
||||
With Docker Compose you HAVE to use `network_mode: "host"`. Install using (this)[https://docs.docker.com/engine/install/] guide.
|
||||
|
||||
Copy the below into docker-compose.yml
|
||||
|
||||
```yaml
|
||||
version: '3'
|
||||
|
||||
services:
|
||||
hbbs:
|
||||
container_name: hbbs
|
||||
image: rustdesk/rustdesk-server-pro:latest
|
||||
command: hbbs
|
||||
volumes:
|
||||
- ./data:/root
|
||||
network_mode: "host"
|
||||
|
||||
depends_on:
|
||||
- hbbr
|
||||
restart: unless-stopped
|
||||
|
||||
|
||||
hbbr:
|
||||
container_name: hbbr
|
||||
image: rustdesk/rustdesk-server-pro:latest
|
||||
command: hbbr
|
||||
volumes:
|
||||
- ./data:/root
|
||||
network_mode: "host"
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
The run `docker compose up -d`
|
||||
@@ -1,29 +0,0 @@
|
||||
---
|
||||
title: Web Console
|
||||
weight: 10
|
||||
---
|
||||
|
||||
Features:
|
||||
|
||||
- Add/modify users and user groups
|
||||
- Modify device access permissions
|
||||
- Browse device connection logs and the other logs
|
||||
- Update settings
|
||||
- Manage client settings sync strategies
|
||||
|
||||
## Log in
|
||||
|
||||
As mentioned earlier, 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 (hbbs runs on the IP 192.168.1.143 server):
|
||||

|
||||
|
||||
If you need https support, please install a web server such as `Nginx`.
|
||||
|
||||
The default administrator username/password is admin/test1234, please be sure to change the password after logging in, select "Settings" in the account menu in the upper right corner to enter the password modification page, as shown in the following figure. You can also create another administrator account and delete this one. You'd better enable email login verification.
|
||||
<a name=console-home></a>
|
||||

|
||||
|
||||
Non-administrator users can also login to browser their device and logs, change their user settings.
|
||||
|
||||
## Windows EXE
|
||||
|
||||
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`**。
|
||||
|
Before Width: | Height: | Size: 568 KiB |
|
Before Width: | Height: | Size: 435 KiB |
63
content/self-host/rustdesk-server-oss/Docker/_index.en.md
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
title: Docker
|
||||
weight: 7
|
||||
---
|
||||
|
||||
## Install your own server with Docker
|
||||
|
||||
### Requirements
|
||||
You need to have Docker/Podman installed to run a rustdesk-server as a docker container, if in doubt install Docker with [this](https://docs.docker.com/engine/install) guide to ensure its the most up to date!
|
||||
|
||||
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.*
|
||||
|
||||
- TCP (**21115, 21116, 21117, 21118, 21119**)
|
||||
- UDP (**21116**)
|
||||
|
||||
### Docker examples
|
||||
```bash
|
||||
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
|
||||
```
|
||||
<a name="net-host"></a>
|
||||
|
||||
{{% notice note %}}
|
||||
`--net=host` only works on **Linux**, which makes `hbbs`/`hbbr` see the real incoming IP Address rather than the Container IP (172.17.0.1).
|
||||
If `--net=host` works fine, the `-p` options are not used. If on Windows, leave out `sudo` and `--net=host`.
|
||||
|
||||
**Please remove `--net=host` if you are having connection problems on your platform.**
|
||||
{{% /notice %}}
|
||||
|
||||
{{% notice note %}}
|
||||
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 %}}
|
||||
|
||||
### 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.
|
||||
```yaml
|
||||
version: '3'
|
||||
|
||||
services:
|
||||
hbbs:
|
||||
container_name: hbbs
|
||||
image: rustdesk/rustdesk-server:latest
|
||||
command: hbbs
|
||||
volumes:
|
||||
- ./data:/root
|
||||
network_mode: "host"
|
||||
|
||||
depends_on:
|
||||
- hbbr
|
||||
restart: unless-stopped
|
||||
|
||||
|
||||
hbbr:
|
||||
container_name: hbbr
|
||||
image: rustdesk/rustdesk-server:latest
|
||||
command: hbbr
|
||||
volumes:
|
||||
- ./data:/root
|
||||
network_mode: "host"
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
14
content/self-host/rustdesk-server-oss/_index.de.md
Executable file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Selbst-Host
|
||||
weight: 5
|
||||
pre: "<b>2. </b>"
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### Kapitel 2
|
||||
|
||||
# Selbst-Host
|
||||
|
||||
Bitte besuchen Sie unseren [Discord](https://discord.com/invite/nDceKgxnkV), wenn Sie mit uns über das Selbst-Hosten Ihres eigenen [Open-Source-RustDesk-Servers](https://github.com/rustdesk/rustdesk-server) diskutieren möchten.
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
8
content/self-host/rustdesk-server-oss/_index.en.md
Executable file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: RustDesk Server OSS
|
||||
weight: 7
|
||||
---
|
||||
|
||||
Please join our [Discord](https://discord.com/invite/nDceKgxnkV) if you would like to talk with us about self-hosting your own [open source RustDesk Server](https://github.com/rustdesk/rustdesk-server).
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
14
content/self-host/rustdesk-server-oss/_index.es.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Self-host
|
||||
weight: 5
|
||||
pre: "<b>2. </b>"
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### Capitulo 2
|
||||
|
||||
# Self-host
|
||||
|
||||
Por favor únete a nuestro [Discord](https://discord.com/invite/nDceKgxnkV) si desea hablar con nosotros sobre el alojamiento propio de su propio servidor RustDesk.
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
14
content/self-host/rustdesk-server-oss/_index.fr.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Auto-héberger son serveur
|
||||
weight: 5
|
||||
pre: "<b>2. </b>"
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### Chapitre 2
|
||||
|
||||
# Auto-héberger son serveur
|
||||
|
||||
Nous développons continuellement le serveur, si vous avez des commentaires, veuillez rejoindre notre discussion [Discord](https://discord.com/invite/nDceKgxnkV).
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
14
content/self-host/rustdesk-server-oss/_index.it.md
Executable file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Self-host
|
||||
weight: 5
|
||||
pre: "<b>2. </b>"
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### Capitolo 2
|
||||
|
||||
# Self-host
|
||||
|
||||
Stiamo sviluppando continuamente il server, se hai commenti, partecipa alla nostra discussione su [Discord](https://discord.com/invite/nDceKgxnkV).
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
14
content/self-host/rustdesk-server-oss/_index.ja.md
Executable file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: セルフホスト
|
||||
weight: 5
|
||||
pre: "<b>2. </b>"
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### 第2章
|
||||
|
||||
# セルフホスト
|
||||
|
||||
サーバーの開発は継続的に行っています。困ったことがあれば[Discord](https://discord.com/invite/nDceKgxnkV)に参加してください。
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
14
content/self-host/rustdesk-server-oss/_index.nl.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Zelf-hosten
|
||||
weight: 5
|
||||
pre: "<b>2. </b>"
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### Hoofdstuk 2
|
||||
|
||||
# Zelf-hosten
|
||||
|
||||
Sluit u aan bij onze [Discord](https://discord.com/invite/nDceKgxnkV) als u met ons wilt praten over het zelf-hosten van uw eigen RustDesk server.
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
14
content/self-host/rustdesk-server-oss/_index.pt.md
Executable file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Auto-hospedagem
|
||||
weight: 5
|
||||
pre: "<b>2. </b>"
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### Capítulo 2
|
||||
|
||||
# Auto-hospedagem
|
||||
|
||||
Estamos continuamente desenvolvendo o servidor, se você tiver algum comentário, participe da nossa discussão [Discord](https://discord.com/invite/nDceKgxnkV).
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
14
content/self-host/rustdesk-server-oss/_index.ru.md
Executable file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Самостоятельное развёртывание
|
||||
weight: 5
|
||||
pre: "<b>2. </b>"
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### Раздел 2
|
||||
|
||||
# Самостоятельное развёртывание
|
||||
|
||||
Присоединяйтесь к нашему серверу [Discord](https://discord.com/invite/nDceKgxnkV) если хотите обсудить сервер для самостоятельного развёртывания.
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
14
content/self-host/rustdesk-server-oss/_index.zh-cn.md
Executable file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: 自建服务器
|
||||
weight: 5
|
||||
pre: "<b>2. </b>"
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### 章节 2
|
||||
|
||||
# 自建服务器
|
||||
|
||||
我们在持续开发服务器,如果您有什么意见,请加入我们的[Discord](https://discord.com/invite/nDceKgxnkV)讨论。
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
14
content/self-host/rustdesk-server-oss/_index.zh-tw.md
Executable file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: 自架伺服器
|
||||
weight: 5
|
||||
pre: "<b>2. </b>"
|
||||
chapter: true
|
||||
---
|
||||
|
||||
### 章節 2
|
||||
|
||||
# 自架伺服器
|
||||
|
||||
如果您想要和我們聊聊關於[自架 RustDesk 伺服器](https://github.com/rustdesk/rustdesk-server)的事,請加入我們的 [Discord](https://discord.com/invite/nDceKgxnkV) 伺服器。
|
||||
|
||||
{{% children depth="3" showhidden="true" %}}
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Installation
|
||||
weight: 10
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## Install your own server as systemd service using a simple to run install script
|
||||
@@ -39,60 +39,8 @@ There is also an update script on [Techahold's](https://github.com/techahold/rus
|
||||
|
||||
Please [Download](https://github.com/rustdesk/rustdesk-server/releases/latest) deb files yourself and install with `apt-get -f install <filename>.deb` or `dpkg -i <filename>.deb`.
|
||||
|
||||
## Install your own server with Docker
|
||||
|
||||
### Requirements
|
||||
You need to have Docker/Podman installed to run a rustdesk-server as a docker container
|
||||
|
||||
### Docker examples
|
||||
```bash
|
||||
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
|
||||
```
|
||||
<a name="net-host"></a>
|
||||
|
||||
{{% notice note %}}
|
||||
`--net=host` only works on **Linux**, which makes `hbbs`/`hbbr` see the real incoming IP Address rather than the Container IP (172.17.0.1).
|
||||
If `--net=host` works fine, the `-p` options are not used. If on Windows, leave out `sudo` and `--net=host`.
|
||||
|
||||
**Please remove `--net=host` if you are having connection problems on your platform.**
|
||||
{{% /notice %}}
|
||||
|
||||
{{% notice note %}}
|
||||
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 %}}
|
||||
|
||||
### 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.
|
||||
```yaml
|
||||
version: '3'
|
||||
|
||||
services:
|
||||
hbbs:
|
||||
container_name: hbbs
|
||||
image: rustdesk/rustdesk-server:latest
|
||||
command: hbbs
|
||||
volumes:
|
||||
- ./data:/root
|
||||
network_mode: "host"
|
||||
|
||||
depends_on:
|
||||
- hbbr
|
||||
restart: unless-stopped
|
||||
|
||||
|
||||
hbbr:
|
||||
container_name: hbbr
|
||||
image: rustdesk/rustdesk-server:latest
|
||||
command: hbbr
|
||||
volumes:
|
||||
- ./data:/root
|
||||
network_mode: "host"
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
## Set up your own server instance without using Docker
|
||||
## Set up your own server instance manually.
|
||||
|
||||
### STEP 1: Download server-side software programs
|
||||
|
||||
@@ -172,24 +120,6 @@ hbbs.example.com:21116
|
||||
|
||||

|
||||
|
||||
#### 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.
|
||||
|
||||
<a name="invalidchar"></a>
|
||||
{{% notice note %}}
|
||||
You need to set both `host` and `key`, missing either one will not work.
|
||||
|
||||
Optionally add a `,` (comma) character after the key, before the `.exe` part as a delimiter, to avoid the key being mangled if Windows or the browser renames the file when downloading duplicated names.
|
||||
|
||||
If there are invalid characters in the key which can not be used in a Windows file name, please remove the
|
||||
`id_ed25519` file from your server and restart `hbbs`/`hbbr`. This will cause the `id_ed25519.pub` file to regenerate. You may need to
|
||||
repeat this process until you get valid characters.
|
||||
{{% /notice %}}
|
||||
|
||||
| Menu | About Page |
|
||||
| -- | -- |
|
||||
|  |  |
|
||||
|
||||
## Key
|
||||
|
||||
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 3.5 KiB After Width: | Height: | Size: 3.5 KiB |
|
Before Width: | Height: | Size: 3.2 KiB After Width: | Height: | Size: 3.2 KiB |
@@ -13,33 +13,33 @@ Open package manager and install docker
|
||||
|
||||
| | |
|
||||
| -- | -- |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|
||||
|
||||
### Install RustDesk Server
|
||||
|
||||
| Search rustdesk-server in Docker's registry and install by double click | Installed rustdesk-server image, double click to create rustdesk-server container |
|
||||
| -- | -- |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|
||||
|
||||
### Create hbbs container
|
||||
|
||||
As mentioned above, double click on rustdesk-server image to create new container, set it name to `hbbs`.
|
||||

|
||||

|
||||
|
||||
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/install/#net-host)
|
||||

|
||||
- Enable "Use the same network as Docker host", for more about host net, please [check](install/#net-host)
|
||||

|
||||
|
||||
- Mount a host directory (e.g. `/home/rustdesk/`) to `/root`, hbbs will generate some files (database and `key` files) in this directory which need to be persistent over reboots.
|
||||
| Mount | Files generated in the host directory |
|
||||
| -- | -- |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|
||||
- Set command
|
||||
{{% notice note %}}
|
||||
@@ -49,26 +49,26 @@ Synology's OS is Debian based, so host net (--net=host) works fine, we do not ne
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||

|
||||

|
||||
|
||||
- Done
|
||||
|
||||

|
||||

|
||||
|
||||
### Create hbbr container
|
||||
|
||||
Please repeat above `hbbs` steps, but name the container `hbbr` and command (for Set Command Step) should be `hbbr -k _`.
|
||||
|
||||

|
||||

|
||||
|
||||
### hbbr/hbbs containers
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
| Double click on container and check log | Double confirm hbbs/hbbr using host network |
|
||||
| -- | -- |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|
||||
### Retrieve your Key
|
||||
|
||||
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 51 KiB |
|
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 64 KiB |
|
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
|
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 62 KiB |
|
Before Width: | Height: | Size: 65 KiB After Width: | Height: | Size: 65 KiB |
|
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 49 KiB |
|
Before Width: | Height: | Size: 63 KiB After Width: | Height: | Size: 63 KiB |
|
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 49 KiB |
|
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 98 KiB After Width: | Height: | Size: 98 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
|
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 41 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
|
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 55 KiB |
|
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
|
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
60
content/self-host/rustdesk-server-pro/Docker/_index.en.md
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: Docker
|
||||
weight: 6
|
||||
---
|
||||
|
||||
### Docker
|
||||
|
||||
Install Docker with [this](https://docs.docker.com/engine/install) guide to ensure its the most up to date!
|
||||
|
||||
Run the following commands:
|
||||
```bash
|
||||
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
|
||||
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
|
||||
sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -td --restart unless-stopped rustdesk/rustdesk-server-pro hbbr
|
||||
```
|
||||
|
||||
### Docker Compose
|
||||
|
||||
With Docker Compose you HAVE to use `network_mode: "host"`. Install Docker using [this](https://docs.docker.com/engine/install) guide to ensure its the most up to date!
|
||||
|
||||
Copy the below into docker-compose.yml
|
||||
|
||||
```yaml
|
||||
version: '3'
|
||||
|
||||
services:
|
||||
hbbs:
|
||||
container_name: hbbs
|
||||
image: rustdesk/rustdesk-server-pro:latest
|
||||
command: hbbs
|
||||
volumes:
|
||||
- ./data:/root
|
||||
network_mode: "host"
|
||||
|
||||
depends_on:
|
||||
- hbbr
|
||||
restart: unless-stopped
|
||||
|
||||
|
||||
hbbr:
|
||||
container_name: hbbr
|
||||
image: rustdesk/rustdesk-server-pro:latest
|
||||
command: hbbr
|
||||
volumes:
|
||||
- ./data:/root
|
||||
network_mode: "host"
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
The run `docker compose up -d`
|
||||
@@ -52,6 +52,28 @@ To check the status `sudo systemctl status rustdesk-hbbs|rustdesk-hbbr` e.g. `su
|
||||
9. Log in with the username `admin` and password `test1234`.
|
||||
10. Enter your license code purchased in step 1.
|
||||
|
||||
## Can I use IIS as a reverse proxy?
|
||||
1. Open IIS (Or install it)
|
||||
2. Create a new website for rustdesk with the bindings (Ideally 443) and relevant certificate. Basic settings should point this to a blank folder. (If you use the default site, make sure there are no other files in the folder).
|
||||
3. On IIS, install Application Request Routing (https://www.iis.net/downloads/microsoft/application-request-routing) and URL Rewrite (https://learn.microsoft.com/en-us/iis/extensions/url-rewrite-module/using-the-url-rewrite-module)
|
||||
|
||||
### Application Request Routing
|
||||
|
||||
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.
|
||||
|
||||
### URL rewrite
|
||||
1. Open the site on IIS on the left pane and double-click on URL rewrite
|
||||
2. Click Add rules
|
||||
3. Disable dynamic compression from under compression.
|
||||
4. Set up a new reverse proxy rule
|
||||
5. Setup the local address (the 21114 address) \
|
||||
Inbound Rule – the rustdesk internal 21114 address \
|
||||
Outbound Rules – From: rustdesk internal 21114 address and To is the external address. \
|
||||
Note – no http / https before the addresses – they are automatically handled. Also, ensure all the addresses are accessible both internally and externally.
|
||||
|
||||
## How can I change the admin password?
|
||||
1. Go to `https://rustdesk.yourdomain.com` or `http://youripaddress:21114`.
|
||||
2. Log in with the username `admin` and password `test1234`.
|
||||
@@ -59,42 +81,9 @@ To check the status `sudo systemctl status rustdesk-hbbs|rustdesk-hbbr` e.g. `su
|
||||
4. Click on `Settings`.
|
||||
5. Enter your new password in the boxes provided.
|
||||
|
||||
## How can I delete the default `admin` user?
|
||||
1. Create another account with `administrator` enabled.
|
||||
2. Log in with the new administrative account.
|
||||
3. Delete the `admin` on `Users` page.
|
||||
|
||||
## How can I setup my relay servers?
|
||||
1. Go to `Settings` on the left hand menu.
|
||||
2. Click on `Relay` on the sub-menu.
|
||||
3. Click `+` next to `Relay Servers`.
|
||||
4. Enter the Relay server DNS address or IP address in the box which now shows and press Enter.
|
||||
5. If you have more than one Relay server you can keep clicking `+` and adapt the Geo settings is required (remember and copy your key to the other servers).
|
||||
|
||||
## How can I set or change the license?
|
||||
1. Go to `Settings` on the left hand menu.
|
||||
2. Click on `License` on the sub-menu.
|
||||
3. Click `Edit` and paste in your license code.
|
||||
4. Click `OK`.
|
||||
|
||||
## How can I move my license to a new server?
|
||||
Please see [here](https://rustdesk.com/docs/en/self-host/pro/license/#invoices-and-migration).
|
||||
|
||||
## How can I view the logs?
|
||||
On the left hand side click on `Logs`.
|
||||
|
||||
## How can I setup Emails?
|
||||
Gmail in this example
|
||||
|
||||
1. Go to `Settings` on the left hand menu.
|
||||
2. Click on `SMTP` on the sub-menu.
|
||||
3. Enter the SMTP address `smtp.gmail.com`.
|
||||
4. Enter the Port 587 in `SMTP Port`.
|
||||
5. Enter the Gmail account i.e. `myrustdeskserver@gmail.com` in `Mail Account`.
|
||||
6. Enter your password (you might need an app password).
|
||||
7. Enter your Gmail account i.e. `myrustdeskserver@gmail.com` in `From `.
|
||||
8. Click `Check` to save.
|
||||
|
||||
## Emails aren't working from my VPS
|
||||
A lot of VPS providers block ports 465 and 25.
|
||||
|
||||
@@ -214,3 +203,7 @@ Please get in touch with our [sales](mailto://sales@rustdesk.com) team.
|
||||
|
||||
## Is there somewhere I can see video setup guides?
|
||||
Yes! We have a [YouTube Channel](https://youtube.com/@RustDesk).
|
||||
|
||||
## Why are my logs are empty?
|
||||
Ensure API is set on both the device being controlled and the machine controlling.
|
||||
On the left hand side click on `Logs`.
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
title: Getting Started
|
||||
weight: 2
|
||||
---
|
||||
|
||||
Install the server after choosing your preferred option between Docker or Direct installation.
|
||||
|
||||
## Post Install
|
||||
|
||||
* [ ] Change your admin password.
|
||||
* [ ] Read FAQs
|
||||
* [ ] Setup Email.
|
||||
|
||||
### Setup Users and Groups
|
||||
|
||||
* [ ] Create new users
|
||||
* [ ] Create new groups
|
||||
* [ ] Assign Users to Groups
|
||||
|
||||
### Setup Strategy
|
||||
|
||||
* [ ] Edit default strategy and create new if required.
|
||||
* [ ] Assign to Computers/Groups
|
||||
|
||||
## At least every 60 days
|
||||
|
||||
* [ ] Server [OS updates]
|
||||
* [ ] RustDesk Updates
|
||||
|
||||
48
content/self-host/rustdesk-server-pro/_index.en.md
Normal file
@@ -0,0 +1,48 @@
|
||||
---
|
||||
title: RustDesk Server Pro
|
||||
weight: 6
|
||||
---
|
||||
|
||||
RustDesk Server Pro has more features compared to the open source version.
|
||||
|
||||
- OIDC, LDAP, 2FA (email verification)
|
||||
- Address book
|
||||
- Rename
|
||||
- Log management
|
||||
- Device management
|
||||
- Settings sync
|
||||
- Permission control
|
||||
- Multiple relay servers (automatically selects your closest relay)
|
||||
|
||||
{{% notice note %}}
|
||||
RustDesk client >= 1.2.0 required
|
||||
{{% /notice %}}
|
||||
|
||||
## Download
|
||||
|
||||
[https://github.com/rustdesk/rustdesk-server-pro/releases/latest](https://github.com/rustdesk/rustdesk-server-pro/releases/latest)
|
||||
|
||||
## Installation
|
||||
|
||||
### 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/pro/installscript/).
|
||||
|
||||
{{% 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/pro/license) page for more details.
|
||||
{{% /notice %}}
|
||||
|
||||
### Manual Installation
|
||||
|
||||
Almost as the same as [the open source version](/docs/en/self-host/install/), but you do not need to run hbbs/hbbr with any arguments, all can be set later in web console.
|
||||
|
||||
- `-k _` is set by default
|
||||
- `-r <server:host>` is not needed any more if the relay server runs on the same machine with hbbs, and you can set multiple relay servers in the web console
|
||||
|
||||
### Ports Required
|
||||
|
||||
You need port 21114-21119 TCP and 21116 UDP open, please ensure these ports are setup when you set firewall rules and docker port mapping.
|
||||
|
||||
{{% notice note %}}
|
||||
You should use a proxy like nginx to deliver this over HTTPS requiring port 443 to be opened.
|
||||
{{% /notice %}}
|
||||
@@ -14,13 +14,13 @@ Funktionen:
|
||||
## Anmelden
|
||||
|
||||
Wie bereits erwähnt, ist der Standardport der Webkonsole 21114. Geben Sie `http://<hbbs host>:21114` in den Browser ein, um die Konsolenseite aufzurufen, wie in der folgenden Abbildung zu sehen (hbbs läuft auf dem Server mit der IP 192.168.1.143):
|
||||

|
||||

|
||||
|
||||
Wenn Sie https-Unterstützung benötigen, installieren Sie bitte einen Webserver wie z. B. `Nginx`.
|
||||
|
||||
Der Standard-Benutzername und das Standard-Passwort des Administrators lautet admin/test1234. Bitte ändern Sie das Passwort nach dem Anmelden, indem Sie im Kontomenü oben rechts "Einstellungen" wählen, um die Seite zur Änderung des Passworts aufzurufen, wie in der folgenden Abbildung dargestellt. Sie können auch ein anderes Administratorkonto erstellen und dieses löschen. Aktivieren Sie besser die E-Mail-Anmeldebestätigung.
|
||||
<a name=console-home></a>
|
||||

|
||||

|
||||
|
||||
Nicht-Administrator-Benutzer können sich auch anmelden, um ihr Gerät und ihre Protokolle zu durchsuchen und ihre Benutzereinstellungen zu ändern.
|
||||
|
||||