holm/doc.rustdesk.com
1
0
Fork 0
forked from extern/doc.rustdesk.com
Code Issues Pull Requests Packages Projects Releases Wiki Activity

CHILDREN

Browse Source
This commit is contained in:
rustdesk 2022-04-11 21:56:34 +08:00
parent f9a9fe7278
commit 9b89659d6f
13 changed files with 69 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
content/_index.en.md
View File

@ -4,3 +4,5 @@ title: "Docs of RustDesk"
# RustDesk
{{% children depth="3" showhidden="true" %}}

4
content/_index.zh-cn.md
View File

@ -2,4 +2,6 @@
title: "RustDesk文档"
---
# RustDesk
# RustDesk
{{% children depth="3" showhidden="true" %}}

4
content/_index.zh-tw.md
View File

@ -2,4 +2,6 @@
title: "RustDesk文檔"
---
# RustDesk
# RustDesk
{{% children depth="3" showhidden="true" %}}

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

@ -9,4 +9,6 @@ chapter: true
# Self-host
Estamos continuamente desenvolvendo o servidor, se você tiver algum comentário, participe da nossa discussão [Discord](https://discord.com/invite/nDceKgxnkV).
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" %}}

4
content/self-host/_index.zh-cn.md
View File

@ -9,4 +9,6 @@ chapter: true
# 自建服务器
我们在持续开发服务器，如果您有什么意见，请加入我们的[Discord](https://discord.com/invite/nDceKgxnkV)讨论。
我们在持续开发服务器，如果您有什么意见，请加入我们的[Discord](https://discord.com/invite/nDceKgxnkV)讨论。
{{% children depth="3" showhidden="true" %}}

4
content/self-host/_index.zh-tw.md
View File

@ -9,4 +9,6 @@ chapter: true
# 自建服務器
我們在持續開發服務器，如果您有什麼意見，請加入我們的[Discord](https://discord.com/invite/nDceKgxnkV)討論。
我們在持續開發服務器，如果您有什麼意見，請加入我們的[Discord](https://discord.com/invite/nDceKgxnkV)討論。
{{% children depth="3" showhidden="true" %}}

27
content/self-host/install/_index.en.md
View File

@ -20,12 +20,29 @@ There are two executables:
- hbbs - RustDesk ID/Rendezvous server
- hbbr - RustDesk relay server
Do below after download
```
chmod a+x hbbs hbbr
```
They are built on Centos7, tested on Centos7/8, Ubuntu 18/20.
#### Server Requirements
The hardware requirements are very low, the minimum configuration of the cloud server is enough, and the CPU and memory requirements are the minimum. 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 30k-3M/s (1920x1080 screen), depending on the resolution settings and screen update。 If it is only for office work demand, the traffic is around 100K/s.
### STEP-2 : Run hbbs and hbbr on server
Run hbbs/hbbr on your server (Centos or Ubuntu). We suggust you use [pm2](https://pm2.keymetrics.io/) managing your service.
```
./hbbs -r <relay-server-ip>
./hbbr
```
{{% notice note %}}
The -r parameter of hhbs is not necessary, it is just convenient for you not to specify a relay server on the client side. The relay server specified by the client has a higher priority than this.
{{% /notice %}}
By default, hbbs listens on 21114(tcp), 21115(tcp) and 21116(tcp/udp), 21118(tcp), 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**. 21114 is for web console + API, 21115 is used for NAT type test, 21116/UDP is used for ID registration and heartbeat service, 21116/TCP is used for TCP hole punching and connection service, 21117 is used for Relay services, 21118 and 21119 are used to support web clients. If you do not need web console + API (21114) or web client (21118, 21119) support, the corresponding ports can be disabled.
- TCP(21114, 21115, 21116, 21117, 21118, 21119)
@ -36,8 +53,8 @@ Please run with "-h" option to see help if you wanna choose your own port.
#### Docker example
```
sudo docker image pull rustdesk/rustdesk-server
sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -it --rm rustdesk/rustdesk-server hbbr -m <registered_email>
sudo docker run --name hbbs -p 21114:21114 -p 21115:21115 -p 21116:21116 -p 21116:21116/udp -p 21118:21118 -v `pwd`:/root -it --rm rustdesk/rustdesk-server hbbs -r <relay-server-ip> -m <registered_email>
sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -it --rm rustdesk/rustdesk-server hbbr -m <registered_email>
```
@ -49,7 +66,9 @@ Click on menu button on the right side of ID as below, choose "ID/Relay Server".
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 ( 21116 port), the API server refers to above web console + API (21114) port.
**Please note** The Key in the picture does not refer to the registered email address, the [next section](#key) will explain in detail.
{{% notice note %}}
The Key in the picture does not refer to the registered email address, the [next section](#key) will explain in detail.
{{% /notice %}}
e.g.
@ -78,4 +97,6 @@ does not affect the connection, but the connection cannot be encrypted. If you p
./hbbr -k _
````
***Key can also be seen on the console homepage***
{{% notice note %}}
Key can also be seen on the console homepage
{{% /notice %}}

17
content/self-host/install/_index.zh-cn.md
View File

@ -28,18 +28,19 @@ chmod a+x hbbs hbbr
Linux版本在Centos7构建，在 Centos7/8，Ubuntu 18/20上测试过，Debian系列的发行版本应该都没有问题。如果有其他发行版本需求，请联系我。
#### 服务器要求
硬件要求很低，最低配置的云服务器就可以了，CPU和内存要求都是最小的。关于网络大小，如果TCP打洞直连失败，就要耗费中继流量，一个中继连接的流量在30k-3M每秒之间（1920x1080屏幕），取决于清晰度设置和画面变化，如果只是办公需求，平均在100K。
硬件要求很低，最低配置的云服务器就可以了，CPU和内存要求都是最小的。关于网络大小，如果TCP打洞直连失败，就要耗费中继流量，一个中继连接的流量在30k-3M每秒之间（1920x1080屏幕），取决于清晰度设置和画面变化。如果只是办公需求，平均在100K/s。
### 步骤2: 在服务器上运行 hbbs 和 hbbr
在服务器上运行 hbbs/hbbr (Centos 或 Ubuntu)。建议使用[pm2](https://pm2.keymetrics.io/) 管理服务。
需要先运行 hbbr, 可以不带任何参数;
然后运行 hbbs:
```
./hbbs -r <hbbr运行所在主机的地址>
./hbbr
```
{{% notice note %}}
hhbs的-r参数不是必须的，他只是方便你不用在客户端指定中继服务器。客户端指定的中继服务器优先级高于这个。
{{% /notice %}}
默认情况下，hbbs 监听21114(tcp), 21115(tcp), 21116(tcp/udp), 21118(tcp)，hbbr 监听21117(tcp), 21119(tcp)。务必在防火墙开启这几个端口， **请注意21116同时要开启TCP和UDP**。其中21114是网页控制台+API，21115是hbbs用作NAT类型测试，21116/UDP是hbbs用作ID注册与心跳服务，21116/TCP是hbbs用作TCP打洞与连接服务，21117是hbbr用作中继服务, 21118和21119是为了支持网页客户端。如果您不需要网页控制端+API（21114）或者网页客户端（21118，21119）支持，对应端口可以不开。
@ -51,8 +52,8 @@ hhbs的-r参数不是必须的，他只是方便你不用在客户端指定中
#### Docker示范
```
sudo docker image pull rustdesk/rustdesk-server
sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -it --rm rustdesk/rustdesk-server hbbr -m <registered_email>
sudo docker run --name hbbs -p 21114:21114 -p 21115:21115 -p 21116:21116 -p 21116:21116/udp -p 21118:21118 -v `pwd`:/root -it --rm rustdesk/rustdesk-server hbbs -r <relay-server-ip> -m <registered_email>
sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -it --rm rustdesk/rustdesk-server hbbr -m <registered_email>
```
### 步骤3: 在客户端设置 hbbs/hbbr 地址
@ -63,7 +64,9 @@ sudo docker run --name hbbs -p 21114:21114 -p 21115:21115 -p 21116:21116 -p 2111
在 ID 服务器输入框中（被控端+主控端）输入 hbbs 主机或 ip 地址，另外两个地址可以不填，RustDesk会自动推导（如果没有特别设定），中继服务器指的是hbbr（21116）端口，API服务器指的是上面的网页控制台+API（21114）。
**请注意**图中的Key不是指的注册邮箱，[下节](#key)将会具体解释。
{{% notice note %}}
图中的Key不是指的注册邮箱，[下节](#key)将会具体解释。
{{% /notice %}}
例如:
@ -91,6 +94,8 @@ cat ./id_ed25519.pub
./hbbr -k _
```
***在控制台首页也可以看到Key***
{{% notice note %}}
在控制台首页也可以看到Key
{{% /notice %}}

15
content/self-host/install/_index.zh-tw.md
View File

@ -34,12 +34,13 @@ Linux版本在Centos7構建，在 Centos7/8，Ubuntu 18/20上測試過，Debian
在服務器上運行 hbbs/hbbr (Centos 或 Ubuntu)。建議使用[pm2](https://pm2.keymetrics.io/) 管理服務。
需要先運行 hbbr, 可以不帶任何參數;
然後運行 hbbs:
```
./hbbs -r <hbbr運行所在主機的地址>
./hbbr
```
{{% notice note %}}
hhbs的-r參數不是必須的，他只是方便你不用在客戶端指定中繼服務器。客戶端指定的中繼服務器優先級高於這個。
{{% /notice %}}
默認情況下，hbbs 監聽21114(tcp), 21115(tcp), 21116(tcp/udp), 21118(tcp)，hbbr 監聽21117(tcp), 21119(tcp)。務必在防火牆開啟這幾個端口， **請注意21116同時要開啟TCP和UDP**。其中21114是網頁控制台+API，21115是hbbs用作NAT類型測試，21116/UDP是hbbs用作ID註冊與心跳服務，21116/TCP是hbbs用作TCP打洞與連接服務，21117是hbbr用作中繼服務, 21118和21119是為了支持網頁客戶端。如果您不需要網頁控制端+API（21114）或者網頁客戶端（21118，21119）支持，對應端口可以不開。
@ -51,8 +52,8 @@ hhbs的-r參數不是必須的，他只是方便你不用在客戶端指定中
#### Docker示範
```
sudo docker image pull rustdesk/rustdesk-server
sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -it --rm rustdesk/rustdesk-server hbbr -m <registered_email>
sudo docker run --name hbbs -p 21114:21114 -p 21115:21115 -p 21116:21116 -p 21116:21116/udp -p 21118:21118 -v `pwd`:/root -it --rm rustdesk/rustdesk-server hbbs -r <relay-server-ip> -m <registered_email>
sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -it --rm rustdesk/rustdesk-server hbbr -m <registered_email>
```
### 步驟3: 在客戶端設置 hbbs/hbbr 地址
@ -63,7 +64,9 @@ sudo docker run --name hbbs -p 21114:21114 -p 21115:21115 -p 21116:21116 -p 2111
在 ID 服務器輸入框中（被控端+主控端）輸入 hbbs 主機或 ip 地址，另外兩個地址可以不填，RustDesk會自動推導（如果沒有特別設定），中繼服務器指的是hbbr（21116）端口，API服務器指的是上面的網頁控制台+API（21114）。
**請注意**圖中的Key不是指的註冊郵箱，[下節](#key)將會具體解釋。
{{% notice note %}}
圖中的Key不是指的註冊郵箱，[下節](#key)將會具體解釋。
{{% /notice %}}
例如:
@ -91,4 +94,6 @@ cat ./id_ed25519.pub
./hbbr -k _
```
***在控制台首頁也可以看到Key***
{{% notice note %}}
在控制台首頁也可以看到Key
{{% /notice %}}

4
content/self-host/windows/_index.en.md
View File

@ -20,8 +20,8 @@ pm2-startup install
Download the windows version of [server program](https://github.com/rustdesk/rustdesk-server/releases), assuming you unzip it to the C drive. Run the following four lines of commands respectively.
```
cd c:\rustdesk-server-windows-x64
pm2 start hbbr.exe -- -m <Registered email address>
pm2 start hbbs.exe -- -r <The address of the host where hbbr is running> -m <Registered email address>
pm2 start hbbr.exe -- -m <Registered email address>
pm2 save
```
@ -36,7 +36,7 @@ For example, the new registered email address is test@test.com, and the public a
```
pm2 delete hbbr hbbs
cd c:\rustdesk-server-windows-x64
pm2 start hbbr.exe -- -m test@test.com
pm2 start hbbs.exe -- -r test.hbbr.com -m test@test.com
pm2 start hbbr.exe -- -m test@test.com
pm2 save
```

4
content/self-host/windows/_index.zh-cn.md
View File

@ -19,8 +19,8 @@ pm2-startup install
下载Windows版本[服务器程序](https://gitee.com/rustdesk/rustdesk-server/releases)，假设你解压缩到了C盘下。分别运行下面四行命令。
```
cd c:\rustdesk-server-windows-x64
pm2 start hbbr.exe -- -m 注册邮箱地址
pm2 start hbbs.exe -- -r hbbr运行所在主机的地址 -m 注册邮箱地址
pm2 start hbbr.exe -- -m 注册邮箱地址
pm2 save
```
@ -35,7 +35,7 @@ pm2 log hbbs
```
pm2 delete hbbr hbbs
cd c:\rustdesk-server-windows-x64
pm2 start hbbr.exe -- -m test@test.com
pm2 start hbbs.exe -- -r test.hbbr.com -m test@test.com
pm2 start hbbr.exe -- -m test@test.com
pm2 save
```

4
content/self-host/windows/_index.zh-tw.md
View File

@ -19,8 +19,8 @@ pm2-startup install
下載Windows版本[服務器程序](https://gitee.com/rustdesk/rustdesk-server/releases)，假設你解壓縮到了C盤下。分別運行下面四行命令。
```
cd c:\rustdesk-server-windows-x64
pm2 start hbbr.exe -- -m 註冊郵箱地址
pm2 start hbbs.exe -- -r hbbr運行所在主機的地址 -m 註冊郵箱地址
pm2 start hbbr.exe -- -m 註冊郵箱地址
pm2 save
```
@ -35,7 +35,7 @@ pm2 log hbbs
```
pm2 delete hbbr hbbs
cd c:\rustdesk-server-windows-x64
pm2 start hbbr.exe -- -m test@test.com
pm2 start hbbs.exe -- -r test.hbbr.com -m test@test.com
pm2 start hbbr.exe -- -m test@test.com
pm2 save
```

2
layouts/partials/logo.html
View File

@ -1,4 +1,4 @@
<a id="logo" href='/docs{{ (cond (and (ne .Site.Params.landingPageURL nil) (.Site.IsMultiLingual)) .Site.Params.landingPageURL "/") }}'>
<a id="logo" href="/docs/{{.Site.Language.Lang}}">
<svg width="32" height="32" wversion="1.1" fill="white" viewBox="0 0 263.67 263.26" xmlns="http://www.w3.org/2000/svg">
<path d="m99.158 261.8c-29.063-6.202-53.897-22.439-73.115-47.804-19.507-25.746-27.838-55.355-25.723-91.414 6.655-62.013 47.667-106.75 99.687-120.41 4.509-0.989 8.353-3.462 12.55-1.322 3.22 1.64 6.028 4.467 7.206 7.251 1.25 2.955 1.877 21.54 0.99 29.331-1.076 9.46-3.877 12.418-14.566 15.388-29.723 10.195-48.105 34.07-53.697 61.017-4.8 29.668 2.951 59.729 21.528 78.727 8.966 8.993 17.92 14.24 30.869 18.086 8.646 2.57 13.393 5.758 15.036 10.102 1.085 2.867 1.63 22.984 0.779 28.772-1.33 9.046-1.702 9.796-5.792 11.667-5.029 2.3-7.404 2.392-15.752 0.61zm50.708 0.29c-3.092-1.402-5.673-4.83-6.73-8.94-0.134-9.408-2.366-25.754 1.02-33.373 1.88-4.128 4.65-5.999 12.433-8.396 21.267-6.551 37.593-19.88 46.806-38.213 11.11-22.108 11.877-55.183 1.808-77.975-9.154-20.723-25.7-35.217-48.555-42.534-8.872-2.84-12.004-5.065-12.968-9.21-1.002-4.31-1.435-19.87-0.785-28.218 0.682-8.766 1.249-9.99 6.162-13.318 3.701-2.505 5.482-2.446 17.223 0.575 36.718 10.077 65.97 33.597 83.026 66.68 18.495 37.034 19.191 86.11 1.742 122.65-17.233 36.09-50.591 62.511-88.622 70.194-8.172 1.65-9.07 1.656-12.56 0.073z"/>
</svg>