diff --git a/content/dev/build/all/_index.en.md b/content/dev/build/all/_index.en.md index dc22c8b..d333ac5 100644 --- a/content/dev/build/all/_index.en.md +++ b/content/dev/build/all/_index.en.md @@ -1,5 +1,5 @@ --- -title: All with Github Actions +title: All with GitHub Actions weight: 35 --- @@ -16,7 +16,7 @@ Goto 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 goto "Settings -> Secrets and variables -> Actions". @@ -39,7 +39,7 @@ Once workflows are enabled you can goto “Actions”. On the left, select "Flutter Nightly Build". Then on the right, click "Enable workflow". -Finally you can click "Run workflow" to build the rustdesk clients for all of the supported platforms. +Finally you can click "Run workflow" to build the RustDesk clients for all of the supported platforms. ## Enable upload permissions for workflows diff --git a/content/dev/build/linux/_index.en.md b/content/dev/build/linux/_index.en.md index c0f9920..1c1b943 100644 --- a/content/dev/build/linux/_index.en.md +++ b/content/dev/build/linux/_index.en.md @@ -9,7 +9,7 @@ Desktop versions use [sciter](https://sciter.com/) for GUI, please download scit [Windows](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.win/x64/sciter.dll) | [Linux](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.lnx/x64/libsciter-gtk.so) | -[MacOS](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.osx/libsciter.dylib) +[macOS](https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.osx/libsciter.dylib) ## Raw steps to build @@ -18,7 +18,7 @@ Desktop versions use [sciter](https://sciter.com/) for GUI, please download scit - Install [vcpkg](https://github.com/microsoft/vcpkg), and set `VCPKG_ROOT` env variable correctly - Windows: vcpkg install libvpx:x64-windows-static libyuv:x64-windows-static opus:x64-windows-static aom:x64-windows-static - - Linux/MacOS: vcpkg install libvpx libyuv opus aom + - Linux/macOS: vcpkg install libvpx libyuv opus aom - run `cargo run` diff --git a/content/dev/build/web/_index.en.md b/content/dev/build/web/_index.en.md index 6211726..d584a6e 100644 --- a/content/dev/build/web/_index.en.md +++ b/content/dev/build/web/_index.en.md @@ -1,5 +1,5 @@ --- -title: Web +title: Web weight: 23 --- @@ -9,8 +9,8 @@ Run below on Linux or Mac (works on Windows too, however you may need to slightl ```sh git clone https://github.com/JelleBuning/rustdesk.git -cd rustdesk -git switch fix_build +cd rustdesk +git switch fix_build cd flutter/web/js # Install protoc first, see: https://google.github.io/proto-lens/installing-protoc.html @@ -40,7 +40,7 @@ flutter run -d chrome ## How to build release on Linux -If you want to host the webclient you should build a release before running it on a webserver. +If you want to host the web client you should build a release before running it on a web server. To do so follow the steps shown above except the `flutter run -d chrome` command. Continue with the following commands: ```sh @@ -50,9 +50,9 @@ cd build/web python -m http.server 8000 ``` -To configure the build on HTTPS we would recommend following the instructions from the following source: https://medium.com/flutter-community/how-to-host-flutter-using-nginx-a71bcb11d96 +To configure the build on HTTPS we would recommend following the instructions from the following [source](https://medium.com/flutter-community/how-to-host-flutter-using-nginx-a71bcb11d96). -> Currently, yuv converter and vp9 are the bottleneck +> Currently, yuv converter and vp9 are the bottleneck. ## How to build with Docker @@ -62,7 +62,7 @@ Run below on Linux or Mac: ```sh git clone https://github.com/JelleBuning/rustdesk.git -cd rustdesk +cd rustdesk git switch fix_build cd flutter/web/js @@ -85,13 +85,13 @@ yarn build # Install operating system and dependencies FROM ubuntu:20.04 -ENV DEBIAN_FRONTEND=noninteractive +ENV DEBIAN_FRONTEND=noninteractive -RUN apt-get update +RUN apt-get update RUN apt-get install -y curl git wget unzip libgconf-2-4 gdb libstdc++6 libglu1-mesa fonts-droid-fallback lib32stdc++6 python3 clang cmake ninja-build pkg-config libgtk-3-dev RUN apt-get clean -# Download Flutter SDK from Flutter Github repo +# Download Flutter SDK from Flutter GitHub repo RUN git clone https://github.com/flutter/flutter.git /usr/local/flutter # Set flutter environment path @@ -107,7 +107,7 @@ RUN flutter config --enable-web # Copy files to container and build RUN mkdir /app/ -# I was unable to build web app from dockerfile +# I was unable to build web app from dockerfile # So instead I built it locally and commented the "flutter build web" in this file COPY . /app/ WORKDIR /app/ @@ -159,7 +159,7 @@ docker run -p 5000:5000 rustdesk-web-client ### RustDesk Web Client using existing Docker image -If you do not want to build the docker image yourself, you can use the image I built and uploaded to [Docker Hub](https://hub.docker.com/r/keyurbhole/flutter_web_desk) +If you do not want to build the docker image yourself, you can use the image I built and uploaded to [Docker Hub](https://hub.docker.com/r/keyurbhole/flutter_web_desk). - Pull the image: diff --git a/content/manual/mac/_index.en.md b/content/manual/mac/_index.en.md index 39f53c2..49496ed 100755 --- a/content/manual/mac/_index.en.md +++ b/content/manual/mac/_index.en.md @@ -4,7 +4,6 @@ weight: 3 --- ### Installation ------- Open the .dmg file and drag `RustDesk` to `Applications` as below. @@ -18,30 +17,30 @@ Make sure you have quit all running RustDesk. Also make sure you quit the RustDe | Unlock to change | Click on "App Store and identified developers" | | ---- | ---- | -|![](/docs/en/manual/mac/images/allow2.png)|![](/docs/en/manual/mac/images/allow.png)| +| ![](/docs/en/manual/mac/images/allow2.png) | ![](/docs/en/manual/mac/images/allow.png) | -### Enable Permissions +### Enable permissions {{% notice note %}} -Due to MacOS security policy change, our api which captures input on local side does not work any +Due to macOS security policy change, our api which captures input on local side does not work any 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) +[https://github.com/rustdesk/rustdesk/issues/974#issuecomment-1185644923](https://github.com/rustdesk/rustdesk/issues/974#issuecomment-1185644923). It seems no quick fix, we need to fix together with our Flutter version. {{% /notice %}} To capture screen, you need to grant `RustDesk` **accessibility** permission and **screen recording** permission. RustDesk will guide you to the settings window. -| RustDesk window | Settings Window | +| RustDesk window | Settings window | | ---- | ---- | -|![](/docs/en/manual/mac/images/acc.png)|![](/docs/en/manual/mac/images/acc3.png?v2)| +| ![](/docs/en/manual/mac/images/acc.png) | ![](/docs/en/manual/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`. | `-` and `+` button | Select RustDesk | | ---- | ---- | -|![](/docs/en/manual/mac/images/acc2.png)|![](/docs/en/manual/mac/images/add.png?v2)| +| ![](/docs/en/manual/mac/images/acc2.png) | ![](/docs/en/manual/mac/images/add.png?v2) | Please copy above steps for **screen recording** permission. diff --git a/content/self-host/install/_index.en.md b/content/self-host/install/_index.en.md index e5eae3d..434a8e9 100644 --- a/content/self-host/install/_index.en.md +++ b/content/self-host/install/_index.en.md @@ -4,12 +4,12 @@ weight: 10 --- ## Install your own server using a simple to run install script -Script is hosted on https://github.com/techahold/rustdeskinstall and supported on our [Discord](https://discord.com/invite/nDceKgxnkV). +Script is hosted on [Techahold](https://github.com/techahold/rustdeskinstall) and supported on our [Discord](https://discord.com/invite/nDceKgxnkV). Currently the script will download and setup the Relay and Signal Servers (hbbr and hbbs), generate configs and host them on a password protected web page for simple deployment to clients. ### Requirements -You need to have linux installed, script is tested working with CentOS Linux 7/8, Ubuntu 18/20 and Debian. A server with 1 CPU, 1 GB and 10 GB disk is plenty to run RustDesk. +You need to have Linux installed, script is tested working with CentOS Linux 7/8, Ubuntu 18/20 and Debian. A server with 1 CPU, 1 GB and 10 GB disk is plenty to run RustDesk. #### How to Install the server Please setup your firewall on your server prior to running the script. @@ -19,7 +19,7 @@ Make sure you have got access via ssh or otherwise setup prior setting up the fi ufw allow proto tcp from YOURIP to any port 22 ``` -#### If you have UFW installed use the following commands to configure the firewall (port 8000 only needed if you want to use the auto generated install files) : +#### If you have UFW installed use the following commands to configure the firewall (port 8000 only needed if you want to use the auto generated install files): ``` ufw allow 21115:21119/tcp ufw allow 8000/tcp @@ -33,7 +33,7 @@ wget https://raw.githubusercontent.com/techahold/rustdeskinstall/master/install. chmod +x install.sh ./install.sh ``` -There is also an update script on [Techahold's](https://github.com/techahold/rustdeskinstall) Repo. +There is also an update script on [Techahold's](https://github.com/techahold/rustdeskinstall) repository. ## Install your own server with docker(-compose) @@ -59,8 +59,8 @@ If `--net=host` works fine, the `-p` options are not used. If on Windows, leave 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. +### 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' @@ -100,10 +100,9 @@ services: restart: unless-stopped ``` - ## Set up your own server instance without using Docker -### STEP 1 : Download server-side software programs +### STEP 1: Download server-side software programs [Download](https://github.com/rustdesk/rustdesk-server/). @@ -125,7 +124,7 @@ They are built on CentOS Linux 7, tested on CentOS Linux 7/8 and Ubuntu 18/20. The hardware requirements are very low; the minimum configuration of a basic cloud server is enough, and the CPU and memory requirements are minimal. You can also use a Raspberry Pi or something similar. 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 your server +### STEP 2: Run hbbs and hbbr on your server We suggest you use [pm2](https://pm2.keymetrics.io/) for managing your service. @@ -159,7 +158,7 @@ By default, `hbbs` listens on 21115 (TCP) and 21116 (TCP/UDP), 21118 (TCP), and Please run with the `-h` option to see help if you want to choose your own port. -### STEP 3 : Set hbbs/hbbr address on client-side +### STEP 3: Set hbbs/hbbr address on client-side Click on the Menu button [ ⋮ ] on the right side of ID as shown below, and choose "ID/Relay Server". @@ -198,7 +197,7 @@ repeat this process until you get valid characters. | Menu | About Page | | -- | -- | -![](/docs/en/self-host/install/images/aboutmenu.png) | ![](/docs/en/self-host/install/images/lic.png) | +| ![](/docs/en/self-host/install/images/aboutmenu.png) | ![](/docs/en/self-host/install/images/lic.png) | ## Key @@ -220,7 +219,7 @@ If you want to prohibit users without the key from establishing non-encrypted co If you want to change the key, remove the `id_ed25519` and `id_ed25519.pub` files and restart `hbbs`/`hbbr`，`hbbs` will generate a new key pair. {{% notice note %}} -If you are using docker-compose and keys don't exist, the start of containers will create differents keys in hbbs and hbbr folders. +If you are using docker-compose and keys don't exist, the start of containers will create different keys in hbbs and hbbr folders. You could create keys manually in hbbs and copy them to hbbr before starting the containers. diff --git a/content/self-host/pro/_index.en.md b/content/self-host/pro/_index.en.md index 12baa10..58129c4 100644 --- a/content/self-host/pro/_index.en.md +++ b/content/self-host/pro/_index.en.md @@ -5,17 +5,17 @@ weight: 100 Self-host Pro is built on the open source version, but with more features. -- OIDC, ldap, 2FA (email verification) +- OIDC, LDAP, 2FA (email verification) - Address book -- Rename +- Rename - Log management -- Device managment +- Device management - Settings sync - Permission control - Multiple relay servers (automatically selects your closest relay) {{% notice note %}} -RustDesk client >=1.2.0 required +RustDesk client >= 1.2.0 required {{% /notice %}} ## Download @@ -26,13 +26,14 @@ RustDesk client >=1.2.0 required ### Simple Install -To make life easy, we have developed scripts which take care of everything (install/upgrade/convert from opensource) [Simple Install Script](https://rustdesk.com/docs/en/self-host/pro/installscript/) +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 @@ -40,4 +41,4 @@ Almost as the same as [the open source version](/docs/en/self-host/install/), bu ### 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. +One more TCP port `21114` is added for web console, please also add this port when you set firewall rules and docker port mapping. diff --git a/content/self-host/pro/console/_index.en.md b/content/self-host/pro/console/_index.en.md index e8078c4..aa7db99 100644 --- a/content/self-host/pro/console/_index.en.md +++ b/content/self-host/pro/console/_index.en.md @@ -12,16 +12,18 @@ Features: - Manage client settings sync strategies ## Log in + As mentioned earlier, the default port of the web console is 21114. Enter `http://: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): ![](/docs/en/self-host/pro/console/images/console-login.png) 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 admininistator account and delete this one. You'd better enable email login verification. +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. ![](/docs/en/self-host/pro/console/images/console-home.png?v2) -Non-administartor users can also login to browser their device and logs, change their user settings. +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`**。 + +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`**。 \ No newline at end of file diff --git a/content/self-host/pro/installscript/_index.en.md b/content/self-host/pro/installscript/_index.en.md index 7c91cc5..996203f 100644 --- a/content/self-host/pro/installscript/_index.en.md +++ b/content/self-host/pro/installscript/_index.en.md @@ -4,18 +4,19 @@ weight: 10 --- {{% notice note %}} -Don't forget to get your license from https://rustdesk.com/pricing.html, check [license](/docs/en/self-host/pro/license) page for more details. +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 %}} ## Install -Copy and paste the above command into your linux terminal to install RustDesk Server Pro. + +Copy and paste the above command into your Linux terminal to install RustDesk Server Pro. `bash <(wget -qO- https://raw.githubusercontent.com/rustdesk/rustdesk-server-pro/main/install.sh)` What it does: - Install some dependencies -- Setup ufw firewall if available +- Setup UFW firewall if available - Create a Folders /var/lib/rustdesk-server and /var/log/rustdesk-server - Installs executables into /usr/bin - Download and extract RustDesk Pro Services to the above folder @@ -23,18 +24,19 @@ What it does: - If you chose Domain, it will install Nginx and certbot, allowing the API to be available on port 443 (https) and get an SSL certificate over port 80, this will autorenew ## Upgrade -Copy and paste the above command into your linux terminal to upgrade your existing RustDesk Server Pro Installation, this could also be saved locally and scheduled with cron. + +Copy and paste the above command into your Linux terminal to upgrade your existing RustDesk Server Pro Installation, this could also be saved locally and scheduled with cron. `bash <(wget -qO- https://raw.githubusercontent.com/rustdesk/rustdesk-server-pro/main/update.sh)` What it does: -- Checks for new versions of RustDesk-Server-Pro +- Checks for new versions of RustDesk Server Pro - If it finds a new version, it removes the API files and downloads new executables and API files -## Convert from Opensource +## Convert from open source -Copy and paste the above command into your linux terminal to convert from RustDesk Server to RustDesk Server Pro. +Copy and paste the above command into your Linux terminal to convert from RustDesk Server to RustDesk Server Pro. `bash <(wget -qO- https://raw.githubusercontent.com/rustdesk/rustdesk-server-pro/main/convertfromos.sh)` @@ -42,7 +44,7 @@ What it does: - Disable and removes the old services - Install some dependencies -- Setup ufw firewall if available +- Setup UFW firewall if available - Create a Folder /var/lib/rustdesk-server and copy the certs here - Delete /var/log/rustdesk and create /var/log/rustdesk-server - Download and extract RustDesk Pro Services to the above folder diff --git a/content/self-host/pro/license/_index.en.md b/content/self-host/pro/license/_index.en.md index 4a860d1..f83f595 100644 --- a/content/self-host/pro/license/_index.en.md +++ b/content/self-host/pro/license/_index.en.md @@ -4,18 +4,21 @@ weight: 15 --- ## Buy license -Please get your license from https://rustdesk.com/pricing.html, enter a valid email address in the Stripe checkout page. The license will be sent to your email once payment is done successfully. + +Please get your license from [https://rustdesk.com/pricing.html](https://rustdesk.com/pricing.html), enter a valid email address in the Stripe checkout page. The license will be sent to your email once payment is done successfully. ![](/docs/en/self-host/pro/license/images/stripe.jpg) ## Set license + You will be required to enter license in the web console, or change license later. | Set license | Change license | | -- | -- | - ![](/docs/en/self-host/pro/license/images/set.png) | ![](/docs/en/self-host/pro/license/images/change.png) | + | ![](/docs/en/self-host/pro/license/images/set.png) | ![](/docs/en/self-host/pro/license/images/change.png) | ## Invoices and Migration + The license can be only used on one machine (for hbbs only, hbbr does not require license), if you want to migrate to the other machine, or download invoices, please go to [https://rustdesk.com/self-host/account/](https://rustdesk.com/self-host/account/). Log in with the email address used for Stripe checkout, unbind the old machine you want to migrate from as below, when you set the license in the new servers web console it will assign the license and register automatically in the console. ![](/docs/en/self-host/pro/license/images/unbind.jpg)