RustDesk Server Configuration & Deployment

[tremor021]

General

This is a followup guide on how the RustServer works and how its configured. I'm gonna make it short, because there is not really that much to it. All the "good stuff" is behind a paywalll aka needs you to buy a licence from RustDesk, that includes the nice config UI that we're not getting with the self-hosted free version of the software.

Script link: https://community-scripts.github.io/ProxmoxVE/scripts?id=rustdesk-server

Installation

As you can tell, LXC installs everything automatically and there is no need for user interaction during the install process.
There are technically two executables (servers):

hbbs - RustDesk ID (rendezvous / signaling) server, listen on TCP (21114 - for http in Pro only, 21115, 21116, 21118 for web socket) and UDP (21116)
hbbr - RustDesk relay server, listen on TCP (21117, 21119 for web socket)
Our script installs both of these servers and two services are created:

rustdesk-hbbr.service
rustdesk-hbbs.service

Server & Client configurations

The first time server is started, if no key is defined, it will create private and public key pair in the working directory. To check which one is that, you can check the service file:

root@rustdeskserver:~# systemctl status rustdesk-hbbr.service
● rustdesk-hbbr.service - Rustdesk Relay Server
     Loaded: loaded (/lib/systemd/system/rustdesk-hbbr.service; enabled; preset: enabled)
     Active: active (running) since Thu 2025-02-13 00:53:34 CET; 1 day 8h ago
   Main PID: 4061 (hbbr)
      Tasks: 4 (limit: 77006)
     Memory: 536.0K
        CPU: 9.738s
     CGroup: /system.slice/rustdesk-hbbr.service
             └─4061 /usr/bin/hbbr

Feb 13 00:53:34 rustdeskserver systemd[1]: Started rustdesk-hbbr.service - Rustdesk Relay Server.
root@rustdeskserver:~#

So, we can see that service is loaded from /lib/systemd/system/rustdesk-hbbr.service. If we cat the service file, we get this:

root@rustdeskserver:~# cat /lib/systemd/system/rustdesk-hbbr.service 

[Unit]
Description=Rustdesk Relay Server

[Service]
Type=simple
LimitNOFILE=1000000
ExecStart=/usr/bin/hbbr
WorkingDirectory=/var/lib/rustdesk-server/
User=
Group=
Restart=always
StandardOutput=append:/var/log/rustdesk-server/hbbr.log
StandardError=append:/var/log/rustdesk-server/hbbr.error
# Restart service after 10 seconds if node service crashes
RestartSec=10

[Install]
WantedBy=multi-user.target

root@rustdeskserver:~# 

Service file states that the WorkingDirectory is /var/lib/rustdesk-server/. This is where the keypair is created. Let's look:

root@rustdeskserver:~# ls -la /var/lib/rustdesk-server/
total 136
drwxr-xr-x  2 root root  4096 Feb 14 09:10 .
drwxr-xr-x 19 root root  4096 Feb 13 00:53 ..
-rw-r--r--  1 root root  4096 Feb 13 00:53 db_v2.sqlite3
-rw-r--r--  1 root root 32768 Feb 14 08:28 db_v2.sqlite3-shm
-rw-r--r--  1 root root 82432 Feb 14 08:28 db_v2.sqlite3-wal
-rw-r--r--  1 root root    88 Feb 13 00:53 id_ed25519
-rw-r--r--  1 root root    44 Feb 13 00:53 id_ed25519.pub
root@rustdeskserver:~# 

Files id_ed25519 and id_ed25519.pub are the ones we're looking for. These are the keys used to encrypt communication between clients and server. You can create NEW keypair if you want by deleting these two files and restarting the services.

id_ed25519.pub contains the public key that clients need to know in order to connect. So, let's cat that:

root@rustdeskserver:~# cat /var/lib/rustdesk-server/id_ed25519.pub; echo
kMtF+J8VMGEk2iLmUQ6AbVDkVRKce9r+p8n4YuQfl+c=
root@rustdeskserver:~#

