Skip to content

Commit 93e1286

Browse files
authored
Update _index.en.md
1 parent 610b895 commit 93e1286

File tree

1 file changed

+42
-42
lines changed

1 file changed

+42
-42
lines changed

content/self-host/rustdesk-server-pro/faq/_index.en.md

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: FAQ
33
weight: 600
44
---
55

6-
### How can I install with the Simple Install Script?
6+
## How can I install with the Simple Install Script?
77
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.
88
2. Spin up a VPS, bare metal or Linux VM.
99
3. If you want to use DNS and SSL create a DNS name i.e. `rustdesk.yourdomain.com`.
@@ -14,7 +14,7 @@ weight: 600
1414
8. Log in with the username `admin` and password `test1234`.
1515
9. Enter your license code purchased in step 1.
1616

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?
1818
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.
1919
2. Open TCP port 21114.
2020
3. Log into your RustDesk Server.
@@ -26,20 +26,20 @@ weight: 600
2626
9. Log in with the username `admin` and password `test1234`.
2727
10. Enter your license code purchased in step 1.
2828

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?
3030
You'd better back up data files (sqlite3 files etc.) first, https://github.com/rustdesk/rustdesk-server-pro/discussions/184#discussioncomment-8013375.
31-
#### If you installed with script
31+
### If you installed with script
3232
1. [This page](/docs/en/self-host/rustdesk-server-pro/installscript/script/#upgrade).
3333
2. Copy and paste the command into your Linux terminal.
3434
3. Follow the prompts as they guide you through the upgrade.
35-
#### Docker Compose
35+
### Docker Compose
3636
```
3737
sudo docker compose down
3838
sudo docker compose pull
3939
sudo docker compose up -d
4040
```
4141
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
4343
```
4444
sudo docker ps
4545
# you can also use <CONTAINER NAME>, e.g. `hbbs` and `hbbr` if you follow our manual.
@@ -107,67 +107,67 @@ rustdesk/makepkg latest 86a981e2e18f 2 months ago 2.23GB
107107

108108
For more details, check [this](https://www.cherryservers.com/blog/how-to-update-docker-image).
109109

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?
111111
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`.
112112

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?
114114
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`.
115115

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?
117117
To check the status `sudo systemctl status rustdesk-hbbs|rustdesk-hbbr` e.g. `sudo systemctl status rustdesk-hbbs`.
118118

119-
### How can I change the admin password?
119+
## How can I change the admin password?
120120
1. `https://rustdesk.yourdomain.com` or `http://youripaddress:21114`.
121121
2. Log in with the username `admin` and password `test1234`.
122122
3. Click on `admin` in the top right hand corner.
123123
4. Click on `Settings`.
124124
5. Enter your new password in the boxes provided.
125125

126-
### How can I move my license to a new server?
126+
## How can I move my license to a new server?
127127
Please see [here](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/#invoices-and-migration).
128128

129-
### Emails aren't working from my VPS
129+
## Emails aren't working from my VPS
130130
A lot of VPS providers block ports 465 and 25.
131131

132132
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`.
133133

134134
Your mail server may not be using port 25. Please make sure you are using the correct ports.
135135

136-
### Can I deploy RustDesk using PowerShell or similar?
136+
## Can I deploy RustDesk using PowerShell or similar?
137137
Sure, you can find scripts to aid deployment [here](https://rustdesk.com/docs/en/self-host/client-deployment/).
138138

139-
### How can I file a bug report?
139+
## How can I file a bug report?
140140
Please file via [GitHub](https://github.com/rustdesk/rustdesk-server-pro/issues).
141141

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?
143143
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!
144144
2. We want to be here and still making great progress in years to come.
145145
3. The open source version will continue to be open source and we encourage others to make developments in line with the AGPL license.
146146

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?
148148
This is easily sorted, you need to allow cross-group access.
149149
1. Add new groups.
150150
2. Click `Edit`.
151151
3. Select the relevant groups you want access (it automatically adds them in the corresponding group).
152152

153-
### How can I get configs automatically?
153+
## How can I get configs automatically?
154154
Configs are generated automatically.
155155
1. Download the newest clients from [GitHub](https://github.com/rustdesk/rustdesk/releases/latest).
156156
2. On the main page in the web console click on `Windows EXE`.
157157
3. Fill in the host and API (if different from your config).
158158
4. Click `Submit`.
159159
5. Scan QR Code on Android and rename exe to what has been generated.
160160

161-
### Do you offer hosting for RustDesk Server Pro?
161+
## Do you offer hosting for RustDesk Server Pro?
162162
Please get in touch with our [sales](mailto://[email protected]) team.
163163

164-
### Is there somewhere I can see video setup guides?
164+
## Is there somewhere I can see video setup guides?
165165
Yes! We have a [YouTube Channel](https://youtube.com/@RustDesk).
166166

167-
### Why are my logs / device names are empty?
167+
## Why are my logs / device names are empty?
168168
Ensure API is set correctly on the device being controlled, https://github.com/rustdesk/rustdesk-server-pro/issues/21#issuecomment-1637935750.
169169

170-
### How can I uninstall RustDesk Server Pro?
170+
## How can I uninstall RustDesk Server Pro?
171171
Run the following commands:
172172
```sh
173173
sudo systemctl stop rustdesk-hbbs.service
@@ -187,10 +187,10 @@ If the script installed Nginx then remove using:
187187
sudo apt remove nginx
188188
```
189189

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?
191191
Disable and then delete will now be available.
192192

193-
### How can I update RustDesk with PowerShell?
193+
## How can I update RustDesk with PowerShell?
194194
```ps
195195
$ErrorActionPreference= 'silentlycontinue'
196196
@@ -213,19 +213,19 @@ Invoke-WebRequest "https://github.com/rustdesk/rustdesk/releases/download/1.2.6/
213213
Start-Process .\rustdesk.exe --silent-install -wait
214214
```
215215

216-
### `Key mismatch` error
216+
## `Key mismatch` error
217217
Please configure your client with [correct key](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/relay/).
218218

219-
### `Failed to connect to relay server` error
219+
## `Failed to connect to relay server` error
220220
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/).
221221
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/).
222222

223-
### Reset MFA for Admin account
223+
## Reset MFA for Admin account
224224
https://github.com/rustdesk/rustdesk/discussions/6576
225225

226-
### Set up HTTPS for web console manually
226+
## Set up HTTPS for web console manually
227227

228-
#### 1. Buy a domain name and resolve it to your server's IP address.
228+
### 1. Buy a domain name and resolve it to your server's IP address.
229229
* Buy a domain name from a domain registrar like GoDaddy, Namecheap, or Namesilo.
230230
* Resolve the domain name to your server's IP address with one of the following:
231231
- Your domain registrar's control panel (recommended)
@@ -237,7 +237,7 @@ For example, if you buy a domain name `example.com` from `Namesilo` and your ser
237237
![](/docs/en/self-host/rustdesk-server-pro/faq/images/namesilo-dns-table.png)
238238
* 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`.
239239

240-
#### 2. Install Nginx
240+
### 2. Install Nginx
241241
* Debian/Ubuntu: `sudo apt-get install nginx`
242242
* Fedora/CentOS: `sudo dnf install nginx` or `sudo yum install nginx`
243243
* Arch: `sudo pacman -S install nginx`
@@ -247,14 +247,14 @@ For example, if you buy a domain name `example.com` from `Namesilo` and your ser
247247

248248
Run `nginx -h` to check whether it has been installed successfully.
249249

250-
#### 3. Install Certbot
250+
### 3. Install Certbot
251251
* Method 1: If `snap` is installed, run `sudo snap install certbot --classic`.
252252
* Method 2: Using `python3-certbot-nginx` instead, e.g. `sudo apt-get install python3-certbot-nginx` for Ubuntu.
253253
* Method 3: If the above two methods failed, try install `certbot-nginx`, e.g. `sudo yum install certbot-nginx` for CentOS 7.
254254

255255
Run `certbot -h` to check whether it has been installed successfully.
256256

257-
#### 4. Config Nginx
257+
### 4. Config Nginx
258258
There are two ways:
259259
* 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.
260260
```sh
@@ -288,7 +288,7 @@ EOF
288288
```
289289
Run `cat /etc/nginx/conf.d/rustdesk.conf` to make sure its content is correct.
290290

291-
#### 5. Enable firewall rules for the domain
291+
### 5. Enable firewall rules for the domain
292292
Run the following commands:
293293

294294
```sh
@@ -298,7 +298,7 @@ sudo ufw --force enable
298298
sudo ufw --force reload
299299
```
300300

301-
#### 6. Generate SSL certificate
301+
### 6. Generate SSL certificate
302302
Replace `$YOUR_DOMAIN` with your domain name, then run
303303
`sudo certbot --nginx --cert-name $YOUR_DOMAIN --key-type ecdsa --renew-by-default --no-eff-email --agree-tos --server https://acme-v02.api.letsencrypt.org/directory -d $YOUR_DOMAIN`.
304304

@@ -358,10 +358,10 @@ Solution: it may be caused by firewall, please refer to https://rustdesk.com/doc
358358

359359
Notice: Run `sudo service nginx restart` if you change the `rustdesk.conf` manually.
360360

361-
#### 7. Login to the web page
361+
### 7. Login to the web page
362362
* 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.
363363

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.
365365

366366
Add the following configuration to the first `server` section of the `/etc/nginx/.../rustdesk.conf` file, then restart the `Nginx` service.
367367
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 {
452452
If you have previously deployed for web clients and want to use it across all platforms, you need to add `proxy_read_timeout`.
453453
{{% /notice %}}
454454

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`
456456

457457
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.
458458

@@ -474,7 +474,7 @@ You need to add below in the `location /` section of the `/etc/nginx/.../rustdes
474474
}
475475
```
476476

477-
### SELinux
477+
## SELinux
478478

479479
If `Waiting for RustDesk Relay service to become active...` appears when install, it may be caused by SELinux. You can try the following commands:
480480

@@ -485,17 +485,17 @@ sudo restorecon -v '/usr/bin/hbbs'
485485
sudo restorecon -v '/usr/bin/hbbr'
486486
```
487487

488-
### Firewall
488+
## Firewall
489489

490-
#### Firewall of cloud
490+
### Firewall of cloud
491491
If you run on AWS/Azure/Google/DigitalOcean cloud, please open UDP (21116) and TCP (21114-21119) inbound port on cloud vendor's dashboard.
492492

493493
- [AWS] https://docs.aws.amazon.com/network-firewall/latest/developerguide/getting-started.html
494494
- [Azure] https://learn.microsoft.com/en-us/azure/virtual-network/network-security-groups-overview
495495
- [Google] https://cloud.google.com/firewall/docs/firewalls
496496
- [DigitalOcean] https://docs.digitalocean.com/products/networking/firewalls/
497497

498-
#### Firewall of on-premise server
498+
### Firewall of on-premise server
499499
RustDesk set firewall with `ufw`. It may not work on some distros like CentOS 9, you can try with `firewall-cmd`:
500500

501501
```sh
@@ -522,13 +522,13 @@ sudo firewall-cmd --permanent --add-port=443/tcp
522522

523523
After above, run `sudo firewall-cmd --reload` to reload firewall.
524524

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?
526526
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`.
527527
2. The command is `rustdesk-utils set_password username password`. If it works it will say *Done*.
528528

529529
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`.
530530

531531
https://github.com/rustdesk/rustdesk-server-pro/discussions/183
532532

533-
### Add root CA certificate into Docker container (for TLS failure with SMTP, OIDC etc.)
533+
## Add root CA certificate into Docker container (for TLS failure with SMTP, OIDC etc.)
534534
https://github.com/rustdesk/rustdesk-server-pro/issues/99#issuecomment-2235014703

0 commit comments

Comments
 (0)