Merge pull request #317 from Mr-Update/patch-9

Small corrections
This commit is contained in:
RustDesk 2023-10-11 11:51:54 +08:00 committed by GitHub
commit c4aaa990a2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 88 additions and 87 deletions

View File

@ -3,7 +3,7 @@ title: Technical Support
weight: 16
---
## Community Support
### Community Support
Free Support: Available through [Github Discussions](https://github.com/rustdesk/rustdesk/discussions) and [Discord](https://discord.gg/nDceKgxnkV).
@ -11,7 +11,7 @@ We can help you install RustDesk using supported methods as documented here.
We may give pointers, or provide additional troubleshooting steps if we believe your issue may be related to a recent update or bug.
## Commercial Support
### Commercial Support
Paid Support: You can [email](mailto:support@rustdesk.com) to get started.
@ -19,7 +19,7 @@ We can help with lots of problems, installations and configurations. Fully manag
You get Priority #1 fast responses and service.
## SSH Access
### SSH Access
To provide SSH access to your server for troubleshooting, please add the following key to `~/username/.ssh/authorized_keys` and ensure the file has permissions `600`.
You may refer to this [tutorial](https://www.digitalocean.com/community/tutorials/how-to-configure-ssh-key-based-authentication-on-a-linux-server) for reference.

View File

@ -68,9 +68,8 @@ sudo zypper install --allow-unsigned-rpm ./rustdesk-<version>-suse.rpm
#### Android
Install apk from our GitHub more info can be found on the [Android page](/docs/en/client/android/).
#### iOS (iPhone,iPad)
Donwload from the app store
https://apps.apple.com/us/app/rustdesk-remote-desktop/id1581225015
#### iOS (iPhone, iPad)
Download the app from the [App Store](https://apps.apple.com/us/app/rustdesk-remote-desktop/id1581225015).
### Usage
Once installed (or run as a temporary executable) RustDesk will connect to the Public servers. You will see a message at the bottom saying (1) "Ready, For faster connection, please set up your own server". In the Top left you will see your (2) ID, (3) One Time Password and on the Right a (4) box for you to connect to another computer if you know their ID.

View File

@ -76,7 +76,7 @@ Starting from version 1.1.9, the Android client has added the functions of shari
- Android 10 or above is required to share the internal audio of the mobile phone system
- iOS does not yet support screen sharing
#### **Request permissions and start services**
#### Request permissions and start services
Click on `Share Screen` from the bottom navigation bar.
@ -95,13 +95,13 @@ Configure various permissions as needed. Every time you start RustDesk, you need
Above * represents special permissions. To obtain such permissions, you need to jump to the Android system settings page to obtain them manually. The details are as follows
{{% /notice %}}
#### **Special Permission Request - File**
#### Special Permission Request - File
| Requesting Android file permissions will automatically jump to the system settings page |
| :---: |
| ![](/docs/en/client/android/images/get_file_en.jpg?width=300px) |
#### **Special Permission Request - mouse input**
#### Special Permission Request - mouse input
| Step 1: Find "Installed Services" | Step 2: Start RustDesk Input |
| --- | --- |
| ![](/docs/en/client/android/images/get_input1_en.jpg?width=300px) | ![](/docs/en/client/android/images/get_input2_en.jpg?width=300px) |
@ -110,14 +110,14 @@ Above * represents special permissions. To obtain such permissions, you need to
The system setting page of different vendors may be different, please adjust it according to your system page.
{{% /notice %}}
**Remote mouse control shortcuts:**
| Remote mouse control shortcuts | Description |
| --- | --- |
| Click the right mouse button | Go back |
| Click the mouse wheel | Home |
| Long press mouse wheel | Recently opened apps |
| Mouse wheel scrolling | Simulate vertical sliding |
- Click the right mouse button: go back
- Click the mouse wheel: Home
- Long press mouse wheel: recently opened apps
- Mouse wheel scrolling: simulate vertical sliding
#### **Start Service**
#### Start Service
After obtaining the `Screen Capture` permission, the service will be automatically started. You can also click the `Start Service` button to start the service. After the service is started, it can accept desktop control requests from other devices.

View File

@ -7,7 +7,7 @@ weight: 4
#### Ubuntu (>= 16)
```bash
```sh
# please ignore the wrong disk usage report
sudo apt install -fy ./rustdesk-<version>.deb
```
@ -50,5 +50,5 @@ Modify below line to `WaylandEnable=false` in `/etc/gdm/custom.conf` or `/etc/gd
```
{{% notice note %}}
Please **reboot** to make above changes taking effect
Please **reboot** to make above changes taking effect.
{{% /notice %}}

View File

@ -7,11 +7,11 @@ weight: 35
This build uses GitHub Actions, you will need a GitHub account, also building can be slow, however this requires no development environment.
{{% /notice %}}
## Make a fork
### Make a fork
Go to https://github.com/rustdesk/rustdesk/fork and click "Create fork".
## Set your environment variables (optional)
### Set your environment variables (optional)
{{% notice note %}}
You only need to do this if you want to change the default server and public key.
@ -29,7 +29,7 @@ Click "New repository secret", for the name put RS_PUB_KEY, for the secret put y
Click "Add secret".
## Enable workflows
### Enable workflows
On your fork you just created go to "Settings -> Actions -> General".
@ -41,13 +41,13 @@ On the left, select "Flutter Nightly Build". Then on the right, click "Enable wo
Finally you can click "Run workflow" to build the RustDesk Clients for all of the supported platforms.
## Enable upload permissions for workflows
### Enable upload permissions for workflows
On your fork you just created go to "Settings -> Actions -> General".
Scroll down and under Workflow permissions enable "Read and write permissions".
## Download your built packages
### Download your built packages
After the workflow is done running you can download the packages it built.

View File

@ -3,9 +3,8 @@ title: Docker
weight: 30
---
## How to build with Docker
### This won't work on Windows
### How to build with Docker
#### This won't work on Windows
Begin by cloning the repository and building the Docker container:

View File

@ -3,9 +3,9 @@ title: FAQ for Windows
weight: 40
---
## vcpkg download package failed
### vcpkg download package failed
### Error
#### Error
```
-- Fetching https://chromium.googlesource.com/libyuv/libyuv 287158925b0e03ea4499a18b4e08478c5781541b...
@ -13,15 +13,15 @@ weight: 40
Command failed: D:/program/Git/mingw64/bin/git.exe fetch https://chromium.googlesource.com/libyuv/libyuv 287158925b0e03ea4499a18b4e08478c5781541b --depth 1 -n
```
### Solution
#### Solution
Use a browser to download `https://chromium.googlesource.com/libyuv/libyuv/+archive/287158925b0e03ea4499a18b4e08478c5781541b.tar.gz`, then move it into `vcpkg/downloads` and reinstall.
Use a browser to download [libyuv-287158925b0e03ea4499a18b4e08478c5781541b.tar.gz](https://chromium.googlesource.com/libyuv/libyuv/+archive/287158925b0e03ea4499a18b4e08478c5781541b.tar.gz), then move it into `vcpkg/downloads` and reinstall.
## Package in Cargo.lock not exist
### Package in Cargo.lock not exist
### Error
#### Error
```
$ cargo run
@ -42,34 +42,34 @@ $ cargo run
Maybe the author used `git force push` and the previous commit was overwritten.
### Solution
#### Solution
`cargo update`, force the package to be updated.
## VCPKG_ROOT not set
### VCPKG_ROOT not set
### Error
#### Error
```
thread 'main' panicked at 'Failed to find package: VcpkgNotFound("No vcpkg installation found. Set the VCPKG_ROOT environment variable or run 'vcpkg integrate install'")', libs\scrap\build.rs:7:45
```
### Solution
#### Solution
Add `VCPKG_ROOT` environment variable, or run with `VCPKG_ROOT=<vcpkg_dir> cargo run`.
## clang not installed, or LIBCLANG_PATH not set
### clang not installed, or LIBCLANG_PATH not set
### Error
#### Error
```
thread 'main' panicked at 'Unable to find libclang: "couldn't find any valid shared libraries matching: ['clang.dll', 'libclang.dll'], set the `LIBCLANG_PATH` environment variable to a path where one of these files can be found (invalid: [])"', C:\Users\selfd\.cargo\registry\src\mirrors.ustc.edu.cn-61ef6e0cd06fb9b8\bindgen-0.59.2\src/lib.rs:2144:31
```
### Solution
#### Solution
Install [LLVM](https://releases.llvm.org/download.html), add the `LIBCLANG_PATH` environment variable as `llvm_install_dir/bin`.

View File

@ -3,7 +3,7 @@ title: Web
weight: 23
---
## How to build on Linux
### How to build on Linux
Run below on Linux or Mac (works on Windows too, however you may need to slightly modify some commands, e.g. change `wget` to `curl.exe -O`):
@ -38,7 +38,7 @@ cd ..
flutter run -d chrome
```
## How to build release on Linux
### How to build release on Linux
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:
@ -54,7 +54,7 @@ To configure the build on HTTPS we would recommend following the instructions fr
> Currently, YUV converter and VP9 are the bottleneck.
## How to build with Docker
### How to build with Docker
Run below on Linux or Mac:
- Begin by installing flutter for [Linux](https://docs.flutter.dev/get-started/install/linux#install-flutter-manually) or [macOS](https://docs.flutter.dev/get-started/install/macos).
@ -132,7 +132,7 @@ ENTRYPOINT [ "/app/server/server.sh"]
PORT=5000
# Stop any program currently running on the set port
echo 'preparing port' $PORT '...'
echo 'Preparing port' $PORT '...'
fuser -k 5000/tcp
# Switch directory

View File

@ -3,7 +3,7 @@ title: Hardcoding Custom Settings
weight: 49
---
## Custom Server
### Custom Server
{{% notice note %}}
To hardcode custom server settings into your executables you must [build](/docs/en/dev/build/) the client yourself on your machine or [with GitHub Actions](/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.

View File

@ -35,13 +35,13 @@ if (-Not ([Security.Principal.WindowsPrincipal][Security.Principal.WindowsIdenti
$rdver = ((Get-ItemProperty "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\RustDesk\").Version)
if($rdver -eq "1.2.2")
if ($rdver -eq "1.2.2")
{
Write-Output "RustDesk $rdver is the newest version"
Exit
}
If (!(Test-Path C:\Temp))
if (!(Test-Path C:\Temp))
{
New-Item -ItemType Directory -Force -Path C:\Temp > null
}
@ -70,11 +70,11 @@ while ($arrService.Status -ne 'Running')
}
cd $env:ProgramFiles\RustDesk\
.\RustDesk.exe --get-id | Write-Output -OutVariable rustdesk_id
.\rustdesk.exe --get-id | Write-Output -OutVariable rustdesk_id
.\RustDesk.exe --config $rustdesk_cfg
.\rustdesk.exe --config $rustdesk_cfg
.\RustDesk.exe --password $rustdesk_pw
.\rustdesk.exe --password $rustdesk_pw
Write-Output "..............................................."
# Show the value of the ID Variable
@ -95,8 +95,9 @@ setlocal ENABLEEXTENSIONS ENABLEDELAYEDEXPANSION
set alfanum=ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789
set rustdesk_pw=
FOR /L %%b IN (1, 1, 12) DO (
SET /A rnd_num=!RANDOM! %% 62
for /L %%b in (1, 1, 12) do
(
set /A rnd_num=!RANDOM! %% 62
for %%c in (!rnd_num!) do set rustdesk_pw=!rustdesk_pw!!alfanum:~%%c,1!
)
@ -117,11 +118,11 @@ cd "C:\Program Files\RustDesk\"
rustdesk.exe --install-service
timeout /t 20
for /f "delims=" %%i IN ('rustdesk.exe --get-id ^| more') DO set rustdesk_id=%%i
for /f "delims=" %%i in ('rustdesk.exe --get-id ^| more') do set rustdesk_id=%%i
RustDesk.exe --config %rustdesk_cfg%
rustdesk.exe --config %rustdesk_cfg%
RustDesk.exe --password %rustdesk_pw%
rustdesk.exe --password %rustdesk_pw%
echo ...............................................
REM Show the value of the ID Variable

View File

@ -3,7 +3,7 @@ title: Tactical RMM
weight: 100
---
## To Use Tactical RMM with RustDesk, you must do the following
### To Use Tactical RMM with RustDesk, you must do the following
1. Install your own Tactical RMM Server, following their [official docs](https://docs.tacticalrmm.com/) and open ports.
2. Create the following scripts (all are PowerShell).
@ -11,7 +11,8 @@ weight: 100
4. Create [custom fields](https://docs.tacticalrmm.com/functions/custom_fields/) for the RustDesk ID and password.
5. Create [collector tasks](https://docs.tacticalrmm.com/functions/automated_tasks/#collector-tasks).
## Install Script Replace IPADDRESS and KEY
### Install Script Replace IPADDRESS and KEY
```ps
$ErrorActionPreference= 'silentlycontinue'
@ -52,16 +53,16 @@ Set-Content C:\Windows\ServiceProfiles\LocalService\AppData\Roaming\RustDesk\con
net start rustdesk
```
## RustDesk Get ID (Collector Script needs Custom Agent Field)
### RustDesk Get ID (Collector Script needs Custom Agent Field)
```ps
$ErrorActionPreference= 'silentlycontinue'
cd $env:ProgramFiles\RustDesk\
.\RustDesk.exe --get-id | out-host
.\rustdesk.exe --get-id | out-host
```
## Create Script to be used as a Check
### Create Script to be used as a Check
```ps
$ErrorActionPreference= 'silentlycontinue'
@ -80,7 +81,8 @@ else
}
```
## RustDesk Set and Get Password (Collector Script needs Custom Agent Field) to run on Check Failure
### RustDesk Set and Get Password (Collector Script needs Custom Agent Field) to run on Check Failure
```ps
$ErrorActionPreference= 'silentlycontinue'
@ -90,11 +92,11 @@ net stop rustdesk > null
$ProcessActive = Get-Process rustdesk -ErrorAction SilentlyContinue
if($ProcessActive -ne $null)
{
stop-process -ProcessName rustdesk -Force
Stop-Process -ProcessName rustdesk -Force
}
$rustdesk_pw = (-join ((65..90) + (97..122) | Get-Random -Count 12 | % {[char]$_}))
Start-Process "$env:ProgramFiles\RustDesk\RustDesk.exe" "--password $rustdesk_pw" -wait
Start-Process "$env:ProgramFiles\RustDesk\rustdesk.exe" "--password $rustdesk_pw" -wait
Write-Output $rustdesk_pw
net start rustdesk > null
@ -102,11 +104,11 @@ net start rustdesk > null
New-Item $confirmation_file > null
```
## RustDesk URL Action
### RustDesk URL Action
```
rustdesk://connection/new/{{agent.rustdeskid}}?password={{agent.rustdeskpwd}}
```
## Add Custom Agent Fields
### Add Custom Agent Fields
`rustdeskid Type = Text` </br>
`rustdeskpwd Type = Text`

View File

@ -3,7 +3,7 @@ title: FAQ
weight: 600
---
## How can I install with the Simple Install Script?
### How can I install with the Simple Install Script?
1. Get your license from [https://rustdesk.com/pricing.html](https://rustdesk.com/pricing.html), check [license](/docs/en/self-host/rustdesk-server-pro/license) page for more details.
2. Spin up a VPS, bare metal or Linux VM.
3. If you want to use DNS and SSL create a DNS name i.e. `rustdesk.yourdomain.com`.
@ -14,7 +14,7 @@ weight: 600
8. Log in with the username `admin` and password `test1234`.
9. Enter your license code purchased in step 1.
## How can I convert from RustDesk Server Open Source to RustDesk Server Pro?
### How can I convert from RustDesk Server Open Source to RustDesk Server Pro?
1. Get your license from [https://rustdesk.com/pricing.html](https://rustdesk.com/pricing.html), check [license](/docs/en/self-host/rustdesk-server-pro/license) page for more details.
2. Open TCP port 21114.
3. Log into your RustDesk Server.
@ -26,60 +26,60 @@ weight: 600
9. Log in with the username `admin` and password `test1234`.
10. Enter your license code purchased in step 1.
## There is a new version of RustDesk Server Pro out, how can I upgrade?
### There is a new version of RustDesk Server Pro out, how can I upgrade?
1. Go to [this page](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/installscript/#upgrade).
2. Copy and paste the command into your Linux terminal.
3. Follow the prompts as they guide you through the upgrade.
## I installed with the script, how can I start and stop services?
### I installed with the script, how can I start and stop services?
The services use systemd so can be started and stopped using `sudo systemctl stop|start|restart rustdesk-hbbs|rustdesk-hbbr` e.g. `sudo systemctl restart rustdesk-hbbs`.
## I installed with the script, how can I view the Linux logs?
### I installed with the script, how can I view the Linux logs?
The logs are stored in /var/log/rustdesk-server, you can view them using `tail /var/log/rustdesk-server/hbbs.log` or `tail /var/log/rustdesk-server/hbbs.error`.
## I installed with the script, how can I check the status of the RustDesk services?
### I installed with the script, how can I check the status of the RustDesk services?
To check the status `sudo systemctl status rustdesk-hbbs|rustdesk-hbbr` e.g. `sudo systemctl status rustdesk-hbbs`.
## How can I change the admin password?
### 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`.
3. Click on `admin` in the top right hand corner.
4. Click on `Settings`.
5. Enter your new password in the boxes provided.
## How can I move my license to a new server?
### How can I move my license to a new server?
Please see [here](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/#invoices-and-migration).
## Emails aren't working from my VPS
### Emails aren't working from my VPS
A lot of VPS providers block ports 465 and 25.
A simple way to check is using telnet. To test in the Linux terminal type `telnet your.mailserver.com 25`. On Windows use PowerShell with `Test-NetConnection -ComputerName your.mailserver.com -Port 25`.
Your mail server may not be using port 25. Please make sure you are using the correct ports.
## Can I deploy RustDesk using PowerShell or similar?
### Can I deploy RustDesk using PowerShell or similar?
Sure, you can find scripts to aid deployment [here](https://rustdesk.com/docs/en/self-host/client-deployment/).
## I have installed RustDesk Server Pro manually but the API web console isn't behind SSL, how can I secure this?
### I have installed RustDesk Server Pro manually but the API web console isn't behind SSL, how can I secure this?
Use a proxy like Nginx, the simple install script has one, it's really simple. [This is how we do it](https://github.com/rustdesk/rustdesk-server-pro/blob/493ad90daf8815c3052ff4d0d4aa9cc07e411efa/install.sh#L252).
Similar configs should work with Traefik v2, HAProxy, Apache Proxy and Cloudflare Tunnel.
## How can I file a bug report?
### How can I file a bug report?
Please file via [GitHub](https://github.com/rustdesk/rustdesk-server-pro/issues).
## Why if I am self hosting is this not free and open source?
### Why if I am self hosting is this not free and open source?
1. RustDesk has become a full time job for a number of people, they have lives, wives, jobs and kids which all demands attention and costs money!
2. We want to be here and still making great progress in years to come.
3. The open source version will continue to be open source and we encourage others to make developments in line with the AGPL license.
## I can't connect to devices in different groups, why is this?
### I can't connect to devices in different groups, why is this?
This is easily sorted, you need to allow cross-group access.
1. Add new groups.
2. Click `Edit`.
3. Select the relevant groups you want access (it automatically adds them in the corresponding group).
## How can I get configs automatically?
### How can I get configs automatically?
Configs are generated automatically.
1. Download the newest clients from [GitHub](https://github.com/rustdesk/rustdesk/releases/latest).
2. On the main page in the web console click on `Windows EXE`.
@ -87,17 +87,17 @@ Configs are generated automatically.
4. Click `Submit`.
5. Scan QR Code on Android and rename exe to what has been generated.
## Do you offer hosting for RustDesk Server Pro?
### Do you offer hosting for RustDesk Server Pro?
Please get in touch with our [sales](mailto://sales@rustdesk.com) team.
## Is there somewhere I can see video setup guides?
### 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?
### 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`.
## How can I uninstall RustDesk Server Pro?
### How can I uninstall RustDesk Server Pro?
Run the following commands:
```sh
sudo systemctl stop rustdesk-hbbs.service
@ -117,10 +117,10 @@ If the script installed Nginx then remove using:
sudo apt remove nginx
```
## How can I remove devices from the device list in the web console?
### How can I remove devices from the device list in the web console?
Disable and then delete will now be available.
## How can I update RustDesk with PowerShell?
### How can I update RustDesk with PowerShell?
```ps
$ErrorActionPreference= 'silentlycontinue'
@ -128,8 +128,8 @@ $rdver = ((Get-ItemProperty "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Un
if ($rdver -eq "1.2.2")
{
write-output "RustDesk $rdver is the newest version."
exit
Write-Output "RustDesk $rdver is the newest version."
Exit
}
if (!(Test-Path C:\Temp))