extern/doc.rustdesk.com
1
0
Fork 1
mirror of https://github.com/rustdesk/doc.rustdesk.com.git synced 2024-12-26 00:50:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #290 from Mouxy/patch-3

Browse Source 
Update _index.en.md
This commit is contained in:
RustDesk 2023-09-13 07:56:59 +08:00 committed by GitHub
commit c6f535d46d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 45 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -7,18 +7,17 @@ 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.
> [!IMPORTANT]
> You will need the private key pair **id_ed25519** and **id_ed25519.pub**
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
```
The volume hbbr should be located in /var/lib/docker/volumes/hbbr/_data
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:<file path destination>
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
@ -26,22 +25,23 @@ The command syntax is: scp <path/filename> username@server:<file path destinatio
```
Deploy the HBBR container using the volume previously created. This volume has the private key pair needed to run your private relay.
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 _
```
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
INFO [src/common.rs:121] **Private key comes from id_ed25519**
NFO [src/relay_server.rs:581] Key: XXXXXXXXXXXXXXXXXXXXX
INFO [src/relay_server.rs:60] #blacklist(blacklist.txt): 0
INFO [src/relay_server.rs:75] #blocklist(blocklist.txt): 0
INFO [src/relay_server.rs:81] Listening on tcp :21117
```
Depending on your OS, you might want to block/allow IPs using a firewall.
@ -69,17 +69,16 @@ To Action From
```
## Configure hbbs Pro for Geo Location
## Configure RustDesk Pro for Geo Location using Web Console
### 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.
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.
<img width="1119" 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/rusted-server/**
@ -89,13 +88,10 @@ For docker installations the file should be in the volume you mapped when deploy
#### 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.
Go to **Manage License Keys**
<img width="329" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/632aeb33-4f5d-4a31-9010-38e01c22d3c9">
Generate a new license key and save the key
<img width="1064" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/3e178174-5fbf-46b7-a335-01f77125dfad">
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">
<br>
<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 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.
@ -105,21 +101,40 @@ You can automate the download process in a few ways (https://dev.maxmind.com/geo
```
## 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**
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="778" 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>
<img width="500" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/41c558e3-423b-4296-90d3-cb0769f4a369">
Add a Geo Override but adding the server IP address and the coordinates where the server is located.
<img width="502" 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
<img width="1568" alt="image" src="https://github.com/rustdesk/doc.rustdesk.com/assets/642149/5a0d39a9-4fec-46b4-a7a2-7ed38b6baeb7">
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">
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 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
INFO [src/common.rs:130] GEOIP_FILE: ./GeoLite2-City.mmdb
INFO [src/common.rs:159] override 1xx.xxx.xxx.x7: -1.xx 5x.xxx
[src/common.rs:159] override 1xx.xxx.xxx.xx8: -3.xxx 5x.xxxx
[src/common.rs:159] override 7xx.xxx.xxxx.xx1: 6.xxx 5x.xxxx
GEOIP_FILE loaded, #overrides 3
INFO [src/common.rs:119] relay-servers=["1xx.xxx.xxx.x7", "1xx.xxx.xxx.xx8", "7xx.xxx.xxx.xx1"]
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
```
# docker logs hbbr
INFO [src/relay_server.rs:436] Relayrequest 0593e64e-4fe8-4a59-a94f-b3420ab043eb from [::ffff:100.100.123.233]:52038 got paired
INFO [src/relay_server.rs:442] Both are raw
```