diff --git a/config.toml b/config.toml index e772891..0ff2643 100644 --- a/config.toml +++ b/config.toml @@ -45,6 +45,38 @@ languageName = "Français" landingPageURL = "/fr" landingPageName = " Accueil" + +[Languages.ru] +title = "Документация для RustDesk" +weight = 2 +languageName = "Русский" +landingPageURL = "/ru" +landingPageName = " Дом" + + +[Languages.it] +title = "Documentazione per RustDesk" +weight = 2 +languageName = "Italiano" +landingPageURL = "/it" +landingPageName = " Casa" + + +[Languages.de] +title = "Dokumentation für RustDesk" +weight = 2 +languageName = "Deutsch" +landingPageURL = "/de" +landingPageName = " Heim" + + +[Languages.jp] +title = "RustDeskのドキュメント" +weight = 2 +languageName = "日本語" +landingPageURL = "/jp" +landingPageName = " ホームページ" + [[Languages.fr.menu.shortcuts]] name = " Repo GitHub" identifier = "ds" @@ -58,6 +90,13 @@ languageName = "简体中文" landingPageURL = "/zh" landingPageName = " 首页" +[Languages.tw] +title = "RustDesk文檔" +weight = 3 +languageName = "繁體中文" +landingPageURL = "/tw" +landingPageName = " 首頁" + [[Languages.zh.menu.shortcuts]] name = " GitHub 仓库" identifier = "ds" diff --git a/content/_index.de.md b/content/_index.de.md new file mode 100644 index 0000000..b08f71e --- /dev/null +++ b/content/_index.de.md @@ -0,0 +1,6 @@ +--- +title: "RustDesk-Dokumentation" +--- + +# RustDesk + diff --git a/content/_index.it.md b/content/_index.it.md new file mode 100644 index 0000000..7c59e02 --- /dev/null +++ b/content/_index.it.md @@ -0,0 +1,6 @@ +--- +title: "Documentazione di RustDesk" +--- + +# RustDesk + diff --git a/content/_index.jp.md b/content/_index.jp.md new file mode 100644 index 0000000..01f08c4 --- /dev/null +++ b/content/_index.jp.md @@ -0,0 +1,6 @@ +--- +title: "RustDeskのドキュメント" +--- + +# RustDesk + diff --git a/content/_index.ru.md b/content/_index.ru.md new file mode 100644 index 0000000..469931f --- /dev/null +++ b/content/_index.ru.md @@ -0,0 +1,6 @@ +--- +title: "Документация для RustDesk" +--- + +# RustDesk + diff --git a/content/_index.tw.md b/content/_index.tw.md new file mode 100644 index 0000000..2adba63 --- /dev/null +++ b/content/_index.tw.md @@ -0,0 +1,5 @@ +--- +title: "RustDesk文檔" +--- + +# RustDesk \ No newline at end of file diff --git a/content/self-host/_index.de.md b/content/self-host/_index.de.md new file mode 100755 index 0000000..df87aed --- /dev/null +++ b/content/self-host/_index.de.md @@ -0,0 +1,12 @@ +--- +title: Selbst-Host +weight: 5 +pre: "1. " +chapter: true +--- + +### Chapter 1 + +# Selbst-Host + +Wir entwickeln den Server kontinuierlich weiter. Wenn Sie Kommentare haben, nehmen Sie bitte an unserer [Discord](https://discord.com/invite/nDceKgxnkV)-Diskussion teil. \ No newline at end of file diff --git a/content/self-host/_index.it.md b/content/self-host/_index.it.md new file mode 100755 index 0000000..2bb60f1 --- /dev/null +++ b/content/self-host/_index.it.md @@ -0,0 +1,12 @@ +--- +title: Self-host +weight: 5 +pre: "1. " +chapter: true +--- + +### Capitolo 1 + +# Self-host + +Stiamo sviluppando continuamente il server, se hai commenti, partecipa alla nostra discussione su [Discord](https://discord.com/invite/nDceKgxnkV). \ No newline at end of file diff --git a/content/self-host/_index.jp.md b/content/self-host/_index.jp.md new file mode 100755 index 0000000..ad1f666 --- /dev/null +++ b/content/self-host/_index.jp.md @@ -0,0 +1,12 @@ +--- +title: セルフホスト +weight: 5 +pre: "1. " +chapter: true +--- + +### 章 1 + +# セルフホスト + +サーバーの開発は継続的に行っています。コメントがあれば、[Discord]（https://discord.com/invite/nDceKgxnkV）のディスカッションに参加してください。 \ No newline at end of file diff --git a/content/self-host/_index.ru.md b/content/self-host/_index.ru.md new file mode 100755 index 0000000..c80a857 --- /dev/null +++ b/content/self-host/_index.ru.md @@ -0,0 +1,12 @@ +--- +title: Самостоятельный хост +weight: 5 +pre: "1. " +chapter: true +--- + +### Глава 1 + +# Самостоятельный хост + +Wir entwickeln den Server kontinuierlich weiter. Wenn Sie Kommentare haben, nehmen Sie bitte an unserer [Discord](https://discord.com/invite/nDceKgxnkV)-Diskussion teil. \ No newline at end of file diff --git a/content/self-host/_index.tw.md b/content/self-host/_index.tw.md new file mode 100755 index 0000000..c6be302 --- /dev/null +++ b/content/self-host/_index.tw.md @@ -0,0 +1,12 @@ +--- +title: 自建服務器 +weight: 5 +pre: "1. " +chapter: true +--- + +### 章節 1 + +# 自建服務器 + +我們在持續開發服務器，如果您有什麼意見，請加入我們的[Discord](https://discord.com/invite/nDceKgxnkV)討論。 \ No newline at end of file diff --git a/content/self-host/install/_index.de.md b/content/self-host/install/_index.de.md new file mode 100644 index 0000000..1b588f3 --- /dev/null +++ b/content/self-host/install/_index.de.md @@ -0,0 +1,6 @@ +--- +title: Installation +weight: 10 +--- + +[English](/docs/en/self-host/install) \ No newline at end of file diff --git a/content/self-host/install/_index.en.md b/content/self-host/install/_index.en.md index a6c0236..4a4ca80 100644 --- a/content/self-host/install/_index.en.md +++ b/content/self-host/install/_index.en.md @@ -26,9 +26,9 @@ They are built on Centos7, tested on Centos7/8, Ubuntu 18/20. Run hbbs/hbbr on your server (Centos or Ubuntu). We suggust you use [pm2](https://pm2.keymetrics.io/) managing your service. -By default, hbbs listens on 21115(tcp) and 21116(tcp/udp), hbbr listens on 21117(tcp). Be sure to open these ports in the firewall. +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(21115, 21116, 21117) +- TCP(21114, 21115, 21116, 21117, 21118, 21119) - UDP(21116) Please run with "-h" option to see help if you wanna choose your own port. @@ -36,10 +36,9 @@ 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 -v `pwd`:/root -it --rm rustdesk/rustdesk-server hbbr -m -sudo docker run --name hbbs -p 21115:21115 -p 21116:21116 -p 21116:21116/udp -v `pwd`:/root -it --rm rustdesk/rustdesk-server hbbs -r -m +sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -it --rm rustdesk/rustdesk-server hbbr -m +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 -m ``` -- Note: If you wish to host the server on your own for demonstration or testing purposes, you can specificy `demo` within the `` flag. This will allow your server to run for 30 days. ### STEP-3 : Set hbbs/hbbr address on client-side @@ -48,20 +47,35 @@ Click on menu button on the right side of ID as below, choose "ID/Relay Server". ![](/docs/en/self-host/install/images/server-set-menu.png) -Please input hbbs host or ip address in ID server input box on remote and local side, and hbbr host or ip address in relay server input box on remote side. +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. e.g. ``` hbbs.yourhost.com -hbbr.yourhost.com ``` or ``` hbbs.yourhost.com:21116 -hbbr.yourhost.com:21117 ``` -![](/docs/en/self-host/install/images/server-set-window.png) \ No newline at end of file +![](/docs/en/self-host/install/images/server-set-window.png) + +### Key +Different from the old version, the Key in this version is mandatory. When hbbs runs for the first time, it will automatically generate a pair of encrypted private key and public key (respectively located in the `id_ed25519` and `id_ed25519.pub` files in the running directory), its main purpose is for communication encryption, if you did not fill in the Key in the previous step (the content in the public key file `id_ed25519.pub`), + +```` +cat ./id_ed25519.pub +```` + +does not affect the connection, but the connection cannot be encrypted. If you prohibit users without keys from establishing non-encrypted connections, please add the `-k _` parameter when running hbbs and hbbr, for example: +```` +./hbbs -r
-k _ +./hbbr -k _ +```` + +***Key can also be seen on the console homepage*** \ No newline at end of file diff --git a/content/self-host/install/_index.fr.md b/content/self-host/install/_index.fr.md index cadbf68..41cc0a1 100644 --- a/content/self-host/install/_index.fr.md +++ b/content/self-host/install/_index.fr.md @@ -1,42 +1,6 @@ --- -title: Linux +title: Installer weight: 10 --- - -### Installer NodeJs -Veuillez [Télécharger](https://nodejs.org/dist/v16.14.2/node-v16.14.2-x86.msi) et installer. -NodeJs est l'environnement d'exécution de pm2, vous devez donc d'abord installer NodeJs。 - -### Installer pm2 -Entrez ci-dessous dans cmd.exe, appuyez sur la touche Entrée pour chaque ligne et exécutez-les ligne par ligne. -``` -npm install -g pm2 -npm install pm2-windows-startup -g -pm2-startup install -``` - -### Exécutez hbbr et hbbs -Téléchargez la version Windows du [programme serveur](https://github.com/rustdesk/rustdesk-server/releases), en supposant que vous la décompressez sur le lecteur C. Exécutez respectivement les quatre lignes de commandes suivantes. -``` -cd c:\rustdesk-server-windows-x64 -pm2 start hbbr.exe -- -m -pm2 start hbbs.exe -- -r -m -pm2 save -``` - -### Afficher le journal -``` -pm2 log hbbr -pm2 log hbbs -``` - -### Modifier l'e-mail -Par exemple, la nouvelle adresse e-mail enregistrée est test@test.com, et l'adresse publique de hbbr est test.hbbr.com -``` -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 save -``` \ No newline at end of file +[English](/docs/en/self-host/install) \ No newline at end of file diff --git a/content/self-host/install/_index.it.md b/content/self-host/install/_index.it.md new file mode 100644 index 0000000..6973e9a --- /dev/null +++ b/content/self-host/install/_index.it.md @@ -0,0 +1,6 @@ +--- +title: Installazione +weight: 10 +--- + +[English](/docs/en/self-host/install) \ No newline at end of file diff --git a/content/self-host/install/_index.jp.md b/content/self-host/install/_index.jp.md new file mode 100644 index 0000000..c5aca04 --- /dev/null +++ b/content/self-host/install/_index.jp.md @@ -0,0 +1,6 @@ +--- +title: インストール +weight: 10 +--- + +[English](/docs/en/self-host/install) \ No newline at end of file diff --git a/content/self-host/install/_index.ru.md b/content/self-host/install/_index.ru.md new file mode 100644 index 0000000..5cd4d50 --- /dev/null +++ b/content/self-host/install/_index.ru.md @@ -0,0 +1,6 @@ +--- +title: Установка +weight: 10 +--- + +[English](/docs/en/self-host/install) \ No newline at end of file diff --git a/content/self-host/install/_index.tw.md b/content/self-host/install/_index.tw.md new file mode 100644 index 0000000..f875524 --- /dev/null +++ b/content/self-host/install/_index.tw.md @@ -0,0 +1,94 @@ +--- +title: 安裝 +weight: 10 +--- + +## 如何自建中繼 +----------- + +### 步驟1: 下載服務器端軟件程序 + +[下載](https://gitee.com/rustdesk/rustdesk-server/)或者使用docker rustdesk/rustdesk-server，**注意**： 你需要[購買許可](https://rustdesk.com/server/)才能正常運行本程序 + +提供三個版本： + - Linux + - Windows + +以下針對Linux版本做使用說明。 + +有兩個可執行文件: + - hbbs - RustDesk ID註冊服務器 + - hbbr - RustDesk 中繼服務器 + +下載後務必 +``` +chmod a+x hbbs hbbr +``` + +Linux版本在Centos7構建，在 Centos7/8，Ubuntu 18/20上測試過，Debian系列的發行版本應該都沒有問題。如果有其他發行版本需求，請聯繫我。 + +#### 服務器要求 +硬件要求很低，最低配置的雲服務器就可以了，CPU和內存要求都是最小的。關於網絡大小，如果TCP打洞直連失敗，就要耗費中繼流量，一個中繼連接的流量在30k-3M每秒之間（1920x1080屏幕），取決於清晰度設置和畫面變化，如果只是辦公需求，平均在100K。 + +### 步驟2: 在服務器上運行 hbbs 和 hbbr + +在服務器上運行 hbbs/hbbr (Centos 或 Ubuntu)。建議使用[pm2](https://pm2.keymetrics.io/) 管理服務。 + +需要先運行 hbbr, 可以不帶任何參數; +然後運行 hbbs: +``` +./hbbs -r +``` +hhbs的-r參數不是必須的，他只是方便你不用在客戶端指定中繼服務器。客戶端指定的中繼服務器優先級高於這個。 + +默認情況下，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）支持，對應端口可以不開。 + +- TCP(21114, 21115, 21116, 21117, 21118, 21119) +- UDP(21116) + +如果你想選擇**自己的端口**，使用 “-h” 選項查看幫助。 + +#### 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 +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 -m +``` + +### 步驟3: 在客戶端設置 hbbs/hbbr 地址 + +點擊 ID 右側的菜單按鈕如下，選擇“ ID/中繼服務器”。 + +![](/docs/en/self-host/install/images/server-set-menu-zh.png) + +在 ID 服務器輸入框中（被控端+主控端）輸入 hbbs 主機或 ip 地址，另外兩個地址可以不填，RustDesk會自動推導（如果沒有特別設定），中繼服務器指的是hbbr（21116）端口，API服務器指的是上面的網頁控制台+API（21114）。 + +**請注意**圖中的Key不是指的註冊郵箱，[下節](#key)將會具體解釋。 + +例如: + +``` +hbbs.yourhost.com +``` + +或者 + +``` +hbbs.yourhost.com:21116 +``` +![](/docs/en/self-host/install/images/server-set-window-zh.png) + +### Key +同上個版本不同，本版本中的Key是強制的，hbbs在第一次運行時，會自動產生一對加密私鑰和公鑰（分別位於運行目錄下的`id_ed25519`和`id_ed25519.pub`文件中），其主要用途是為了通訊加密，如果您在上一步驟中沒有填寫Key(公鑰文件`id_ed25519.pub`中的內容)， + +``` +cat ./id_ed25519.pub +``` + +不影響連接，但是連接無法加密。如果您禁止沒有Key的用戶建立非加密連接，請在運行hbbs和hbbr的時候添加`-k _ `參數，例如: +``` +./hbbs -r -k _ +./hbbr -k _ +``` + +***在控制台首頁也可以看到Key*** \ No newline at end of file diff --git a/content/self-host/install/_index.zh.md b/content/self-host/install/_index.zh.md index 10e6c58..829a90f 100644 --- a/content/self-host/install/_index.zh.md +++ b/content/self-host/install/_index.zh.md @@ -41,7 +41,7 @@ Linux版本在Centos7构建，在 Centos7/8，Ubuntu 18/20上测试过，Debian ``` hhbs的-r参数不是必须的，他只是方便你不用在客户端指定中继服务器。客户端指定的中继服务器优先级高于这个。 -默认情况下，hbbs 监听21114(tcp), 21115(tcp), 21116(tcp/udp), 21118(tcp)，hbbr 监听21117(tcp), 21119(tcp)。务必在防火墙开启这几个端口， **请注意21116同时要开启TCP和UDP**。其中21115是hbbs用作NAT类型测试，21116/UDP是hbbs用作ID注册与心跳服务，21116/TCP是hbbs用作TCP打洞与连接服务，21117是hbbr用作中继服务, 21118和21119是为了支持网页客户端，21114是网页控制台和API。 +默认情况下，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）支持，对应端口可以不开。 - TCP(21114, 21115, 21116, 21117, 21118, 21119) - UDP(21116) @@ -61,9 +61,9 @@ sudo docker run --name hbbs -p 21114:21114 -p 21115:21115 -p 21116:21116 -p 2111 ![](/docs/en/self-host/install/images/server-set-menu-zh.png) -在 ID 服务器输入框中（被控端+主控端）输入 hbbs 主机或 ip 地址，在中继服务器输入框中（被控制的一端，主控端无需设置）输入 hbbr 主机或 ip 地址。 +在 ID 服务器输入框中（被控端+主控端）输入 hbbs 主机或 ip 地址，另外两个地址可以不填，RustDesk会自动推导（如果没有特别设定），中继服务器指的是hbbr（21116）端口，API服务器指的是上面的网页控制台+API（21114）。 -**请注意**图中的Key不是指的注册邮箱，对应的是hhbr/hhbs的-k参数，这是为了防止别人盗用你的hbbr/hbbs使用。 +**请注意**图中的Key不是指的注册邮箱，[下节](#key)将会具体解释。 例如: @@ -76,4 +76,21 @@ hbbs.yourhost.com ``` hbbs.yourhost.com:21116 ``` -![](/docs/en/self-host/install/images/server-set-window-zh.png) \ No newline at end of file +![](/docs/en/self-host/install/images/server-set-window-zh.png) + +### Key +同上个版本不同，本版本中的Key是强制的，hbbs在第一次运行时，会自动产生一对加密私钥和公钥（分别位于运行目录下的`id_ed25519`和`id_ed25519.pub`文件中），其主要用途是为了通讯加密，如果您在上一步骤中没有填写Key(公钥文件`id_ed25519.pub`中的内容)， + +``` +cat ./id_ed25519.pub +``` + +不影响连接，但是连接无法加密。如果您禁止没有Key的用户建立非加密连接，请在运行hbbs和hbbr的时候添加`-k _ `参数，例如: +``` +./hbbs -r -k _ +./hbbr -k _ +``` + +***在控制台首页也可以看到Key*** + + diff --git a/content/self-host/windows/_index.de.md b/content/self-host/windows/_index.de.md new file mode 100644 index 0000000..2e08fed --- /dev/null +++ b/content/self-host/windows/_index.de.md @@ -0,0 +1,6 @@ +--- +title: Windows +weight: 20 +--- + +[English](/docs/en/self-host/windows) \ No newline at end of file diff --git a/content/self-host/windows/_index.it.md b/content/self-host/windows/_index.it.md new file mode 100644 index 0000000..2e08fed --- /dev/null +++ b/content/self-host/windows/_index.it.md @@ -0,0 +1,6 @@ +--- +title: Windows +weight: 20 +--- + +[English](/docs/en/self-host/windows) \ No newline at end of file diff --git a/content/self-host/windows/_index.jp.md b/content/self-host/windows/_index.jp.md new file mode 100644 index 0000000..2e08fed --- /dev/null +++ b/content/self-host/windows/_index.jp.md @@ -0,0 +1,6 @@ +--- +title: Windows +weight: 20 +--- + +[English](/docs/en/self-host/windows) \ No newline at end of file diff --git a/content/self-host/windows/_index.ru.md b/content/self-host/windows/_index.ru.md new file mode 100644 index 0000000..2e08fed --- /dev/null +++ b/content/self-host/windows/_index.ru.md @@ -0,0 +1,6 @@ +--- +title: Windows +weight: 20 +--- + +[English](/docs/en/self-host/windows) \ No newline at end of file diff --git a/content/self-host/windows/_index.tw.md b/content/self-host/windows/_index.tw.md new file mode 100644 index 0000000..7d9888b --- /dev/null +++ b/content/self-host/windows/_index.tw.md @@ -0,0 +1,41 @@ +--- +title: Windows +weight: 20 +--- + +### 安裝NodeJs +請點擊[下載](https://nodejs.org/dist/v16.14.2/node-v16.14.2-x86.msi)安裝，可能會有點慢，如果卡頓太久，嘗試關掉重新安裝。 +NodeJs是pm2的運行時環境，所以要先安裝NodeJs。 + +### 安裝pm2 +在cmd.exe中分別輸入下面三行，每一行都要按回車鍵，一行一行運行。 +``` +npm install -g pm2 +npm install pm2-windows-startup -g +pm2-startup install +``` + +### 運行hbbr和hbbs +下載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 save +``` + +### 查看log +``` +pm2 log hbbr +pm2 log hbbs +``` + +### 更換註冊郵箱 +比如新的註冊郵箱是test@test.com，hbbr的公網地址是test.hbbr.com +``` +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 save +``` \ No newline at end of file diff --git a/layouts/partials/logo.html b/layouts/partials/logo.html index 987a48b..1a870d1 100644 --- a/layouts/partials/logo.html +++ b/layouts/partials/logo.html @@ -1,4 +1,4 @@ -