So, the servers public key is kMtF+J8VMGEk2iLmUQ6AbVDkVRKce9r+p8n4YuQfl+c=. We will use this to connect clients to our server. We will use Windows client as example. Get it from RustDesk GitHub:
https://github.com/rustdesk/rustdesk/releases/download/1.3.7/rustdesk-1.3.7-x86_64.exe

In order for RustDesk Client to know the server address and key used to encrypt communications, RustDesk uses client's exe file name. This means the .exe file you just downloaded needs to have a specific name, and it goes like this:

rustdesk-host=<IP of server or URL>,key=kMtF+J8VMGEk2iLmUQ6AbVDkVRKce9r+p8n4YuQfl+c=.exe

Let's assume our server IP address is 192.168.1.243, the file name should be like:

rustdesk-host=192.168.1.243,key=kMtF+J8VMGEk2iLmUQ6AbVDkVRKce9r+p8n4YuQfl+c=.exe

If we run client after we rename the .exe to look like the example above, the client window will show up. If you have other machines running, they will be autodiscovered as shown in this screenshot:

The end

Congratulations, you're done with the configuration and everything should be working. PLEASE read the docs if you have any questions!

https://rustdesk.com/docs/en/self-host/

[alhaddar]

Thank you for this effort. I have a question: Where can I find the compose.yml file? It was not there. Can I create it or not?

Regards.

[tremor021]

This is not a Docker app

[akhdanfadh]

Would you mind to elaborate on what I should do if I have a separate nginx-proxy-manager LXC so that I can use rustdesk.mydomain.com for the relay server? Relevant guide: https://gist.github.com/Lvdwardt/707d9c3fb4581d38102399f91a21c9c6

I keep getting 'Internal Error' when adding stream with rustdesk proxmox's IP and hosts are those 2111*.

[tremor021]

Thats a question for RustDesk github, we are not their support

[akhdanfadh]

Aight, thanks for the pointer. Probably a bug on NPM LXC themselves, submitted an issue.

[lukaspavelka]

Hi thx for manual, btw: how will be rustdesk in this LXC container updated in future? What do you see as right way to do it?

[tremor021]

just type update in the LXC shell

[lukaspavelka]

Can it be just added to cron as a job for every night ?

[tremor021]

i'm not sure you would really want to get automatic updates for any LXC. many apps introduce breaking changes that often crash your LXC

[NebzHB]

Hi, thx for that info, in the service file, hbbs shouldn't be with --relay-servers localhost ?

[GodessofWar]

Good guide. Does the end user need to keep track of the executable at all times, or is this something that can be installed on their workstation? I'd love to make a switch to RustDesk, currently using Teamviewer across about 400 different PCs, so this could save me real money, but having end users have to keep track fo the executable vs. having it running in the task tray is a bit of a tangle. So I didn't know if this installs or has to be launched upon use? It isn't a total deal breaker,I could have them move it to the desktop and launch, but just thinking this through

[Sycondrin13]

Should we at all be concerned about the UAC warning?

[mzb2xeo]

Updated code blocks:

systemctl status rustdesk-hbbr.service

cat /lib/systemd/system/rustdesk-hbbr.service 

ls -la /var/lib/rustdesk-server/

cat /var/lib/rustdesk-server/id_ed25519.pub; echo

https://github.com/rustdesk/rustdesk/releases/download/1.3.7/rustdesk-1.3.7-x86_64.exe

rustdesk-host=<IP of server or URL>,key=<key>.exe 

[HGAdmin01]

Thank you very much for your work! It worked flawlessly! All i had to do was to change the ip from dhcp to static... Learning how to set it up myself would have taken a big chunk of my time. This was a lifesaver! Huge Thanks!

[lcaraballo0689]

hola

[KrzysztofMaciejewski]

Hi

