mirror of
https://github.com/rustdesk/doc.rustdesk.com.git
synced 2025-06-20 09:47:45 +02:00
Update _index.en.md
This commit is contained in:
RustDesk
GitHub
parent
610b8956f1
commit
93e12866c4
@ -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](https://rustdesk.com/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](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/) page for more details.
|
||||
2. Open TCP port 21114.
|
||||
3. Log into your RustDesk Server.
|
||||
@ -26,20 +26,20 @@ 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?
|
||||
You'd better back up data files (sqlite3 files etc.) first, https://github.com/rustdesk/rustdesk-server-pro/discussions/184#discussioncomment-8013375.
|
||||
#### If you installed with script
|
||||
### If you installed with script
|
||||
1. [This page](/docs/en/self-host/rustdesk-server-pro/installscript/script/#upgrade).
|
||||
2. Copy and paste the command into your Linux terminal.
|
||||
3. Follow the prompts as they guide you through the upgrade.
|
||||
#### Docker Compose
|
||||
### Docker Compose
|
||||
```
|
||||
sudo docker compose down
|
||||
sudo docker compose pull
|
||||
sudo docker compose up -d
|
||||
```
|
||||
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).
|
||||
#### Docker
|
||||
### Docker
|
||||
```
|
||||
sudo docker ps
|
||||
# you can also use <CONTAINER NAME>, e.g. `hbbs` and `hbbr` if you follow our manual.
|
||||
@ -107,50 +107,50 @@ rustdesk/makepkg latest 86a981e2e18f 2 months ago 2.23GB
|
||||
|
||||
For more details, check [this](https://www.cherryservers.com/blog/how-to-update-docker-image).
|
||||
|
||||
### 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. `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/).
|
||||
|
||||
### 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`.
|
||||
@ -158,16 +158,16 @@ 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 / device names are empty?
|
||||
## Why are my logs / device names are empty?
|
||||
Ensure API is set correctly on the device being controlled, https://github.com/rustdesk/rustdesk-server-pro/issues/21#issuecomment-1637935750.
|
||||
|
||||
### 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
|
||||
@ -187,10 +187,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'
|
||||
|
||||
@ -213,19 +213,19 @@ Invoke-WebRequest "https://github.com/rustdesk/rustdesk/releases/download/1.2.6/
|
||||
Start-Process .\rustdesk.exe --silent-install -wait
|
||||
```
|
||||
|
||||
### `Key mismatch` error
|
||||
## `Key mismatch` error
|
||||
Please configure your client with [correct key](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/relay/).
|
||||
|
||||
### `Failed to connect to relay server` error
|
||||
## `Failed to connect to relay server` error
|
||||
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/).
|
||||
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/).
|
||||
|
||||
### Reset MFA for Admin account
|
||||
## Reset MFA for Admin account
|
||||
https://github.com/rustdesk/rustdesk/discussions/6576
|
||||
|
||||
### Set up HTTPS for web console manually
|
||||
## Set up HTTPS for web console manually
|
||||
|
||||
#### 1. Buy a domain name and resolve it to your server's IP address.
|
||||
### 1. Buy a domain name and resolve it to your server's IP address.
|
||||
* Buy a domain name from a domain registrar like GoDaddy, Namecheap, or Namesilo.
|
||||
* Resolve the domain name to your server's IP address with one of the following:
|
||||
- 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
|
||||
|
||||
* 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`.
|
||||
|
||||
#### 2. Install Nginx
|
||||
### 2. Install Nginx
|
||||
* Debian/Ubuntu: `sudo apt-get install nginx`
|
||||
* Fedora/CentOS: `sudo dnf install nginx` or `sudo yum install nginx`
|
||||
* 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
|
||||
|
||||
Run `nginx -h` to check whether it has been installed successfully.
|
||||
|
||||
#### 3. Install Certbot
|
||||
### 3. Install Certbot
|
||||
* Method 1: If `snap` is installed, run `sudo snap install certbot --classic`.
|
||||
* Method 2: Using `python3-certbot-nginx` instead, e.g. `sudo apt-get install python3-certbot-nginx` for Ubuntu.
|
||||
* Method 3: If the above two methods failed, try install `certbot-nginx`, e.g. `sudo yum install certbot-nginx` for CentOS 7.
|
||||
|
||||
Run `certbot -h` to check whether it has been installed successfully.
|
||||
|
||||
#### 4. Config Nginx
|
||||
### 4. Config Nginx
|
||||
There are two ways:
|
||||
* 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.
|
||||
```sh
|
||||
@ -288,7 +288,7 @@ EOF
|
||||
```
|
||||
Run `cat /etc/nginx/conf.d/rustdesk.conf` to make sure its content is correct.
|
||||
|
||||
#### 5. Enable firewall rules for the domain
|
||||
### 5. Enable firewall rules for the domain
|
||||
Run the following commands:
|
||||
|
||||
```sh
|
||||
@ -298,7 +298,7 @@ sudo ufw --force enable
|
||||
sudo ufw --force reload
|
||||
```
|
||||
|
||||
#### 6. Generate SSL certificate
|
||||
### 6. Generate SSL certificate
|
||||
Replace `$YOUR_DOMAIN` with your domain name, then run
|
||||
`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`.
|
||||
|
||||
@ -358,10 +358,10 @@ Solution: it may be caused by firewall, please refer to https://rustdesk.com/doc
|
||||
|
||||
Notice: Run `sudo service nginx restart` if you change the `rustdesk.conf` manually.
|
||||
|
||||
#### 7. Login to the web page
|
||||
### 7. Login to the web page
|
||||
* 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.
|
||||
|
||||
#### 8. Add WebSocket Secure (WSS) support for the id server and relay server to enable secure communication for all platforms.
|
||||
### 8. Add WebSocket Secure (WSS) support for the id server and relay server to enable secure communication for all platforms.
|
||||
|
||||
Add the following configuration to the first `server` section of the `/etc/nginx/.../rustdesk.conf` file, then restart the `Nginx` service.
|
||||
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 {
|
||||
If you have previously deployed for web clients and want to use it across all platforms, you need to add `proxy_read_timeout`.
|
||||
{{% /notice %}}
|
||||
|
||||
#### 9. Bypass CORS if using RustDesk public web client `https://rustdesk.com/web`
|
||||
### 9. Bypass CORS if using RustDesk public web client `https://rustdesk.com/web`
|
||||
|
||||
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.
|
||||
|
||||
@ -474,7 +474,7 @@ You need to add below in the `location /` section of the `/etc/nginx/.../rustdes
|
||||
}
|
||||
```
|
||||
|
||||
### SELinux
|
||||
## SELinux
|
||||
|
||||
If `Waiting for RustDesk Relay service to become active...` appears when install, it may be caused by SELinux. You can try the following commands:
|
||||
|
||||
@ -485,9 +485,9 @@ sudo restorecon -v '/usr/bin/hbbs'
|
||||
sudo restorecon -v '/usr/bin/hbbr'
|
||||
```
|
||||
|
||||
### Firewall
|
||||
## Firewall
|
||||
|
||||
#### Firewall of cloud
|
||||
### Firewall of cloud
|
||||
If you run on AWS/Azure/Google/DigitalOcean cloud, please open UDP (21116) and TCP (21114-21119) inbound port on cloud vendor's dashboard.
|
||||
|
||||
- [AWS] https://docs.aws.amazon.com/network-firewall/latest/developerguide/getting-started.html
|
||||
@ -495,7 +495,7 @@ If you run on AWS/Azure/Google/DigitalOcean cloud, please open UDP (21116) and T
|
||||
- [Google] https://cloud.google.com/firewall/docs/firewalls
|
||||
- [DigitalOcean] https://docs.digitalocean.com/products/networking/firewalls/
|
||||
|
||||
#### Firewall of on-premise server
|
||||
### Firewall of on-premise server
|
||||
RustDesk set firewall with `ufw`. It may not work on some distros like CentOS 9, you can try with `firewall-cmd`:
|
||||
|
||||
```sh
|
||||
@ -522,7 +522,7 @@ sudo firewall-cmd --permanent --add-port=443/tcp
|
||||
|
||||
After above, run `sudo firewall-cmd --reload` to reload firewall.
|
||||
|
||||
### After changing the admin password in the web console I cannot log in. Is there a simple way to reset the password?
|
||||
## After changing the admin password in the web console I cannot log in. Is there a simple way to reset the password?
|
||||
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`.
|
||||
2. The command is `rustdesk-utils set_password username password`. If it works it will say *Done*.
|
||||
|
||||
@ -530,5 +530,5 @@ You also have the following other commands `genkeypair`, `validatekeypair [publi
|
||||
|
||||
https://github.com/rustdesk/rustdesk-server-pro/discussions/183
|
||||
|
||||
### Add root CA certificate into Docker container (for TLS failure with SMTP, OIDC etc.)
|
||||
## Add root CA certificate into Docker container (for TLS failure with SMTP, OIDC etc.)
|
||||
https://github.com/rustdesk/rustdesk-server-pro/issues/99#issuecomment-2235014703
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user