mirror of
https://github.com/rustdesk/doc.rustdesk.com.git
synced 2024-11-07 17:04:32 +01:00
Updated grammar and markdown syntax; fixed bug in control-mobile
This commit is contained in:
Luke Barone
parent
a670ac8bea
commit
7fda5f2d33
@ -72,11 +72,12 @@ After the service is started, a unique ID and random password will be automatica
|
||||
3. Except for the `screen capture` permission, the switching of other permissions will only affect the new connection, and will not affect the established connection. If you need to switch permissions for an established connection, please close the current connection first, modify the permissions, and then receive a control request.
|
||||
{{% /notice %}}
|
||||
|
||||
**PC:**
|
||||
##### PC
|
||||
|
||||
|
||||
|
||||
**Mobile terminal:**
|
||||
##### Mobile terminal
|
||||
|
||||
| You can stop the service or close the specified connection at any time | You can receive or initiate chats |
|
||||
| --------------- | -------------------------------------------------------- |
|
||||
|  |  |
|
||||
@ -4,43 +4,47 @@ weight: 4
|
||||
---
|
||||
|
||||
### Installation
|
||||
------
|
||||
|
||||
- Ubuntu (>= 16)
|
||||
```
|
||||
#### Ubuntu (>= 16)
|
||||
|
||||
```bash
|
||||
# please ignore the wrong disk usage report
|
||||
sudo apt install -fy ./rustdesk-<version>.deb
|
||||
```
|
||||
|
||||
- CentOS/Fedora (>=18)
|
||||
```
|
||||
#### CentOS/Fedora (>=18)
|
||||
|
||||
```sh
|
||||
sudo yum localinstall ./rustdesk-<version>.rpm
|
||||
```
|
||||
|
||||
- Arch/Manjaro
|
||||
```
|
||||
#### Arch/Manjaro
|
||||
|
||||
```sh
|
||||
sudo pacman -U ./rustdesk-<version>.pkg.tar.zst
|
||||
```
|
||||
|
||||
- Opensuse (>= Leap 15.0)
|
||||
```
|
||||
#### Opensuse (>= Leap 15.0)
|
||||
|
||||
```sh
|
||||
sudo zypper install --allow-unsigned-rpm ./rustdesk-<version>-suse.rpm
|
||||
```
|
||||
|
||||
### X11 Required
|
||||
RustDesk does not support wayland yet, you need switch to X11 manually.
|
||||
### X11 Required
|
||||
|
||||
RustDesk does not support wayland yet; you need switch to X11 manually.
|
||||
|
||||
#### Display Server
|
||||
Ubuntu: https://askubuntu.com/questions/1260142/ubuntu-set-default-login-desktop
|
||||
|
||||
Fedora: https://docs.fedoraproject.org/en-US/quick-docs/configuring-xorg-as-default-gnome-session/
|
||||
[Ubuntu](https://askubuntu.com/questions/1260142/ubuntu-set-default-login-desktop) |
|
||||
[Fedora](https://docs.fedoraproject.org/en-US/quick-docs/configuring-xorg-as-default-gnome-session/) |
|
||||
[Arch](https://bbs.archlinux.org/viewtopic.php?id=218319)
|
||||
|
||||
Arch: https://bbs.archlinux.org/viewtopic.php?id=218319
|
||||
#### Login Screen
|
||||
|
||||
##### Login Screen
|
||||
Modify below line to `WaylandEnable=false` in `/etc/gdm/custom.conf` or `/etc/gdm3/custom.conf`:
|
||||
|
||||
Modify below line to `WaylandEnable=false` in `/etc/gdm/custom.conf` or `/etc/gdm3/custom.conf`.
|
||||
```
|
||||
```ini
|
||||
#WaylandEnable=false
|
||||
```
|
||||
|
||||
|
||||
@ -3,20 +3,18 @@ title: Mobile
|
||||
weight: 1
|
||||
---
|
||||
|
||||
### Remote Control
|
||||
------
|
||||
### Remote Control
|
||||
|
||||
Enter the ID of remote device in the home page or select a historical device to verify.
|
||||
Enter the ID of the remote device in the home page or select a historical device to verify.
|
||||
After the verification is successful, you can control remote device.
|
||||
|
||||
| Home | Successfully connected |
|
||||
| --------------- | -------------------------------------------------------- |
|
||||
|  |  |
|
||||
|
||||
Input control provides two modes: `mouse mode` and `touch mode`, which can be switched through the lower toolbar.
|
||||
|
||||
Input control provides `mouse mode`/`touch mode` two modes, which can be switched through the lower toolbar.
|
||||
|
||||
| Enter | Mode selection |
|
||||
| Mouse settings | Mode selection |
|
||||
| --------------- | -------------------------------------------------------- |
|
||||
|  |  |
|
||||
|
||||
@ -25,44 +23,42 @@ In `mouse mode`,you can also trigger the remote device's `Right Mouse` with a `T
|
||||
{{% /notice %}}
|
||||
|
||||
### File Transfer (Android)
|
||||
------
|
||||
|
||||
require RustDesk 1.1.9+.
|
||||
> Requires RustDesk 1.1.9+
|
||||
|
||||
In the device list on the home page, select the device.
|
||||
|
||||
Long press or tap more options on the right to select `File Transfer`
|
||||
Long press or tap the menu on the right to select `File Transfer`
|
||||
|
||||
| Home | Successfully connected |
|
||||
| --------------- | -------------------------------------------------------- |
|
||||
|  |  |
|
||||
|
||||
|
||||
|
||||
- The initial directory is the Home directory of the device, you can click <i class="fas fa-home"></i> to quickly return to Home.
|
||||
- Below the title bar is the directory level, you can click the corresponding folder to jump quickly.
|
||||
- Click <i class="fas fa-arrow-up"></i> to access the parent directory.
|
||||
- The current absolute path and project statistics will be prompted at the bottom of the list.
|
||||
- Click `Local` / `Remote` in the title bar to switch pages.
|
||||
|
||||
#### How do I transfer files?
|
||||
|
||||
#### **How to transfer files?**
|
||||
1. **Long press** on a file or folder in the list to quickly enter the **multiple selection mode**, which can select multiple items.
|
||||
2. After selecting the file(s), switch the `local` / `remote` page. After switching, you will see the `Paste here?` prompt at the bottom of the screen.
|
||||
3. Click the paste file icon in the picture to transfer the selected item(s) to the target directory.
|
||||
|
||||
| Multi-Select Mode | File Paste |
|
||||
| --------------- | -------------------------------------------------------- |
|
||||
|  |  |
|
||||
|
||||
1. **Long press** on a file or folder in the list to quickly enter the **multiple selection mode**, which can delete multiple items or transfer files.
|
||||
2. After selecting the file, switch the `local` / `remote` page, after switching the page, you will see `Paste here? ` prompt, click the paste file icon in the picture to transfer the selected file/folder to the target directory.
|
||||
### Set ID/Relay Server
|
||||
|
||||
### **Set ID/Relay Server**
|
||||
------
|
||||
Click `Settings` on the bottom navigation bar, enter the settings page and click `ID/Relay Server`.
|
||||
After entering and submitting, it will automatically switch to the specified server.
|
||||
You can also configure by scanning [QR code](https://rustdesk.com/docs/en/self-host/console/images/console-home.png?v2).
|
||||
1. Click `Settings` on the bottom navigation bar.
|
||||
2. Click `ID/Relay Server`.
|
||||
3. Enter your ID Server hostname/IP Address in the `ID Server` field. Leave `Relay Server` and `API Server` blank, and enter your public key (optional, required for encryption) in the `Key` field. Press **OK** to save your settings. It will automatically switch to the specified server.
|
||||
|
||||
You can also configure it by scanning a QR code.
|
||||
The picture below is a screenshot of Android. If it is iOS, please check top-right menu on the home page.
|
||||
|
||||
|
||||
|
||||
|
||||
For details of self-host server, please refer to [self-host](/docs/en/self-host/)
|
||||
For details of self-host server, please refer to [self-host](/docs/en/self-host/)
|
||||
|
||||
@ -3,70 +3,73 @@ title: Installation
|
||||
weight: 10
|
||||
---
|
||||
|
||||
## Set up your own cloud by following simple steps
|
||||
-----------
|
||||
## Set up your own server instance by following these steps
|
||||
|
||||
### STEP-1 : Download server-side software programs
|
||||
|
||||
[Download](https://github.com/rustdesk/rustdesk-server/) or use docker [rustdesk/rustdesk-server](https://hub.docker.com/r/rustdesk/rustdesk-server/tags).
|
||||
|
||||
Platform versions provided:
|
||||
- Linux
|
||||
- Windows
|
||||
|
||||
Below tutorial is based on Linux build.
|
||||
- Linux
|
||||
- Windows
|
||||
|
||||
The tutorial below is based on Linux build.
|
||||
|
||||
There are two executables and a folder:
|
||||
- hbbs - RustDesk ID/Rendezvous server
|
||||
- hbbr - RustDesk relay server
|
||||
|
||||
They are built on Centos7, tested on Centos7/8, Ubuntu 18/20.
|
||||
- `hbbs` - RustDesk ID/Rendezvous server
|
||||
- `hbbr` - RustDesk relay server
|
||||
|
||||
They are built on Centos7, tested on Centos7/8 and Ubuntu 18/20.
|
||||
|
||||
#### Server Requirements
|
||||
The hardware requirements are very low, the minimum configuration of the cloud server is enough, and the CPU and memory requirements are the minimum. Regarding the network size, if the TCP hole punching direct connection fails, the relay traffic will be consumed. The traffic of a relay connection is between 30k-3M/s (1920x1080 screen), depending on the resolution settings and screen update。 If it is only for office work demand, the traffic is around 100K/s.
|
||||
|
||||
The hardware requirements are very low; the minimum configuration of a basic cloud server is enough, and the CPU and memory requirements are minimal. Regarding the network size, if the TCP hole punching direct connection fails, the relay traffic will be consumed. The traffic of a relay connection is between 30k-3M/s (1920x1080 screen), depending on the resolution settings and screen update。 If it is only for office work demand, the traffic is around 100K/s.
|
||||
|
||||
### STEP-2 : Run hbbs and hbbr on server
|
||||
|
||||
Run hbbs/hbbr on your server (Centos or Ubuntu). We suggust you use [pm2](https://pm2.keymetrics.io/) managing your service.
|
||||
|
||||
```
|
||||
```bash
|
||||
./hbbs -r <relay-server-ip[:port]>
|
||||
./hbbr
|
||||
```
|
||||
|
||||
or run hbbs/hbbr with pm2
|
||||
|
||||
```
|
||||
```bash
|
||||
pm2 start hbbs -- -r <relay-server-ip[:port]>
|
||||
pm2 start hbbr
|
||||
```
|
||||
|
||||
<a name="demo"></a>
|
||||
{{% notice note %}}
|
||||
pm2 requires nodejs v16+, if you fail to run pm2 (e.g. you can not see hbbs/hbbr in `pm2 list`), please download and install LTS version nodejs from https://nodejs.org. If you wanna make hbbs/hbbr auto-run after reboot, please check out `pm2 save` and `pm2 startup`. More about [pm2](https://pm2.keymetrics.io/docs/usage/quick-start/). Another good tool for you log is [pm2-logrotate](https://github.com/keymetrics/pm2-logrotate).
|
||||
pm2 requires nodejs v16+, if you fail to run pm2 (e.g. you can not see `hbbs`/`hbbr` in `pm2 list`), please download and install LTS version nodejs from https://nodejs.org. If you want to make `hbbs`/`hbbr` auto-run after reboot, please check out `pm2 save` and `pm2 startup`. More about [pm2](https://pm2.keymetrics.io/docs/usage/quick-start/). Another good tool for your logs is [pm2-logrotate](https://github.com/keymetrics/pm2-logrotate).
|
||||
|
||||
The `-r` parameter of hhbs is not mandatory, it is just convenient for you not to specify a relay server on the controlled client side, you do not need to specify port if you are using default 21117 port. The relay server specified by the client has a higher priority than this.
|
||||
The `-r` parameter of `hhbs` is not mandatory, it is just convenient for you not to specify a relay server on the controlled client side. You do not need to specify port if you are using default 21117 port. The relay server specified by the client has a higher priority than this.
|
||||
{{% /notice %}}
|
||||
|
||||
By default, hbbs listens on 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**. 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 client (21118, 21119) support, the corresponding ports can be disabled.
|
||||
By default, `hbbs` listens on 21115(tcp) and 21116(tcp/udp), 21118(tcp),and `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**. 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, and 21118 and 21119 are used to support web clients. If you do not need web client (21118, 21119) support, the corresponding ports can be disabled.
|
||||
|
||||
- TCP(**21115, 21116, 21117, 21118, 21119**)
|
||||
- UDP(**21116**)
|
||||
|
||||
Please run with "-h" option to see help if you wanna choose your own port.
|
||||
Please run with the `-h` option to see help if you want to choose your own port.
|
||||
|
||||
#### Docker example
|
||||
|
||||
##### Linux/amd64
|
||||
```
|
||||
|
||||
```bash
|
||||
sudo docker image pull rustdesk/rustdesk-server
|
||||
sudo docker run --name hbbs -p 21115:21115 -p 21116:21116 -p 21116:21116/udp -p 21118:21118 -v `pwd`:/root -it --net=host --rm rustdesk/rustdesk-server hbbs -r <relay-server-ip[:port]>
|
||||
sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -it --net=host --rm rustdesk/rustdesk-server hbbr
|
||||
```
|
||||
|
||||
##### Linux/arm64v8
|
||||
```
|
||||
|
||||
```bash
|
||||
sudo docker image pull rustdesk/rustdesk-server:latest-arm64v8
|
||||
sudo docker run --name hbbs -p 21115:21115 -p 21116:21116 -p 21116:21116/udp -p 21118:21118 -v `pwd`:/root -it --net=host --rm rustdesk/rustdesk-server:latest-arm64v8 hbbs -r <relay-server-ip[:port]>
|
||||
sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -it --net=host --rm rustdesk/rustdesk-server:latest-arm64v8 hbbr
|
||||
@ -75,30 +78,30 @@ sudo docker run --name hbbr -p 21117:21117 -p 21119:21119 -v `pwd`:/root -it --n
|
||||
<a name="net-host"></a>
|
||||
|
||||
{{% notice note %}}
|
||||
--net=host only works on Linux so far as I know, which make hbbs/hbbr can see the real incoming ip rather than container ip (172.17.0.1).
|
||||
If --net=host works fine, -p options are useless.
|
||||
`--net=host` only works on Linux, which makes `hbbs`/`hbbr` see the real incoming IP Address rather than the Container IP (172.17.0.1).
|
||||
If `--net=host` works fine, the `-p` options are not used.
|
||||
|
||||
**Please remove --net=host if see connection problem on your platform**
|
||||
**Please remove `--net=host` if see connection problem on your platform**
|
||||
{{% /notice %}}
|
||||
|
||||
|
||||
### STEP-3 : Set hbbs/hbbr address on client-side
|
||||
|
||||
Click on menu button on the right side of ID as below, choose "ID/Relay Server".
|
||||
Click on the Menu button on the right side of ID as shown below, and choose "ID/Relay Server".
|
||||
|
||||
|
||||
|
||||
Enter the hbbs host or ip address in the ID server input box (local side + remote side), the other two addresses can be left blank, RustDesk will automatically deduce (if not specially set), and the relay server refers to hbbr ( 21116 port).
|
||||
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).
|
||||
|
||||
e.g.
|
||||
|
||||
```
|
||||
```nolang
|
||||
hbbs.example.com
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```
|
||||
```nolang
|
||||
hbbs.example.com:21116
|
||||
```
|
||||
|
||||
@ -106,15 +109,15 @@ hbbs.example.com:21116
|
||||
|
||||
#### Put config in rustdesk.exe file name (Windows only)
|
||||
|
||||
Change `rustdesk.exe` to rustdesk-`host=<host-ip-or-name>,key=<public-key-string>`.exe, e.g. rustdesk-`host=192.168.1.137,key=xfdsfsd32=32`.exe, you can see the config result in the about window as below.
|
||||
Change `rustdesk.exe` to rustdesk-`host=<host-ip-or-name>,key=<public-key-string>`.exe, e.g. rustdesk-`host=192.168.1.137,key=xfdsfsd32=32`.exe. You can see the config result in the About Window below.
|
||||
|
||||
<a name="invalidchar"></a>
|
||||
{{% notice note %}}
|
||||
You need to set `host` and `key` both, missing any one won't work.
|
||||
You need to set both `host` and `key`, missing either one will not work.
|
||||
|
||||
If there are invalid characters in the key which can not be used in file name, please remove
|
||||
id_ed25519 file and restart your hbbs/hbbr, the id_ed25519.pub file will be regenerated, please
|
||||
repeat until you get valid characters.
|
||||
If there are invalid characters in the key which can not be used in a Windows file name, please remove the
|
||||
`id_ed25519` file from your server and restart `hbbs`/`hbbr`. This will cause the `id_ed25519.pub` file to regenerate. You may need to
|
||||
repeat this process until you get valid characters.
|
||||
{{% /notice %}}
|
||||
|
||||
| Menu | About Page |
|
||||
@ -122,19 +125,20 @@ repeat until you get valid characters.
|
||||
 |  |
|
||||
|
||||
## Key
|
||||
-----------
|
||||
Different from the old version, the key in this version is mandatory, but you don't need to set it yourself. 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), the main purpose is for communication encryption.
|
||||
|
||||
If you did not fill in the `Key:` (the content in the public key file `id_ed25519.pub`) in the previous step, it does not affect the connection, but the connection cannot be encrypted.
|
||||
Different from the old version, the key in this version is mandatory, but you don't need to set it yourself. When `hbbs` runs for the first time, it will automatically generate a pair of encrypted private and public keys (respectively located in the `id_ed25519` and `id_ed25519.pub` files in the running directory), whose main purpose is for communication encryption.
|
||||
|
||||
````
|
||||
If you did not fill in the `Key:` (the content in the public key file `id_ed25519.pub`) in the previous step, it does not affect the connection, but the connection cannot be encrypted.
|
||||
|
||||
```bash
|
||||
cat ./id_ed25519.pub
|
||||
````
|
||||
|
||||
If you wanna prohibit users without key from establishing non-encrypted connections, please add the `-k _` parameter when running hbbs and hbbr, for example:
|
||||
````
|
||||
If you want to prohibit users without the key from establishing non-encrypted connections, please add the `-k _` parameter when running `hbbs` and `hbbr`, for example:
|
||||
|
||||
```bash
|
||||
./hbbs -r <relay-server-ip[:port]> -k _
|
||||
./hbbr -k _
|
||||
````
|
||||
```
|
||||
|
||||
If you wanna change key, please remove `id_ed25519` and `id_ed25519.pub` files and restart hbbs/hbbr，hbbs will generate new key pair.
|
||||
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.
|
||||
|
||||
@ -5,28 +5,34 @@ weight: 20
|
||||
|
||||
|
||||
### Install NodeJs
|
||||
Please [Download](https://nodejs.org/dist/v16.14.2/node-v16.14.2-x86.msi) and install.
|
||||
|
||||
Please [download](https://nodejs.org/dist/v16.14.2/node-v16.14.2-x86.msi) and install.
|
||||
NodeJs is the runtime environment of pm2, so you need to install NodeJs first。
|
||||
|
||||
### Install pm2
|
||||
Enter belows in cmd.exe, press the Enter key for each line, and run them line by line.
|
||||
```
|
||||
|
||||
Enter belows in `cmd.exe`, press the <kbd>Enter</kbd> key for each line, and run them line by line.
|
||||
|
||||
```cmd
|
||||
npm install -g pm2
|
||||
npm install pm2-windows-startup -g
|
||||
pm2-startup install
|
||||
```
|
||||
|
||||
### Run hbbr and hbbs
|
||||
Download the windows version of [server program](https://github.com/rustdesk/rustdesk-server/releases), assuming you unzip it to the C drive. Run the following four lines of commands respectively.
|
||||
```
|
||||
|
||||
Download the Windows version of [server program](https://github.com/rustdesk/rustdesk-server/releases). Unzip the program to the C: drive. Run the following four commands (take care to edit the `-r` parameter):
|
||||
|
||||
```cmd
|
||||
cd c:\rustdesk-server-windows-x64
|
||||
pm2 start hbbs.exe -- -r <The address of the host where hbbr is running>
|
||||
pm2 start hbbs.exe -- -r <The host where hbbr is running>
|
||||
pm2 start hbbr.exe
|
||||
pm2 save
|
||||
```
|
||||
|
||||
### View log
|
||||
```
|
||||
### View the log
|
||||
|
||||
```cmd
|
||||
pm2 log hbbr
|
||||
pm2 log hbbs
|
||||
```
|
||||
```
|
||||
|
||||
Loading…
Reference in New Issue
Block a user