how to use WebUI from latest changelog ?

` - #### ✨ New Features

- RustDesk Server: Add WebUI [@tremor021](https://github.com/tremor021) ([#4590](https://github.com/community-scripts/ProxmoxVE/pull/4590))`

[michelroegl-brunner]

Run a update, that should install it. Make sure to backup the container first though!

[JoaoMarques-Dev]

I tried running the update and I'm getting an error when it tries to stop rustdesk-api, which makes sense since that service doesn't exist.
Is it supposed to? I didn't see that being created on the installation. The file rustdesk-api.txt that the update also looks for doesn't exist as well.

My installation is only a few months old, like 3 or 4 max, was this added in the meantime?

[JoaoMarques-Dev]

apparently the updater works now

[JoaoMarques-Dev]

Something is still wrong though, there is supposed to be a config.yaml that doesn't exist.
Is anyone using the Admin Web UI that can confirm it works in this installation?
The rustdesk-api service now exists and is running, but the txt it was looking for before still doesn't exist so the updater always notes that, and then, while looking for the Admin password for the Web UI I tried running rustdesk-api to see if I could see the console logs since it seems that's where the password shows, and i got that error about config.yaml not existing.

[rkben]

fresh install works.

root@rustdeskserver:~# fdfind config.yaml /
/var/lib/rustdesk-api/conf/config.yaml

[BalakayA]

This install no longer seems to work. Getting errors saying curl not installed in the container which breaks the whole script.

[j03l]

I'm also having issues.

✔️ Updated Container OS
✔️ Core dependencies installed
⠏ Setup RustDesk
[ERROR] in line 51: exit code 0: while executing command "$@" > /dev/null 2>&1
curl: (22) The requested URL returned error: 400
/dev/fd/63: line 74: SPINNER_PID: unbound variable

[CN8VX]

Good evening, same problem for my installation:

⚙️ Using Default Settings on node servpx01
🖥️ Operating System: debian
🌟 Version: 12
📦 Container Type: Unprivileged
💾 Disk Size: 2 GB
🧠 CPU Cores: 1
🛠️ RAM Size: 512 MiB
🆔 Container ID: 112
🚀 Creating a RustDesk Server LXC using the above default settings

✔️ Using hd02 for Template Storage.
✔️ Using hd02 for Container Storage.
✔️ Updated LXC Template List
✔️ LXC Template is ready to use.
✔️ LXC Container 112 was successfully created.
✔️ Started LXC Container
✔️ Set up Container OS
✔️ Network Connected: 192.168.1.51
✔️ IPv4 Internet Connected
✖️ IPv6 Internet Not Connected
✔️ DNS Resolved github.com to 140.82.121.4
✔️ Updated Container OS
✔️ Core dependencies installed
⠴ Setup RustDesk
[ERROR] in line 51: exit code 0: while executing command "$@" > /dev/null 2>&1
curl: (22) The requested URL returned error: 400
/dev/fd/63: line 74: SPINNER_PID: unbound variable

[mdarrint]

Fresh install here, and default admin info (admin/test1234) does not work. Did I miss something in the docs?

[rkben]

Fresh install here, and default admin info (admin/test1234) does not work. Did I miss something in the docs?

Not sure where you got that default password. Linked is the instructions from rustdesk-api

https://github.com/lejianwen/rustdesk-api/blob/master/README_EN.md

[tomfrenzel]

@mdarrint You need to execute those two commands:

cd /var/lib/rustdesk-api/
rustdesk-api reset-admin-pwd YOURNEWPASSWORD

[jasgggit]

Thanks for the guide, but why has this setup some phrases in Chinese, and how can be changed?

ex:

👏👏👏 你好 admin， 欢迎使用 RustDesk API

Language setting is not doing it.
Thanks
JG

[tomfrenzel]

You can change that in the /var/lib/rustdesk-api/conf/admin/hello.html file 🙂