RustDesk is a remote desktop software, the open source TeamViewer alternative, works out of the box, no configuration required. You have full control of your data, with no concerns about security. You can use a public rendezvous/relay server or self-hosting, or write your own server. In this step by step guide I will show you how to install RustDesk on your Synology NAS using Docker and Portainer.
This guide works perfectly with the latest RustDesk Client 1.3.2 and RustDesk Server 1.1.12 release.
STEP 1
Please Support My work by Making a Donation.
STEP 2
Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.
STEP 3
Enable synology.me DDNS. If you already have a synology.me DDNS, skip this STEP.
STEP 4
Log in to your router. Find the Port Forwarding area. At the moment I am using an RT6600ax Synology router. Remember that every router has its own interface design. Be sure to open the necessary ports through your router settings, both TCP/UDP. If the ports that point to your Synology NAS device are not opened, all the services you have activated on those specific ports will not work. All you need to do is give your Synology device permissions on ports 21115, 21116, 21117, 21118, 21119, both TCP and UDP, then apply the settings. Follow the instructions in the image below. Note: ports 21115, 21116, 21117, 21118, 21119 are the essential ports to make RustDesk work.
STEP 5
Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.
STEP 6
Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.
STEP 7
Go to File Station and open the docker folder. Inside the docker folder, create two new folder and name them rustdeskhbbr and rustdeskhbbs. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.
STEP 8
Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.
STEP 9
In the Name field type in rustdesk. Follow the instructions in the image below.
version: '3.9'
networks:
rustdesk-net:
external: false
services:
hbbs:
container_name: HBBS
ports:
- 21115:21115
- 21116:21116
- 21116:21116/udp
- 21118:21118
image: rustdesk/rustdesk-server
command: hbbs -r yourname.synology.me:21117
volumes:
- /volume1/docker/rustdeskhbbs:/root:rw
networks:
- rustdesk-net
depends_on:
- hbbr
restart: on-failure:5
hbbr:
container_name: HBBR
ports:
- 21117:21117
- 21119:21119
image: rustdesk/rustdesk-server
command: hbbr
volumes:
- /volume1/docker/rustdeskhbbr:/root:rw
networks:
- rustdesk-net
restart: on-failure:5
Note: Before you paste the code above in the Web editor area, add your own synology.me DDNS that you have previously created at STEP 3 followed by :21117
STEP 10
Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.
STEP 11
If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.
STEP 12
Click to open your rustdeskhbbs folder that you have previously created at STEP 7. Follow the instructions in the image below.
STEP 13
Right click on the PUB File then click Download. follow the instructions in the image below.
STEP 14
Download the RustDesk software for your computer from the official RustDesk website for Windows | Ubuntu | Mac | AppImage | Flatpak. Once you have installed it, open it, then click the 3 dots on the left sidebar. Follow the instructions in the image below.
STEP 15
After you click on the 3 dots at STEP 14, a new window will open. On the left sidebar click Network. On the ID Server area type in your own synology.me DDNS that you have previously created at STEP 3 and added at STEP 9. With notepad, open the PUB file that you have previously downloaded at STEP 13; inside this will you will find your own KEY. Copy the key in the Rustdesk client Key Area, then click Apply. Follow the instructions in the image below.
STEP 16
On the left sidebar, click General then Start. Choose your favorite theme color. Follow the instructions in the image below.
STEP 17
Once you go back to Home, you should see a “Ready” green dot statement in the RustDesk application.
STEP 18
When someone wants to connect to your computer, you only need to provide them with your RustDesk ID. After they enter your RustDesk Remote ID and proceed to Connect, you will get a pop-up; click Accept and Elevate to give them permission to connect.
Enjoy RustDesk!
If you encounter issues by using this container, make sure to check out the Common Docker issues article.
Note: Make sure RULE 5 and RULE 6 is correctly applied on your Synology NAS Firewall configuration.
Note: Find out how to update the RustDesk container with the latest image.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.
This post was updated on Thursday / October 31st, 2024 at 1:57 AM