You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/self-host/rustdesk-server-pro/faq/_index.en.md
+42-42Lines changed: 42 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: FAQ
3
3
weight: 600
4
4
---
5
5
6
-
###How can I install with the Simple Install Script?
6
+
## How can I install with the Simple Install Script?
7
7
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.
8
8
2. Spin up a VPS, bare metal or Linux VM.
9
9
3. If you want to use DNS and SSL create a DNS name i.e. `rustdesk.yourdomain.com`.
@@ -14,7 +14,7 @@ weight: 600
14
14
8. Log in with the username `admin` and password `test1234`.
15
15
9. Enter your license code purchased in step 1.
16
16
17
-
###How can I convert from RustDesk Server Open Source to RustDesk Server Pro?
17
+
## How can I convert from RustDesk Server Open Source to RustDesk Server Pro?
18
18
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.
19
19
2. Open TCP port 21114.
20
20
3. Log into your RustDesk Server.
@@ -26,20 +26,20 @@ weight: 600
26
26
9. Log in with the username `admin` and password `test1234`.
27
27
10. Enter your license code purchased in step 1.
28
28
29
-
###There is a new version of RustDesk Server Pro out, how can I upgrade?
29
+
## There is a new version of RustDesk Server Pro out, how can I upgrade?
30
30
You'd better back up data files (sqlite3 files etc.) first, https://github.com/rustdesk/rustdesk-server-pro/discussions/184#discussioncomment-8013375.
2. Copy and paste the command into your Linux terminal.
34
34
3. Follow the prompts as they guide you through the upgrade.
35
-
####Docker Compose
35
+
### Docker Compose
36
36
```
37
37
sudo docker compose down
38
38
sudo docker compose pull
39
39
sudo docker compose up -d
40
40
```
41
41
But this depends on your docker version, for more discussion, check [this](https://stackoverflow.com/questions/37685581/how-to-get-docker-compose-to-use-the-latest-image-from-repository).
42
-
####Docker
42
+
### Docker
43
43
```
44
44
sudo docker ps
45
45
# you can also use <CONTAINER NAME>, e.g. `hbbs` and `hbbr` if you follow our manual.
For more details, check [this](https://www.cherryservers.com/blog/how-to-update-docker-image).
109
109
110
-
###I installed with the script, how can I start and stop services?
110
+
## I installed with the script, how can I start and stop services?
111
111
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`.
112
112
113
-
###I installed with the script, how can I view the Linux logs?
113
+
## I installed with the script, how can I view the Linux logs?
114
114
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`.
115
115
116
-
###I installed with the script, how can I check the status of the RustDesk services?
116
+
## I installed with the script, how can I check the status of the RustDesk services?
117
117
To check the status `sudo systemctl status rustdesk-hbbs|rustdesk-hbbr` e.g. `sudo systemctl status rustdesk-hbbs`.
118
118
119
-
###How can I change the admin password?
119
+
## How can I change the admin password?
120
120
1.`https://rustdesk.yourdomain.com` or `http://youripaddress:21114`.
121
121
2. Log in with the username `admin` and password `test1234`.
122
122
3. Click on `admin` in the top right hand corner.
123
123
4. Click on `Settings`.
124
124
5. Enter your new password in the boxes provided.
125
125
126
-
###How can I move my license to a new server?
126
+
## How can I move my license to a new server?
127
127
Please see [here](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/#invoices-and-migration).
128
128
129
-
###Emails aren't working from my VPS
129
+
## Emails aren't working from my VPS
130
130
A lot of VPS providers block ports 465 and 25.
131
131
132
132
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`.
133
133
134
134
Your mail server may not be using port 25. Please make sure you are using the correct ports.
135
135
136
-
###Can I deploy RustDesk using PowerShell or similar?
136
+
## Can I deploy RustDesk using PowerShell or similar?
137
137
Sure, you can find scripts to aid deployment [here](https://rustdesk.com/docs/en/self-host/client-deployment/).
138
138
139
-
###How can I file a bug report?
139
+
## How can I file a bug report?
140
140
Please file via [GitHub](https://github.com/rustdesk/rustdesk-server-pro/issues).
141
141
142
-
###Why if I am self hosting is this not free and open source?
142
+
## Why if I am self hosting is this not free and open source?
143
143
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!
144
144
2. We want to be here and still making great progress in years to come.
145
145
3. The open source version will continue to be open source and we encourage others to make developments in line with the AGPL license.
146
146
147
-
###I can't connect to devices in different groups, why is this?
147
+
## I can't connect to devices in different groups, why is this?
148
148
This is easily sorted, you need to allow cross-group access.
149
149
1. Add new groups.
150
150
2. Click `Edit`.
151
151
3. Select the relevant groups you want access (it automatically adds them in the corresponding group).
152
152
153
-
###How can I get configs automatically?
153
+
## How can I get configs automatically?
154
154
Configs are generated automatically.
155
155
1. Download the newest clients from [GitHub](https://github.com/rustdesk/rustdesk/releases/latest).
156
156
2. On the main page in the web console click on `Windows EXE`.
157
157
3. Fill in the host and API (if different from your config).
158
158
4. Click `Submit`.
159
159
5. Scan QR Code on Android and rename exe to what has been generated.
160
160
161
-
###Do you offer hosting for RustDesk Server Pro?
161
+
## Do you offer hosting for RustDesk Server Pro?
162
162
Please get in touch with our [sales](mailto://[email protected]) team.
163
163
164
-
###Is there somewhere I can see video setup guides?
164
+
## Is there somewhere I can see video setup guides?
165
165
Yes! We have a [YouTube Channel](https://youtube.com/@RustDesk).
166
166
167
-
###Why are my logs / device names are empty?
167
+
## Why are my logs / device names are empty?
168
168
Ensure API is set correctly on the device being controlled, https://github.com/rustdesk/rustdesk-server-pro/issues/21#issuecomment-1637935750.
169
169
170
-
###How can I uninstall RustDesk Server Pro?
170
+
## How can I uninstall RustDesk Server Pro?
171
171
Run the following commands:
172
172
```sh
173
173
sudo systemctl stop rustdesk-hbbs.service
@@ -187,10 +187,10 @@ If the script installed Nginx then remove using:
187
187
sudo apt remove nginx
188
188
```
189
189
190
-
###How can I remove devices from the device list in the web console?
190
+
## How can I remove devices from the device list in the web console?
Please configure your client with [correct key](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/relay/).
218
218
219
-
###`Failed to connect to relay server` error
219
+
## `Failed to connect to relay server` error
220
220
Please make sure `hbbr` is running. More information about `hbbr`, you can find [here](https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/install/).
221
221
If your `hbbr` does not run on the same machine of `hbbs`, or you have multiple relay servers, or you do not run it on default port `21117`, you have to tell it to `hbbs` explicitly. Please check [here](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/relay/).
* It takes some time for DNS to take effect, https://www.whatsmydns.net and check whether the domain name has been resolved to your server's IP address. Step 6 depends on the correct resolve result. In the following steps, replace `<YOUR_DOMAIN>` with your subdomain, e.g. `rustdesk.example.com`.
@@ -247,14 +247,14 @@ For example, if you buy a domain name `example.com` from `Namesilo` and your ser
247
247
248
248
Run `nginx -h` to check whether it has been installed successfully.
249
249
250
-
####3. Install Certbot
250
+
### 3. Install Certbot
251
251
* Method 1: If `snap` is installed, run `sudo snap install certbot --classic`.
252
252
* Method 2: Using `python3-certbot-nginx` instead, e.g. `sudo apt-get install python3-certbot-nginx` for Ubuntu.
253
253
* Method 3: If the above two methods failed, try install `certbot-nginx`, e.g. `sudo yum install certbot-nginx` for CentOS 7.
254
254
255
255
Run `certbot -h` to check whether it has been installed successfully.
256
256
257
-
####4. Config Nginx
257
+
### 4. Config Nginx
258
258
There are two ways:
259
259
* If directory `/etc/nginx/sites-available` and `/etc/nginx/sites-enabled` exists, replace `<YOUR_DOMAIN>` of the following command with your domain name and run it.
260
260
```sh
@@ -288,7 +288,7 @@ EOF
288
288
```
289
289
Run `cat /etc/nginx/conf.d/rustdesk.conf` to make sure its content is correct.
290
290
291
-
####5. Enable firewall rules for the domain
291
+
### 5. Enable firewall rules for the domain
292
292
Run the following commands:
293
293
294
294
```sh
@@ -298,7 +298,7 @@ sudo ufw --force enable
298
298
sudo ufw --force reload
299
299
```
300
300
301
-
####6. Generate SSL certificate
301
+
### 6. Generate SSL certificate
302
302
Replace `$YOUR_DOMAIN` with your domain name, then run
@@ -358,10 +358,10 @@ Solution: it may be caused by firewall, please refer to https://rustdesk.com/doc
358
358
359
359
Notice: Run `sudo service nginx restart` if you change the `rustdesk.conf` manually.
360
360
361
-
####7. Login to the web page
361
+
### 7. Login to the web page
362
362
* Open `https://<YOUR_DOMAIN>` in the browser, log in using the default user name "admin" and password "test1234", then change the password to your own.
363
363
364
-
####8. Add WebSocket Secure (WSS) support for the id server and relay server to enable secure communication for all platforms.
364
+
### 8. Add WebSocket Secure (WSS) support for the id server and relay server to enable secure communication for all platforms.
365
365
366
366
Add the following configuration to the first `server` section of the `/etc/nginx/.../rustdesk.conf` file, then restart the `Nginx` service.
367
367
The web client can be accessed via `https://<YOUR_DOMAIN>/web`. Custom clients can use WebSocket by setting `allow-websocket=Y` in the advanced options. If the custom client with WebSocket enabled is used, it will not utilize TCP/UDP and can only connect through a relay (except for direct IP connections). If only this WebSocket-enabled client is used, the server can close ports 21114 to 21119 and only keep port 443 open.
@@ -452,7 +452,7 @@ server {
452
452
If you have previously deployed for web clients and want to use it across all platforms, you need to add `proxy_read_timeout`.
453
453
{{% /notice %}}
454
454
455
-
####9. Bypass CORS if using RustDesk public web client `https://rustdesk.com/web`
455
+
### 9. Bypass CORS if using RustDesk public web client `https://rustdesk.com/web`
456
456
457
457
You need to add below in the `location /` section of the `/etc/nginx/.../rustdesk.conf` to bypass CORS limitation of browsers. Skip this step if you are using your own web client.
458
458
@@ -474,7 +474,7 @@ You need to add below in the `location /` section of the `/etc/nginx/.../rustdes
474
474
}
475
475
```
476
476
477
-
###SELinux
477
+
## SELinux
478
478
479
479
If `Waiting for RustDesk Relay service to become active...` appears when install, it may be caused by SELinux. You can try the following commands:
After above, run `sudo firewall-cmd --reload` to reload firewall.
524
524
525
-
###After changing the admin password in the web console I cannot log in. Is there a simple way to reset the password?
525
+
## After changing the admin password in the web console I cannot log in. Is there a simple way to reset the password?
526
526
1. Ensure you have `rustdesk-utils` installed. If not you can get it [here](https://github.com/rustdesk/rustdesk-server-pro). Also you need to execute the command from the folder where the database is, i.e. `/var/lib/rustdesk-server`.
527
527
2. The command is `rustdesk-utils set_password username password`. If it works it will say *Done*.
528
528
529
529
You also have the following other commands `genkeypair`, `validatekeypair [public key] [secret key]`, `doctor [rustdesk-server]`, `reset_email_verification` and `reset_2fa_verification` which can be used with `rustdesk-utils`.
0 commit comments