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

EDIT: RustDesk Server: Add WebUI we added the custom WebUI by @lejianwen to the installation script, so the users can configure the server more easily, as opposed to using the CLI tools.

Anyway, you will need the container IP and above mentioned public key. Insert those in the RustDesk client here:

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.

[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

[mdarrint]

@mdarrint You need to execute those two commands:

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

Much thanks. Had to travel for work. Back, and tackling this solution.

UPDATE: worked just fine. All set!

[ichbinsteffen]

@mdarrint You need to execute those two commands:

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

Much thanks. Had to travel for work. Back, and tackling this solution.

UPDATE: worked just fine. All set!

Wow. This information here looks like its very necessary and also buried in some random discussion thread.

I installed rustdesk from the proxmox helper scripts, and I couldnt get going without this password reset, because the credentials from rustdesk.creds wouldnt work.

[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 🙂

[sterret18]

Hi ! How to set password for all user connection please ?

[kai-syl]

Hello, does this installation come with custom OIDC integration, such as Authentik? I get a 404 error when my IDP redirects to https://domain.com/api/oidc/callback

[QuigonJohnn]

Did you ever figure this out? I'm having the same issue now.
It won't let me change the callback URL in the web admin. The callback only works if I let it first try to redirect to the default 127.0.0.1:21114 address and then manually replace the the ip:port in the adress bar wth my domain. But if I set the callback to the same thing with the domain within my OIDC provider, it never works.

[tomfrenzel]

It works for me using caddy + PocketID.
The are the important parts of my rustdesk-api config (/opt/rustdesk-api/conf/config.yaml):

app:
  web-client: 1  # 1:启用 0:禁用
  register: false #是否开启注册
  register-status: 1 # 注册用户默认状态 1:启用 2:禁用
  captcha-threshold: 3 #   <0:disabled, 0 always, >0:enabled
  ban-threshold: 0 # 0:disabled, >0:enabled
  show-swagger: 0 # 1:启用 0:禁用
  token-expire: 168h
  web-sso: true #web auth sso
  disable-pwd-login: false #禁用密码登录

admin:
  title: "RustDesk API Admin"
  hello-file: "./conf/admin/hello.html"  #优先使用file
  hello: ""
  # ID Server and Relay Server ports https://github.com/lejianwen/rustdesk-api/issues/257
  id-server-port: 21116  # ID Server port (for server cmd)
  relay-server-port: 21117 # ID Server port (for server cmd)

rustdesk:
  id-server: "mydomain.dev:21116"
  relay-server: "mydomain.dev:21117"
  api-server: "https://rustdesk.mydomain.dev"
  key: "xxx"
  key-file: "/data/id_ed25519.pub"
  personal: 1
  webclient-magic-queryonline: 0
  ws-host: "wss://rustdesk.mydomain.dev"  #eg: wss://192.168.1.3:4443

Note that i reach the Web Interface trough https://rustdesk.mydomain.dev and not https://mydomain.dev. I think the last update of rustdesk-api changed some subdomain handling which forced me to remove the "rustdesk." subsobains from the id and relays server settings.

Also here is my caddy config:

rustdesk.mydomain.dev {
        reverse_proxy /api/* rustdesk.internal:21114
        reverse_proxy /* rustdesk.internal:21114
        reverse_proxy /ws/id rustdesk.internal:21118 {
                transport http {
                        versions 1.1
                }
        }
        reverse_proxy /ws/relay rustdesk.internal:21119 {
                transport http {
                        versions 1.1
                }
        }
}

The redirect URL which i set in ProcketID is: https://rustdesk.mydomain.dev/api/oidc/callback
PKCE is also enabled.

I hope this helps 😄

[manulpz]

Hello.

When I log in from the application with the web API credentials, it takes a long time to connect the clients, but if I disconnect from the app, it is instantaneous.

Any idea why this happens?

thanks.

[lejianwen]

The open-source version of the server will have this issue, specifically refer to #92

[agarmoli]

Have you found the solution? I have been trying several alternatives, but none of them have worked.

[MondoBoricua]

Have you found the solution? I have been trying several alternatives, but none of them have worked.

The only solution I found was to create a Docker LXC container and use the Docker version without the WebUI.

[jesmasco-crypto]

Can confirm, as of today, this keeps happening.

[javito1081]

any updates on this? any solution?

[nordscan]

Hello, maybe add the rustdesk generator to the lxc??

https://github.com/sebaxakerhtc/rdgen/blob/master/setup.md

[DO4SKE]

Ich würde gerne wissen, wo ich die src/peer.rs finde. Falls es die gibt. Da konnte ich auf einem anderen System sehen, welche ID sich zuletzt mit meinem Server verbunden hatte. Also zu welcher ID zuletzt eine Verbindung aufgebaut wurde. Es wurde also nicht angezeigt von welcher ID zu welcher ID die Verbindung ging. Sondern nur, zu welcher es ging. Und das würde ich gerne wieder sehen.

[DO4SKE]

Dieser Screenshot ist von einem anderen System. Aber so würde ich es gerne wieder sehen. Nur diesmal halt im Proxmox-Container.

[jeremymaio26-hub]

I have configured the RustDesk API config.yaml file by adding the relay-servers and always-use-relay parameters as indicated in the official documentation. I also mounted the configuration folder into the container via Docker Compose, but despite several restarts, these parameters do not seem to be taken into account by the server. I checked the logs, there is no error, but there is also no message indicating that the configuration has been loaded. I tried with environment variables, but the result is the same. Moreover, through the admin panel, it is possible to modify these parameters, but when the container is restarted, they are reset. Could you please indicate if these parameters are supported by the current version of the RustDesk API server, or if there is another way to apply them persistently ?

[dw5]

as it's always the case with lack of documentation bits on the helper script page itself (like instead they rather always link to some external page, never on the page itself for quick to know facts, whats where, or how to start using it) here's quick start guide, especially for those who picked alpine one:

public key is in /opt/rustdesk-server, just do cat id_ed25519.pub ; echo

how to use clients:
id server: yourip
relay server: yourip
api server: http://yourip:21114
key: public key (optional)

in account tab (or web ui login)
username admin
and to see the password do cat ~/rustdesk.creds

[javito1081]

as it's always the case with lack of documentation bits on the helper script page itself (like instead they rather always link to some external page, never on the page itself for quick to know facts, whats where, or how to start using it) here's quick start guide, especially for those who picked alpine one:

public key is in /opt/rustdesk-server, just do cat id_ed25519.pub ; echo

how to use clients: id server: yourip relay server: yourip api server: http://yourip:21114 key: public key (optional)

in account tab (or web ui login) username admin and to see the password do cat ~/rustdesk.creds

I got this place looking for the same answers as you once were, hope u can help me solve the ones i have.

First question is, do i have to change the values on the config.yaml? and if i do which ones, cause i asume i have to change these for example:

rustdesk:
id-server: "192.168.1.66:21116"
relay-server: "192.168.1.66:21117"
api-server: "http://127.0.0.1:21114"
key: ""
key-file: "/data/id_ed25519.pub"
personal: 1
webclient-magic-queryonline: 0
ws-host: "" #eg: wss://192.168.1.3:4443

asuming i do and that my rustdesk server ip is 10.0.0.50, i have to replace the ip for my own on every field correct? also change the key and key-file values for the values on the key that is stored on /var/lib/rustdesk-server/id_ed25519.pub cause thats the default instalation for the rustdesk server on this script

My second question asuming i dont have to change anything else and after restarting the lxc, is the one u already answer which i asume is adding the data of my server to my client after exposing al the proper ports mentioned in the script guide

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)

in the order u mention in ur post and after that i log in with the user i had previously created on the admin console?

Update: im posting a full guide once you or anyone confirm that this is all i have to modify, i just modify everything i said and its aparently working without issues, but i wanna make sure everything is correct so i dont confuse anyone

Update2: aparently everything works but the Web client for which i get a 404 page when i try to open it, i was reading a bit but since its in chinese and i dont have experience with npm i have no idea how to implement it, so if u did please let me know

Update3: if im logged in into my account, i cant connect to any of my clients because i get:

and the only way to connect is if i do id@server?key=secretkey, so im still trying to figure out whats going on, also if i logout of my account and try to connect using just the id, works perfectly

[ksdnsk]

The same problem as mentioned in update3 above

[javito1081]

The same problem as mentioned in update3 above

aparently the issue is only with the source version, which is the one that uses this script, with the docker version everything works fine, even the webclient, i had to switch to that until we get an answer :-(

[lindstrm]

Having this problem aswell.

[javito1081]

To keep the lxc per say, i installed a docker lxc from this

https://community-scripts.github.io/ProxmoxVE/scripts?id=docker

then installed the rustdesk docker version from the rustdesk-api developer from here

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

this is my docker file

networks:
  rustdesk-net:
    external: false
services:
  rustdesk:
    ports:
      - 21114:21114
      - 21115:21115
      - 21116:21116
      - 21116:21116/udp
      - 21117:21117
      - 21118:21118
      - 21119:21119
    image: lejianwen/rustdesk-server-s6:latest
    environment:
      - RELAY=http://**your-ip**:21117
      - ENCRYPTED_ONLY=1
      - MUST_LOGIN=N
      - TZ=America/Mexico_City #This can be changed for ur timezone
      - RUSTDESK_API_RUSTDESK_ID_SERVER=http://**your-ip**:21116
      - RUSTDESK_API_RUSTDESK_RELAY_SERVER=http://**your-ip**:21117
      - RUSTDESK_API_RUSTDESK_API_SERVER=http://**your-ip**:21114
      - RUSTDESK_API_RUSTDESK_WS_HOST=http://**your-ip**:21114
      - RUSTDESK_API_KEY_FILE=/data/id_ed25519.pub
      - RUSTDESK_API_JWT_KEY=**your-key-from-id_ed25519.pub-file**
    volumes:
      - /data/rustdesk/server:/data
      - /data/rustdesk/api:/app/data
    networks:
      - rustdesk-net
    restart: unless-stopped

Everything works without issues, even the webplayer hehe