From b08bfca7724ed2b1def059a01732a6fe5d25c76c Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:21:36 +0100 Subject: [PATCH 01/18] Update _index.en.md --- content/client/linux/_index.en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/client/linux/_index.en.md b/content/client/linux/_index.en.md index 7893c91..c883009 100755 --- a/content/client/linux/_index.en.md +++ b/content/client/linux/_index.en.md @@ -33,7 +33,7 @@ sudo zypper install --allow-unsigned-rpm ./rustdesk--suse.rpm ### ~~X11 Required~~ ~~RustDesk does not support Wayland yet; you need switch to X11 manually.~~ -RustDesk now has experimental Wayland support since v1.2.0. +RustDesk now has experimental Wayland support since version 1.2.0. #### Display Server From b7949c3c5fb6ae9eebf6d3bd10269734b2443c42 Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:22:58 +0100 Subject: [PATCH 02/18] Update _index.en.md --- content/client/linux/_index.en.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/client/linux/_index.en.md b/content/client/linux/_index.en.md index c883009..b3baa98 100755 --- a/content/client/linux/_index.en.md +++ b/content/client/linux/_index.en.md @@ -69,4 +69,3 @@ The number in parentheses after `audit` is timestamp. {{% /notice %}} If the output contains `avc: denied`, you need to add SELinux policies, please refer to [SELinux](https://rustdesk.com/docs/en/client/linux/selinux/). - From ee837e16155ce6294bd7b81f6257438d5224379b Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:26:11 +0100 Subject: [PATCH 03/18] Update _index.en.md --- content/client/mac/_index.en.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/content/client/mac/_index.en.md b/content/client/mac/_index.en.md index b118170..88cc61b 100755 --- a/content/client/mac/_index.en.md +++ b/content/client/mac/_index.en.md @@ -27,7 +27,7 @@ more. You have to enable "Input Monitoring" permission on local Mac side. Please follow this [https://github.com/rustdesk/rustdesk/issues/974#issuecomment-1185644923](https://github.com/rustdesk/rustdesk/issues/974#issuecomment-1185644923). -In 1.2.4, you can try out `Input source 2` which can be seen by clicking on keyboard icon on the toolbar. +In version 1.2.4, you can try out `Input source 2` which can be seen by clicking on keyboard icon on the toolbar. {{% /notice %}} To capture screen, you need to grant RustDesk **Accessibility** permission and **Screen Recording** permission. RustDesk will guide you to the settings window. @@ -36,17 +36,13 @@ To capture screen, you need to grant RustDesk **Accessibility** permission and * | --- | --- | | ![](/docs/en/client/mac/images/acc.png) | ![](/docs/en/client/mac/images/acc3.png?v2) | -If you have enabled it in the settings window, but RustDesk still warns. Please remove RustDesk from the settings windows by the `-` button, and click on `+` button, select RustDesk in `/Applications`. +If you have enabled it in the settings window, but RustDesk still warns. Please remove `RustDesk` from the settings windows by the `-` button, and click on `+` button, select `RustDesk` in `Applications`. {{% notice note %}} -[https://github.com/rustdesk/rustdesk/issues/3261](https://github.com/rustdesk/rustdesk/issues/3261) - -Other helpless attempts: - -``` -tccutil reset ScreenCapture com.carriez.RustDesk -tccutil reset Accessibility com.carriez.RustDesk -``` +[https://github.com/rustdesk/rustdesk/issues/3261](https://github.com/rustdesk/rustdesk/issues/3261)
+Other helpless attempts:
+`tccutil reset ScreenCapture com.carriez.RustDesk`
+`tccutil reset Accessibility com.carriez.RustDesk`
Reboot is still required. {{% /notice %}} From 58c544a99afa85749f26427905ad001c5e658bbd Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:28:00 +0100 Subject: [PATCH 04/18] Update _index.en.md --- content/dev/build/all/_index.en.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/dev/build/all/_index.en.md b/content/dev/build/all/_index.en.md index 9c59ac5..425b6e5 100644 --- a/content/dev/build/all/_index.en.md +++ b/content/dev/build/all/_index.en.md @@ -16,7 +16,8 @@ Go to https://github.com/rustdesk/rustdesk/fork and click "Create fork". {{% notice note %}} You only need to do this if you want to change the default server and public key. -The server URL and key you are using is hidden from other users on GitHub however they can download your client and connect to your server. If you require a fully private repo you can import the RustDesk Client repo using https://github.com/new/import. **If you use a private repo you have limited amounts of builds you can create per month, if you need more you will need to have a paid GitHub account.** +The server URL and key you are using is hidden from other users on GitHub however they can download your client and connect to your server. If you require a fully private repo you can import the RustDesk Client repo using https://github.com/new/import.
+**If you use a private repo you have limited amounts of builds you can create per month, if you need more you will need to have a paid GitHub account.** {{% /notice %}} On your fork you just created go to "Settings → Secrets and variables → Actions". From ea7d223efac8c86396828be32a341e3bb31ccd4e Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:28:56 +0100 Subject: [PATCH 05/18] Update _index.en.md --- content/dev/build/android/_index.en.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/dev/build/android/_index.en.md b/content/dev/build/android/_index.en.md index c94b608..effc00a 100644 --- a/content/dev/build/android/_index.en.md +++ b/content/dev/build/android/_index.en.md @@ -138,7 +138,7 @@ You'll might need to disable building Flutter Rust Bridge from `build.rs` file, sed -i "s/gen_flutter_rust_bridge();/\/\//g" build.rs ``` -#### Building rustdesk lib +#### Building RustDesk library At this step you'll build `librustdesk.so` file. First, add triplet to rust: @@ -215,4 +215,3 @@ If you want you might move builded app somewhere else, feel free to run: ``` mv build/app/outputs/flutter-apk/app-arm64-v8a-release.apk ../rustdesk-release.apk ``` - From 48f30ce35bdd8b19b70c534dd33700d9449c300c Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:29:55 +0100 Subject: [PATCH 06/18] Update _index.en.md --- content/dev/build/windows/_index.en.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/dev/build/windows/_index.en.md b/content/dev/build/windows/_index.en.md index d907448..8e25182 100644 --- a/content/dev/build/windows/_index.en.md +++ b/content/dev/build/windows/_index.en.md @@ -45,7 +45,7 @@ Desktop versions use [Sciter](https://sciter.com/) for GUI, please download [sci `rust-bindgen` depends on `clang`, download [LLVM](https://github.com/llvm/llvm-project/releases) and install, add System environment variable `LIBCLANG_PATH`=`/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.0.2 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 @@ -59,4 +59,3 @@ wget https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.win/x64/sci mv sciter.dll target/debug cargo run ``` - From aa5382b51cc1751b4f96df65639895933e6d56ce Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:31:33 +0100 Subject: [PATCH 07/18] Update _index.en.md --- content/self-host/_index.en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/self-host/_index.en.md b/content/self-host/_index.en.md index 57e667e..6aca48c 100755 --- a/content/self-host/_index.en.md +++ b/content/self-host/_index.en.md @@ -10,7 +10,7 @@ Support is available via our [Discord](https://discord.com/invite/nDceKgxnkV) fo ### Basic Setup -https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/install/#set-up-your-own-server-instance-manually +[Set up your own server instance manually.](https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/install/#set-up-your-own-server-instance-manually) ### Ports Required From 49b7accb15693f9db18be2c940d3dcd17ab1b98f Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:33:28 +0100 Subject: [PATCH 08/18] Update _index.en.md --- .../self-host/client-configuration/_index.en.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/content/self-host/client-configuration/_index.en.md b/content/self-host/client-configuration/_index.en.md index 3cfa392..03b6ca1 100644 --- a/content/self-host/client-configuration/_index.en.md +++ b/content/self-host/client-configuration/_index.en.md @@ -8,7 +8,7 @@ pre: "2.3. " There are a number of ways to configure RustDesk Clients to use your own self-hosted server, we will cover some below. -### 1, Manual Config +### 1. Manual Config 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. @@ -43,7 +43,7 @@ e.g. your API Server runs on default https port, please specify `API Server` wit If you still can not confirm the value of `API Server`, please go to the welcome page of web console, the `API Server` is shown in above picture (The input box with `API:` label). -### 2, Setup Using Import or Export +### 2. Setup Using Import or Export 1. Use the steps [above](https://rustdesk.com/docs/en/self-host/client-configuration/#manual-config) to configure RustDesk Client on a Device. 2. Using the above machine go to Settings then Network and unlock. @@ -54,7 +54,7 @@ If you still can not confirm the value of `API Server`, please go to the welcome 7. It will automatically paste the settings in. 8. Click `Apply`. -### 3, Automatic Config +### 3. Automatic Config The easiest way to setup automatically is using deployment scripts found [here](https://rustdesk.com/docs/en/self-host/client-deployment/). @@ -62,7 +62,7 @@ You can fix the Password is required and use a reverse Base64 string in the form You can also use the steps from [above](https://rustdesk.com/docs/en/self-host/client-configuration/#setup-using-import-or-export) to export the string, remove any `=` at the start or end of the string. Restart RustDesk Client if settings don't show. -### 4, Put config in rustdesk.exe file name (Windows only) +### 4. Put config in rustdesk.exe file name (Windows only) Change `rustdesk.exe` to rustdesk-`host=,key=`.exe, e.g. rustdesk-`host=192.168.1.137,key=xfdsfsd32=32`.exe. You can see the config result in the About Window below. @@ -88,12 +88,9 @@ Example: `rustdesk-licensed--{encrypted string}--.exe` We have noticed that in some cases, when double downloaded, something like `copy (1)` is added to the end of the file name, and this ruins the config. -By adding `-- `at the end right after our config string, even if something is added to the file name, it won't corrupt the config string, and RustDesk will correctly retrieve it. +By adding `--` at the end right after our config string, even if something is added to the file name, it won't corrupt the config string, and RustDesk will correctly retrieve it. -{{% notice note %}} -{{% /notice %}} - -### 5, [Hardcoding](https://rustdesk.com/docs/en/self-host/client-configuration/hardcode-settings/) +### 5. [Hardcoding Custom Settings](https://rustdesk.com/docs/en/self-host/client-configuration/hardcode-settings/) ### Logging your user in (RustDesk Server Pro) @@ -113,4 +110,3 @@ You can add and assign Tags in your address book to help organize devices as wel By default once signed in all devices connected to your RustDesk Server Pro will show up in group, (you will still need the passwords for unattended access but all devices are now there), it will show any other users in your group and if you assign cross group access in the web console it will show users [in those groups](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console/#add-new-groups) as well. If you would like to add devices to your own address book, you can click on the Menu button [ ⋮ ] next to the device and click `Add to address book`. - From 76bfebfffb9c657e31e8e93144fe84eb1657f2a9 Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:36:15 +0100 Subject: [PATCH 09/18] Update _index.en.md --- .../client-configuration/hardcode-settings/_index.en.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/content/self-host/client-configuration/hardcode-settings/_index.en.md b/content/self-host/client-configuration/hardcode-settings/_index.en.md index 4ee188e..090d699 100644 --- a/content/self-host/client-configuration/hardcode-settings/_index.en.md +++ b/content/self-host/client-configuration/hardcode-settings/_index.en.md @@ -5,8 +5,8 @@ weight: 49 ### Custom Server {{% notice note %}} -To hardcode custom server settings into your executables you must [build](https://rustdesk.com/docs/en/dev/build/) the client yourself on your machine or [with GitHub Actions](https://rustdesk.com/docs/en/dev/build/all/).
-**Noted**: [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners) for Arm are used in our GitHub actions, please set it up yourself. +To hardcode custom server settings into your executables you must [build](https://rustdesk.com/docs/en/dev/build/) the client yourself on your machine or [with GitHub Actions](https://rustdesk.com/docs/en/dev/build/all/).
+**Note**: [self-hosted runners](https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners) for Arm are used in our GitHub actions, please set it up yourself. {{% /notice %}} {{% notice note %}} **If you set either of these values without setting the other, your executable will not work!** @@ -32,11 +32,10 @@ This should be a string such as OeVuKk5nlHiXp+APNn0Y3pC1Iwpwn44JGqrQCsWqmBw= ``` -### API_SERVER -By default the API_SERVER runs on `http://rustdesk.my-domain.com:21114`, you'd better run it behind nginx for security with https. +#### API_SERVER +By default the API_SERVER runs on `http://rustdesk.my-domain.com:21114`, you'd better run it behind Nginx for security with HTTPS. This should be a string such as ``` https://rustdesk.my-domain.com ``` - From 7a83294841c84e65d147b142c32716bd8e2715d1 Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:38:15 +0100 Subject: [PATCH 10/18] Update _index.en.md --- content/self-host/client-deployment/_index.en.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/content/self-host/client-deployment/_index.en.md b/content/self-host/client-deployment/_index.en.md index 6a0735a..ef5d45b 100644 --- a/content/self-host/client-deployment/_index.en.md +++ b/content/self-host/client-deployment/_index.en.md @@ -47,13 +47,13 @@ function getLatest() $src = [System.Text.Encoding]::Unicode.GetBytes($Page.Content) $HTML.write($src) } - + # Current example link: https://github.com/rustdesk/rustdesk/releases/download/1.2.3/rustdesk-1.2.3-x86_64.exe $Downloadlink = ($HTML.Links | Where {$_.href -match '(.)+\/rustdesk\/rustdesk\/releases\/download\/\d{1}.\d{1,2}.\d{1,2}(.{0,3})\/rustdesk(.)+x86_64.exe'} | select -first 1).href - + # bugfix - sometimes you need to replace "about:" $Downloadlink = $Downloadlink.Replace('about:', 'https://github.com') - + $Version = "unknown" if ($Downloadlink -match './rustdesk/rustdesk/releases/download/(?.*)/rustdesk-(.)+x86_64.exe') { @@ -67,7 +67,7 @@ function getLatest() } # Create object to return - $Result = New-Object PSObject -Property + $Result = New-Object PSObject -Property @{ Version = $Version Downloadlink = $Downloadlink @@ -83,7 +83,7 @@ $rdver = ((Get-ItemProperty "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Un if ($rdver -eq $RustDeskOnGitHub.Version) { - Write-Output "RustDesk $rdver is the newest version" + Write-Output "RustDesk $rdver is the newest version." Exit } @@ -358,4 +358,3 @@ fi echo "Password: $rustdesk_pw" echo "..............................................." ``` - From 1f163ccf12e3fe4b7829d43c162c4d8e9160ec5f Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:39:46 +0100 Subject: [PATCH 11/18] Update _index.en.md --- content/self-host/rustdesk-server-oss/windows/_index.en.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/content/self-host/rustdesk-server-oss/windows/_index.en.md b/content/self-host/rustdesk-server-oss/windows/_index.en.md index d01801b..62c4220 100644 --- a/content/self-host/rustdesk-server-oss/windows/_index.en.md +++ b/content/self-host/rustdesk-server-oss/windows/_index.en.md @@ -4,7 +4,7 @@ weight: 20 --- {{% notice note %}} -Windows security policy is tricky, if this tutorial does not work for you, or you encounter unstable connection, please migrate to `Linux` server. +Windows security policy is tricky, if this tutorial does not work for you, or you encounter unstable connection, please migrate to a Linux server. {{% /notice %}} ### A crossroads @@ -55,7 +55,7 @@ nssm install "RustDesk hbbr service" "C:\Program Files\RustDesk Server\hbbr.exe" - You can change `RustDesk hbbr service` to whatever you desire to name hbbr the service - You can change `C:\Program Files\RustDesk Server\hbbs.exe` to wherever you placed the RustDesk binaries - You can change `C:\Program Files\RustDesk Server\hbbr.exe` to wherever you placed the RustDesk binaries -- You do not need the `-k _` option which is optional, it's just for better security. In `Pro` version, please ignore `-k _` which is applied implicitly. +- You do not need the `-k _` option which is optional, it's just for better security. In the `Pro` version, please ignore `-k _` which is applied implicitly. **Command templates:** @@ -103,7 +103,7 @@ Download the Windows version of [RustDesk Server](https://github.com/rustdesk/ru ```cmd cd C:\rustdesk-server-windows-x64 -pm2 start hbbs.exe +pm2 start hbbs.exe pm2 start hbbr.exe pm2 save ``` @@ -114,4 +114,3 @@ pm2 save pm2 log hbbr pm2 log hbbs ``` - From 915b8bcdd71f5bcff97f0d7c48200a9c5ebbf695 Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:41:00 +0100 Subject: [PATCH 12/18] Update _index.en.md --- .../self-host/rustdesk-server-pro/_index.en.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/content/self-host/rustdesk-server-pro/_index.en.md b/content/self-host/rustdesk-server-pro/_index.en.md index 3b45ff2..b38a280 100644 --- a/content/self-host/rustdesk-server-pro/_index.en.md +++ b/content/self-host/rustdesk-server-pro/_index.en.md @@ -6,20 +6,20 @@ pre: "2.2. " RustDesk Server Pro has more features compared to the open source version. -- No concurrent connection limit, aka no limit of simultaneous connections (OSS version has no limit either, but Teamviewer etc have this limit) -- [Web console](/docs/en/self-host/rustdesk-server-pro/console/) +- No concurrent connection limit, aka no limit of simultaneous connections (OSS version has no limit either, but TeamViewer etc. have this limit) +- [Web console](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console/) - API -- [OIDC](/docs/en/self-host/rustdesk-server-pro/oidc/), LDAP, [2FA](/docs/en/self-host/rustdesk-server-pro/2fa/) +- [OIDC](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/oidc/), LDAP, [2FA](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/2fa/) - Address book - Rename - Log management (Connection, file transfer, alarm, etc.) - Device management -- [Security Settings sync](/docs/en/self-host/rustdesk-server-pro/strategy/) -- [Access control](/docs/en/self-host/rustdesk-server-pro/permissions/) -- [Multiple relay servers](/docs/en/self-host/rustdesk-server-pro/relay/) (automatically selects your closest relay) +- [Security Settings sync](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/strategy/) +- [Access control](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/permissions/) +- [Multiple relay servers](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/relay/) (automatically selects your closest relay) {{% notice note %}} -RustDesk Client >= 1.2.0 required +RustDesk Client ≥ 1.2.0 required {{% /notice %}} ### Hardware requirement @@ -54,4 +54,3 @@ You need port 21114-21119 TCP and 21116 UDP open, please ensure these ports are {{% notice note %}} You should use a proxy like Nginx to deliver this over HTTPS requiring port 443 to be opened. {{% /notice %}} - From 73c4f67c27bfcefa61a65d0bdd745c7f25c890fd Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:42:11 +0100 Subject: [PATCH 13/18] Update _index.en.md --- .../rustdesk-server-pro/2FA/_index.en.md | 30 ++++++++----------- 1 file changed, 13 insertions(+), 17 deletions(-) diff --git a/content/self-host/rustdesk-server-pro/2FA/_index.en.md b/content/self-host/rustdesk-server-pro/2FA/_index.en.md index 0ae2f68..fabf086 100644 --- a/content/self-host/rustdesk-server-pro/2FA/_index.en.md +++ b/content/self-host/rustdesk-server-pro/2FA/_index.en.md @@ -7,8 +7,8 @@ When logging in to your account, turning on Two-Factor Authentication (2FA) veri Our web console currently supports two kinds of 2FA: -1. Email verification. -2. TOTP. A third-party authentication app is required to generate the verification code, such as [Authy](https://authy.com/), [Microsoft](https://www.microsoft.com/en-us/security/mobile-authenticator-app/ ), [Google](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2/) authentication app. +1. Email verification +2. TOTP. A third-party authentication app is required to generate the verification code, such as [Authy](https://authy.com), [Microsoft Authenticator](https://www.microsoft.com/en-us/security/mobile-authenticator-app/) and [Google Authenticator](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2) authentication app. You first need to go to the account settings page. @@ -19,7 +19,8 @@ You first need to go to the account settings page. To enable email verification for login, you need: 1. Set email. -2. Enable the "Enable email login verification" option. +2. Enable the `Enable email login verification` option. +3. Click on `Submit`. ![](/docs/en/self-host/rustdesk-server-pro/2FA/images/2-2fa-email-1.png) @@ -27,7 +28,6 @@ When we log in next time, RustDesk will send us a verification code email, and t ![](/docs/en/self-host/rustdesk-server-pro/2FA/images/2-2fa-email-2.png) - ### TOTP TOTP is a widely used 2FA method, so in the web console of RustDesk Server Pro, 2FA refers to TOTP verification. @@ -35,20 +35,18 @@ TOTP is a widely used 2FA method, so in the web console of RustDesk Server Pro, #### Prepare authentication app First, you need to prepare an authentication app. -You can choose from these types [Authy](https://authy.com/), [Microsoft](https://www.microsoft.com/en-us/security/mobile-authenticator-app/), [Google](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2/) authentication app. +You can choose from these types [Authy](https://authy.com), [Microsoft Authenticator](https://www.microsoft.com/en-us/security/mobile-authenticator-app/) and [Google Authenticator](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2) authentication app. #### Enable 2FA -When the "Enable 2FA" button is displayed on the settings page, it means that 2FA is not currently enabled. +When the `Enable 2FA` button is displayed on the settings page, it means that 2FA is not currently enabled. ![](/docs/en/self-host/rustdesk-server-pro/2FA/images/3-2fa-enable-1.png) - Click the button and a form will pop up to enable 2FA. ![](/docs/en/self-host/rustdesk-server-pro/2FA/images/3-2fa-enable-2.png) - Open the authenticator app, add an account by scanning the QR code. If you are inconvenient to scan the QR code, you can also enter the code here directly. @@ -57,15 +55,15 @@ If you are inconvenient to scan the QR code, you can also enter the code here di After adding the account in the authenticator app, enter the verification code in the authenticator app to turn on 2FA. -After 2FA is successfully turned on, RustDesk Server Pro will also be bound to 6 **backup codes**. So that you can use these **bacoup codes** to pass the verification even if you are unable to use the authenticator app. +After 2FA is successfully turned on, RustDesk Server Pro will also be bound to 6 **backup codes**. So that you can use these **backup codes** to pass the verification even if you are unable to use the authenticator app. ![](/docs/en/self-host/rustdesk-server-pro/2FA/images/3-2fa-enable-4.png) - -**Note**: - +{{% notice note %}} 1. These backup codes can only be used once. + 2. Please keep the backup codes in a safe place. +{{% /notice %}} #### Login verification @@ -73,22 +71,18 @@ When 2FA is enabled, email login verification is no longer used. We will be usin ![](/docs/en/self-host/rustdesk-server-pro/2FA/images/3-2fa-enable-login-5.png) - When logging in, you will be redirected to the verification page. ![](/docs/en/self-host/rustdesk-server-pro/2FA/images/3-2fa-enable-login-6.png) - #### Modify settings When 2FA is enabled, modifying account settings requires additional 2FA verification. ![](/docs/en/self-host/rustdesk-server-pro/2FA/images/3-2fa-settings-1.png) - ![](/docs/en/self-host/rustdesk-server-pro/2FA/images/3-2fa-settings-2.png) - #### 2FA state 2FA has a total of 3 states: not enabled, enabled and expired. @@ -99,4 +93,6 @@ When 2FA is enabled, modifying account settings requires additional 2FA verifica ![](/docs/en/self-host/rustdesk-server-pro/2FA/images/3-2fa-state-expired.png) -**Note**: 2FA can still be used normally after it expires. It just means that the 2FA settings haven't been changed for a long time (default 180 days). For security reasons, we recommend re-enabling 2FA, so the secret data can been updated. +{{% notice note %}} +2FA can still be used normally after it expires. It just means that the 2FA settings haven't been changed for a long time (default 180 days). For security reasons, we recommend re-enabling 2FA, so the secret data can been updated. +{{% /notice %}} From 1845e8af829391c6c5ee3f34ebaa7010b79c7302 Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:43:31 +0100 Subject: [PATCH 14/18] Update _index.en.md --- .../self-host/rustdesk-server-pro/console/_index.en.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/self-host/rustdesk-server-pro/console/_index.en.md b/content/self-host/rustdesk-server-pro/console/_index.en.md index fffb56c..24cb3c9 100644 --- a/content/self-host/rustdesk-server-pro/console/_index.en.md +++ b/content/self-host/rustdesk-server-pro/console/_index.en.md @@ -29,23 +29,23 @@ Non-administrator users can also login to browse their device and logs, change t ### Automatic Configs By Clicking on `Windows EXE` you will be able to get the configs for your own RustDesk Server Pro, this will help configure your clients. -For Windows clients, you can leave out the custom server configuration and put the configuration information in the `rustdesk.exe` filename instead. As shown above, please go to the console welcome page and click on `Windows EXE`. **Client >=1.1.9 Required.** +For Windows clients, you can leave out the custom server configuration and put the configuration information in the `rustdesk.exe` filename instead. As shown above, please go to the console welcome page and click on `Windows EXE`. **Client ≥ 1.1.9 required.** You can use this in conjunction with [client config](https://rustdesk.com/docs/en/self-host/client-configuration/) and [deployment scripts](https://rustdesk.com/docs/en/self-host/client-deployment/) to setup your clients. ### Creating a new user other than the default `admin` user -1. Click On `Users` on the left hand menu. +1. Click on `Users` on the left hand menu. 2. Create another account with `administrator` enabled. 3. Log in with the new administrative account. 4. Delete the `admin` on `Users` page. ### Creating a new user -1. Click On `Users` on the left hand menu. +1. Click on `Users` on the left hand menu. 2. Create a new user. 3. Select what group they should be in (if you need to add new groups please keep reading). ### Add a new Group -1. Click On `Groups` on the left hand menu. +1. Click on `Groups` on the left hand menu. 2. Create a new group. 3. Once created you can allow groups access each other, Click `Edit`. 4. Select the relevant groups you want access (it automatically adds them in the corresponding group). From 1c4e493015881b4bd911cdb04452fa03f52ebbb5 Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:44:20 +0100 Subject: [PATCH 15/18] Update _index.en.md --- .../self-host/rustdesk-server-pro/installscript/_index.en.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/content/self-host/rustdesk-server-pro/installscript/_index.en.md b/content/self-host/rustdesk-server-pro/installscript/_index.en.md index b3a494f..94ad3a9 100644 --- a/content/self-host/rustdesk-server-pro/installscript/_index.en.md +++ b/content/self-host/rustdesk-server-pro/installscript/_index.en.md @@ -6,7 +6,7 @@ weight: 10 {{% notice note %}} Don't forget to get your license from [https://rustdesk.com/pricing.html](https://rustdesk.com/pricing.html), check [license](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/) page for more details. -Please read [OSS installation](/docs/en/self-host/rustdesk-server-oss/install/) first before doing this simple install. You can know more underlying details there. +Please read [OSS installation](https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/install/) first before doing this simple install. You can know more underlying details there. {{% /notice %}} ### Install @@ -76,5 +76,3 @@ chmod +x restore.sh Copy the backup file into the same folder as the restore.sh file and then run `./restore.sh`. This will restore your server to how it was prior, you will need to revoke your [license](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/) to move it to the restored server. - - From 195270e877bddc85cfb6bfc5ffb71e4c2f385922 Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:45:19 +0100 Subject: [PATCH 16/18] Update _index.en.md --- .../rustdesk-server-pro/installscript/Docker/_index.en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/self-host/rustdesk-server-pro/installscript/Docker/_index.en.md b/content/self-host/rustdesk-server-pro/installscript/Docker/_index.en.md index 09e10eb..e006358 100644 --- a/content/self-host/rustdesk-server-pro/installscript/Docker/_index.en.md +++ b/content/self-host/rustdesk-server-pro/installscript/Docker/_index.en.md @@ -61,4 +61,4 @@ services: The run `docker compose up -d`. -> If you have problem with seLinux on Fedora, please check this https://github.com/rustdesk/rustdesk-server/issues/230 +> If you have problem with seLinux on Fedora, please check this [issue](https://github.com/rustdesk/rustdesk-server/issues/230). From b228597c5df1c4e719438903db690fb082948f37 Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:46:28 +0100 Subject: [PATCH 17/18] Update _index.en.md --- .../rustdesk-server-pro/installscript/windows/_index.en.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/self-host/rustdesk-server-pro/installscript/windows/_index.en.md b/content/self-host/rustdesk-server-pro/installscript/windows/_index.en.md index 48a72e1..48cb207 100644 --- a/content/self-host/rustdesk-server-pro/installscript/windows/_index.en.md +++ b/content/self-host/rustdesk-server-pro/installscript/windows/_index.en.md @@ -4,7 +4,7 @@ weight: 2 --- {{% notice note %}} -Windows security policy is tricky, if this tutorial does not work for you, or you encounter unstable connection, please migrate to `Linux` server. +Windows security policy is tricky, if this tutorial does not work for you, or you encounter unstable connection, please migrate to a Linux server. {{% /notice %}} ### Install @@ -12,7 +12,7 @@ Windows security policy is tricky, if this tutorial does not work for you, or yo 1. Get your license from [https://rustdesk.com/pricing.html](https://rustdesk.com/pricing.html), check [license](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/) page for more details. 2. Download the the Windows installer from [GitHub](https://github.com/rustdesk/rustdesk-server-pro/releases/latest). 3. Unzip the Windows installer. -4. Run the Installer and follow the steps on screen. (or manually install with [PM2 OR NSSM](/docs/en/self-host/rustdesk-server-oss/windows/)) +4. Run the Installer and follow the steps on screen. Or manually install with [PM2 or NSSM](https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/windows/). 5. Once its completed open RustDesk Server. 6. Follow the prompts as they guide you through the install. 7. Click `Services` and then `Start`. From d74ceecf9c09f591ed28def44e4264bd2b7d13ee Mon Sep 17 00:00:00 2001 From: Mr-Update <37781396+Mr-Update@users.noreply.github.com> Date: Fri, 9 Feb 2024 21:48:22 +0100 Subject: [PATCH 18/18] Update _index.en.md --- content/self-host/rustdesk-server-pro/relay/_index.en.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/content/self-host/rustdesk-server-pro/relay/_index.en.md b/content/self-host/rustdesk-server-pro/relay/_index.en.md index c6e4b35..69d9052 100644 --- a/content/self-host/rustdesk-server-pro/relay/_index.en.md +++ b/content/self-host/rustdesk-server-pro/relay/_index.en.md @@ -6,12 +6,11 @@ weight: 17 ### RustDesk Pro - Install Additional Relay Servers with Geo Location using docker {{% notice note %}} -[The simple install](/docs/en/self-host/rustdesk-server-pro/installscript/) creates a relay server (the `hbbr` process) implicitly on the same machine, you do not need to specify relay server explicitly. +[The simple install](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/installscript/) creates a relay server (the `hbbr` process) implicitly on the same machine, you do not need to specify relay server explicitly. -If you wanna create additional relay server explicitly on another machine, please run `hbbr` by following [OSS installation](/docs/en/self-host/rustdesk-server-oss/install/). You can find `hbbr` in `rustdesk-server-linux-amd64.tar.gz`, `rustdesk-server-hbbr_-.deb`, `rustdesk-server-windows-x86_64.tar.gz` or in `docker` (`sudo docker run ... rustdesk/rustdesk-server-pro hbbr`) +If you wanna create additional relay server explicitly on another machine, please run `hbbr` by following [OSS installation](https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/install/). You can find `hbbr` in `rustdesk-server-linux-amd64.tar.gz`, `rustdesk-server-hbbr_-.deb`, `rustdesk-server-windows-x86_64.tar.gz` or in `docker` (`sudo docker run ... rustdesk/rustdesk-server-pro hbbr`). `hbbr` does not require a license and is the same as the open source version. - {{% /notice %}} You can have several relay servers running across the globe and leverage GeoLocation to use the closest relay server, giving you a faster experience when connecting to remote computers. @@ -110,7 +109,7 @@ You can automate the [download process](https://dev.maxmind.com/geoip/updating-d #### Change settings in RustDesk Pro Web Console -Add your relay server IP addresses or DNS names (DNS is supported in version `1.1.11`) to the the `Relay Servers`. **Port is not required, `21117` port is used explictly.**
+Add your relay server IP addresses or DNS names (DNS is supported as of version 1.1.11) to the `Relay Servers`. **Port is not required, `21117` port is used explicitly.**
image Add a Geo Override but adding the server IP address and the coordinates where the server is located.
@@ -143,4 +142,3 @@ You can also confirm the relay requests directly on your hbbr instances, simply INFO [src/relay_server.rs:436] Relayrequest 0593e64e-4fe8-4a59-a94f-b3420ab043eb from [::ffff:100.100.123.233]:52038 got paired INFO [src/relay_server.rs:442] Both are raw ``` -