RustDesk Self-host Installation


Install your own server using a simple to run install script

Script is hosted on and supported on our Discord.

Currently the script will download and setup the Relay and Signal Servers (hbbr and hbbs), generate configs and host them on a password protected web page for simple deployment to clients.


You need to have linux installed, script is tested working with CentOS Linux 7/8, Ubuntu 18/20 and Debian. A server with 1 CPU, 1 GB and 10 GB disk is plenty to run RustDesk.

How to Install the server

Please setup your firewall on your server prior to running the script.

Make sure you have got access via ssh or otherwise setup prior setting up the firewall. The example commands for UFW (Debian based) are:


If you have UFW installed use the following commands to configure the firewall:


Run the following commands:


Install your own server with docker(-compose)


You need to have Docker/Podman installed to run a rustdesk-server as a docker container

Docker examples





--net=host only works on Linux, which makes  hbbs/ hbbr see the real incoming IP Address rather than the Container IP ( If  --net=host works fine, the  -p options are not used. If on Windows, leave out  sudo and  --net=host.

Please remove  --net=host if you are having connection problems on your platform.

Docker-Compose examples

For running the docker files with the docker-compose.yml as described here you need to have docker-compose installed.





Set up your own server instance without using Docker

STEP 1 : Download server-side software programs


Platform versions provided:

  • Linux
  • Windows

The tutorial below is based on Linux build.

There are two executables and a folder:

  • hbbs – RustDesk ID/Rendezvous server
  • hbbr – RustDesk relay server

They are built on CentOS Linux 7, tested on CentOS Linux 7/8 and Ubuntu 18/20.

Server Requirements

The hardware requirements are very low; the minimum configuration of a basic cloud server is enough, and the CPU and memory requirements are minimal. You can also use a Raspberry Pi or something similar. Regarding the network size, if the TCP hole punching direct connection fails, the relay traffic will be consumed. The traffic of a relay connection is between 30k-3M/s (1920×1080 screen) depending on the resolution settings and screen update. If it is only for office work demand, the traffic is around 100K/s.

STEP 2 : Run hbbs and hbbr on your server

Option 1

Run hbbs/hbbr on your server (CentOS or Ubuntu). We suggest you use pm2 for managing your service.


Option 2 – pm2

Run hbbs/hbbr with pm2


pm2 requires NodeJS v16+, if you fail to run pm2 (e.g. you can not see  hbbs/ hbbr in  pm2 list), please download and install the NodeJS LTS version from If you want to make  hbbs/ hbbr auto-run after reboot, please check out  pm2 save and  pm2 startup. More about pm2. Another good tool for your logs is pm2-logrotate.

The  -r parameter of  hbbs is not mandatory, it is just convenient for you not to specify a relay server on the controlled client side. You do not need to specify port if you are using default 21117 port. The relay server specified by the client has a higher priority than this.


By default,  hbbs listens on 21115 (TCP) and 21116 (TCP/UDP), 21118 (TCP), and  hbbr listens on 21117 (TCP), 21119 (TCP). Be sure to open these ports in the firewall. Please note that 21116 should be enabled both for TCP and UDP. 21115 is used for the NAT type test, 21116/UDP is used for the ID registration and heartbeat service, 21116/TCP is used for TCP hole punching and connection service, 21117 is used for the Relay services, and 21118 and 21119 are used to support web clients. If you do not need web client (21118, 21119) support, the corresponding ports can be disabled.

  • TCP (21115, 21116, 21117, 21118, 21119)
  • UDP (21116)

Please run with the  -h option to see help if you want to choose your own port.

--net=host only works on Linux, which makes  hbbs/ hbbr see the real incoming IP Address rather than the Container IP ( If  --net=host works fine, the  -p options are not used. If on Windows, leave out  sudo and  --net=host.

Please remove  --net=host if you are having connection problems on your platform.

STEP 3 : Set hbbs/hbbr address on client-side

Click on the Menu button [ ⋮ ] on the right side of ID as shown below, and choose “ID/Relay Server”.

Enter the  hbbs host or IP Address in the ID Server input box (local side + remote side). The other two addresses can be left blank, RustDesk will automatically deduce (if not specially set), and the Relay Server refers to  hbbr (port 21117).




Put config in rustdesk.exe file name (Windows only)

Change  rustdesk.exe to rustdesk- host=<host-ip-or-name>,key=<public-key-string>.exe, e.g. rustdesk- host=,key=xfdsfsd32=32.exe. You can see the config result in the About Window below.

You need to set both  host and  key, missing either one will not work.

If there are invalid characters in the key which can not be used in a Windows file name, please remove the  id_ed25519 file from your server and restart  hbbs/ hbbr. This will cause the file to regenerate. You may need to repeat this process until you get valid characters.


Menu About Page


Different from the old version, the key in this version is mandatory, but you don’t need to set it yourself. When  hbbs runs for the first time, it will automatically generate a pair of encrypted private and public keys (respectively located in the  id_ed25519 and files in the running directory), whose main purpose is for communication encryption.

If you did not fill in the  Key: (the content in the public key file in the previous step, it does not affect the connection, but the connection cannot be encrypted.


If you want to prohibit users without the key from establishing non-encrypted connections, please add the  -k _ parameter when running  hbbs and  hbbr, for example:


If you want to change the key, remove the  id_ed25519 and files and restart  hbbs/ hbbrhbbs will generate a new key pair.