extern/doc.rustdesk.com
1
0
Fork 1
mirror of https://github.com/rustdesk/doc.rustdesk.com.git synced 2025-01-27 08:28:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update _index.en.md

Browse Source
This commit is contained in:
Mr-Update 2023-09-13 23:30:18 +02:00 committed by GitHub
parent 6135acc416
commit 051aa88c5c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
content/self-host/rustdesk-server-pro/relay/_index.en.md
View File

@ -7,31 +7,32 @@ weight: 17
You can have several relay servers running across the globe and leverage GeoLocation to use the closest relay server, giving you a faster experience when connecting to remote computers. You can have several relay servers running across the globe and leverage GeoLocation to use the closest relay server, giving you a faster experience when connecting to remote computers.
> You will need the private key pair **id_ed25519** and **id_ed25519.pub** > You will need the private key pair `id_ed25519` and `id_ed25519.pub`.
1 - If docker is already installed, connect to your server via SSH and create a volume for hbbr.
1 - If docker is already installed, connect to your server via SSH and create a volume for HBBR
``` ```
# docker volume create hbbr # docker volume create hbbr
``` ```
The volume hbbr should be located in /var/lib/docker/volumes/hbbr/_data
The volume hbbr should be located in `/var/lib/docker/volumes/hbbr/_data`.
2 - Copy the private key pair to the volume location, in this case we will use SCP to copy the files. 2 - Copy the private key pair to the volume location, in this case we will use SCP to copy the files.
The command syntax is: scp <path/filename> username@server:</destination/path> The command syntax is: `scp <path/filename> username@server:</destination/path>`.
``` ```
# scp id_ed25519 root@100.100.100.100:/var/lib/docker/volumes/hbbr/_data # scp id_ed25519 root@100.100.100.100:/var/lib/docker/volumes/hbbr/_data
# scp id_ed25519.pub root@100.100.100.100:/var/lib/docker/volumes/hbbr/_data # scp id_ed25519.pub root@100.100.100.100:/var/lib/docker/volumes/hbbr/_data
``` ```
3 - Deploy the hbbr container using the volume previously created. This volume has the private key pair needed to run your private relay server.
3 - Deploy the HBBR container using the volume previously created. This volume has the private key pair needed to run your private relay.
``` ```
# sudo docker run --name hbbr -v hbbr:/root -td --net=host rustdesk/rustdesk-server hbbr -k _ # sudo docker run --name hbbr -v hbbr:/root -td --net=host rustdesk/rustdesk-server hbbr -k _
``` ```
4 - Check the running logs to verify that hbbr is running using your key pair 4 - Check the running logs to verify that hbbr is running using your key pair.
``` ```
# docker logs hbbr # docker logs hbbr
@ -45,18 +46,18 @@ INFO [src/relay_server.rs:81] Listening on tcp :21117
Depending on your OS, you might want to block/allow IPs using a firewall. Depending on your OS, you might want to block/allow IPs using a firewall.
In our case, running ubuntu we want to allow any tcp connections, to ports 21117 and 21119 In our case, running Ubuntu we want to allow any TCP connections, to ports 21117 and 21119.
``` ```
# sudo ufw allow proto tcp from any to any port 21117,21119 # sudo ufw allow proto tcp from any to any port 21117,21119
``` ```
**enable the firewall** **Enable the firewall**
``` ```
# sudo ufw enable # sudo ufw enable
``` ```
**check the status** **Check the status**
``` ```
# ufw status # ufw status
@ -68,55 +69,50 @@ To Action From
21117,21119/tcp (v6) ALLOW Anywhere (v6) 21117,21119/tcp (v6) ALLOW Anywhere (v6)
``` ```
## Configure RustDesk Pro for Geo Location using Web Console ## Configure RustDesk Pro for Geo Location using Web Console
### Register and Download the GeoLite2 City database file ### Register and Download the GeoLite2 City database file
To use geo location, hbbs needs access to the MaxMind GeoLite2 City database. The database is free and you can register to download the file and get an API key. To use geo location, hbbs needs access to the MaxMind GeoLite2 City database. The database is free and you can register to download the file and get an API key.
Start by creating an account (if you don’t have one) by going to the website https://www.maxmind.com/en/account/login Start by creating an account (if you don’t have one) by going to the [website](https://www.maxmind.com/en/account/login).
Go to Download Databases and download the GeoLite2 City, choose the gzip file and you should have the mmdb when decompressing it. Go to `Download Databases` and download the GeoLite2 City, choose the gzip file and you should have the `mmdb` file when decompressing it.
<img width="500" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/e14318fb-ec52-463c-af77-d08c9479c1b5"> <img width="500" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/e14318fb-ec52-463c-af77-d08c9479c1b5">
If you installed RustDesk Pro using the installation script on a Linux machine, the `mmdb` file needs to be moved to `/var/lib/rustdesk-server/`.
If you installed RustDesk Pro using the installation script on a Linux machine, the mmdb file needs to be moved to **/var/lib/rusted-server/** For Docker installations the file should be in the volume you mapped when deploying the container mapped to `/root`.
For docker installations the file should be in the volume you mapped when deploying the container mapped to \/root
#### Get an API key to automate the process - Linux servers #### Get an API key to automate the process - Linux servers
You need to update this file regularly and we can use a cronjob to do that. You will need an API key to access the download link which is free. You need to update this file regularly and we can use a cronjob to do that. You will need an API key to access the download link which is free.
Go to Manage License Keys and generate a new license key <br> Go to `Manage License Keys` and generate a new license key. <br>
<img width="500" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/632aeb33-4f5d-4a31-9010-38e01c22d3c9"> <img width="500" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/632aeb33-4f5d-4a31-9010-38e01c22d3c9">
<br> <br>
<img width="500" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/3e178174-5fbf-46b7-a335-01f77125dfad"> <img width="500" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/3e178174-5fbf-46b7-a335-01f77125dfad">
You can automate the [download process](https://dev.maxmind.com/geoip/updating-databases) in a few ways, but you add the following command to your crontab replacing {Your Access Key} with the API key you got from the previous step.
You can automate the download process in a few ways (https://dev.maxmind.com/geoip/updating-databases) but you add the following command to your crontab replacing {Your Access Key} with the API key you got from the previous step.
``` ```
/usr/bin/curl -L --silent 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-City&license_key={Your Access Key}&suffix=tar.gz' | /bin/tar -C '/var/lib/rustdesk-server/‘’ -xvz --keep-newer-files --strip-components=1 --wildcards '*GeoLite2-City.mmdb' /usr/bin/curl -L --silent 'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-City&license_key={Your Access Key}&suffix=tar.gz' | /bin/tar -C '/var/lib/rustdesk-server/' -xvz --keep-newer-files --strip-components=1 --wildcards '*GeoLite2-City.mmdb'
``` ```
### Change settings in RustDesk Pro Web Console ### Change settings in RustDesk Pro Web Console
Add your relay server IP addresses to the the Relay Server List, using just the IP address. **Do not add the port** <br> Add your relay server IP addresses to the the Relay Server List, using just the IP address. **Do not add the port.** <br>
<img width="500" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/c4452ba4-5e1d-437a-ae1d-fc0070bfa26c"> <img width="500" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/c4452ba4-5e1d-437a-ae1d-fc0070bfa26c">
Add a Geo Override but adding the server IP address and the coordinates where the server is located. <br> Add a Geo Override but adding the server IP address and the coordinates where the server is located. <br>
<img width="500" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/41c558e3-423b-4296-90d3-cb0769f4a369"> <img width="500" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/41c558e3-423b-4296-90d3-cb0769f4a369">
Click Reload Geo and your list should look similar to this. <br> Click `Reload Geo` and your list should look similar to this. <br>
<img width="500" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/5a0d39a9-4fec-46b4-a7a2-7ed38b6baeb7"> <img width="500" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/5a0d39a9-4fec-46b4-a7a2-7ed38b6baeb7">
To confirm the results, check your hbbs logs when clicking `Reload Geo`, you should see a message showing the relay server IP addresses and their coordinates.
To confirm the results, check your HHBS logs when clicking Reload Geo, you should see a message showing the relay server IP addresses and their coordinates > If you are running RustDesk Pro on a Linux machine use the command `RUST_LOG=debug ./hbbs` to view the logs. If you are running on a Docker container user `docker logs hbbs`.
> If you are runninf RustDesk Pro on a linux machine use the command **RUST_LOG=debug ./hbbs** to view the logs, if you are running on a docker container user **docker logs hbbs**
``` ```
RUST_LOG=debug ./hbbs RUST_LOG=debug ./hbbs
@ -130,7 +126,7 @@ INFO [src/common.rs:119] relay-servers=["1xx.xxx.xxx.x7", "1xx.xxx.xxx.xx8", "7x
NFO [src/rendezvous_server.rs:1467] parsed relay servers: [("1xx.xxxx.xxx.xx7", Some((-1x, xxx))), ("1xx.xxx.xxx.xx8", Some((-3x, xxx))), ("7xx.xxx.xxx.xx1", Some((6x, xxx)))] NFO [src/rendezvous_server.rs:1467] parsed relay servers: [("1xx.xxxx.xxx.xx7", Some((-1x, xxx))), ("1xx.xxx.xxx.xx8", Some((-3x, xxx))), ("7xx.xxx.xxx.xx1", Some((6x, xxx)))]
``` ```
You can also confirm the relay requests diercelty on your HBBR instancies, simply by checking the container logs You can also confirm the relay requests directly on your hbbr instances, simply by checking the container logs.
``` ```
# docker logs hbbr # docker logs hbbr