doc.rustdesk.com/content/self-host/rustdesk-server-oss/synology/_index.en.md

---
title: Synology
weight: 22
---

> An alterative up-to-date tutorial from third-party is [here](https://mariushosting.com/how-to-install-rustdesk-on-your-synology-nas/).

This tutorial is based on latest DSM v6 and v7.

### Install Docker

| Open Package Center | Install Docker |
| --- | --- |
| ![](/docs/en/self-host/rustdesk-server-oss/synology/images/package-manager.png) | ![](/docs/en/self-host/rustdesk-server-oss/synology/images/docker.png) |

### Install RustDesk Server

| Search rustdesk-server in Docker's registry and install by double click | Installed rustdesk-server image, double click to create rustdesk-server container |
| --- | --- |
| ![](/docs/en/self-host/rustdesk-server-oss/synology/images/pull-rustdesk-server.png) | ![](/docs/en/self-host/rustdesk-server-oss/synology/images/rustdesk-server-installed.png) |

### Create hbbs container

As mentioned above, double click on rustdesk-server image to create new container, set it name to `hbbs`.
![](/docs/en/self-host/rustdesk-server-oss/synology/images/hbbs.png)

Click on above `Advanced Settings`.

- Enable auto-restart
![](/docs/en/self-host/rustdesk-server-oss/synology/images/auto-restart.png)

- Enable `Use the same network as Docker Host`, for more about host net, please [check](/docs/en/self-host/rustdesk-server-oss/docker/#net-host).
![](/docs/en/self-host/rustdesk-server-oss/synology/images/host-net.png)

- Mount a host directory (e.g. `/home/rustdesk/`) to `/root`, hbbs will generate some files (database and `key` files) in this directory which need to be persistent over reboots.

| Mount | Files generated in the host directory |
| --- | --- |
| ![](/docs/en/self-host/rustdesk-server-oss/synology/images/mount.png) | ![](/docs/en/self-host/rustdesk-server-oss/synology/images/mounted-dir.png) |

- Set command
{{% notice note %}}
Synology's OS is Debian based, so host net (--net=host) works fine, we do not need to map ports with `-p` option.

`192.168.16.98` is an internal IP used here for demonstration only, please set it to a public IP when you deploy (or you can use your DDNS address if you have configured one in "Control Panel -> Connectivity -> DDNS") and don't forget to open ports on your router and your Synology firewall if this is enabled ("Control Panel -> Connectivity -> Firewall")!

{{% /notice %}}

![](/docs/en/self-host/rustdesk-server-oss/synology/images/hbbs-cmd.png?v2)

- Done

![](/docs/en/self-host/rustdesk-server-oss/synology/images/hbbs-config.png)

### Create hbbr container

Please repeat above `hbbs` steps, but name the container `hbbr` and command (for Set Command Step) should be `hbbr -k _`.

![](/docs/en/self-host/rustdesk-server-oss/synology/images/hbbr-config.png)

### hbbr/hbbs containers

![](/docs/en/self-host/rustdesk-server-oss/synology/images/containers.png)


| Double click on container and check log | Double confirm hbbs/hbbr using host network |
| --- | --- |
| ![](/docs/en/self-host/rustdesk-server-oss/synology/images/log.png) | ![](/docs/en/self-host/rustdesk-server-oss/synology/images/network-types.png) |

### Retrieve your Key

Browse to the folder setup before using File Station, download `id_ed25519.pub` and open with a text editor to via your key.
synogy 2022-04-20 21:36:57 +02:00			`---`
Fixed typos in Synology chapter. Suggesting to fix catalog structures 2022-05-06 12:23:31 +02:00			`title: Synology`
synogy 2022-04-20 21:36:57 +02:00			`weight: 22`
			`---`

Update _index.en.md 2023-08-27 20:57:17 +02:00			`> An alterative up-to-date tutorial from third-party is [here](https://mariushosting.com/how-to-install-rustdesk-on-your-synology-nas/).`
Update _index.en.md 2023-07-27 08:08:16 +02:00
Update _index.en.md 2023-07-22 23:36:10 +02:00			`This tutorial is based on latest DSM v6 and v7.`
synogy 2022-04-20 21:36:57 +02:00
			`### Install Docker`

Update _index.en.md 2023-08-31 22:00:34 +02:00			`\| Open Package Center \| Install Docker \|`
Update _index.en.md 2023-08-27 20:57:17 +02:00			`\| --- \| --- \|`
fix images in tr 2023-08-25 15:36:48 +02:00			`\| ![](/docs/en/self-host/rustdesk-server-oss/synology/images/package-manager.png) \| ![](/docs/en/self-host/rustdesk-server-oss/synology/images/docker.png) \|`
synogy 2022-04-20 21:36:57 +02:00
			`### Install RustDesk Server`

Update _index.en.md 2023-07-15 22:07:38 +02:00			`\| Search rustdesk-server in Docker's registry and install by double click \| Installed rustdesk-server image, double click to create rustdesk-server container \|`
Update _index.en.md 2023-08-27 20:57:17 +02:00			`\| --- \| --- \|`
fix images in tr 2023-08-25 15:36:48 +02:00			`\| ![](/docs/en/self-host/rustdesk-server-oss/synology/images/pull-rustdesk-server.png) \| ![](/docs/en/self-host/rustdesk-server-oss/synology/images/rustdesk-server-installed.png) \|`
synogy 2022-04-20 21:36:57 +02:00
			`### Create hbbs container`

			As mentioned above, double click on rustdesk-server image to create new container, set it name to `hbbs`.
fix images in tr 2023-08-25 15:36:48 +02:00			`![](/docs/en/self-host/rustdesk-server-oss/synology/images/hbbs.png)`
synogy 2022-04-20 21:36:57 +02:00
Update _index.en.md 2023-09-05 00:07:17 +02:00			Click on above `Advanced Settings`.
synogy 2022-04-20 21:36:57 +02:00
			`- Enable auto-restart`
fix images in tr 2023-08-25 15:36:48 +02:00			`![](/docs/en/self-host/rustdesk-server-oss/synology/images/auto-restart.png)`
synogy 2022-04-20 21:36:57 +02:00
Update _index.en.md 2023-09-05 00:07:17 +02:00			- Enable `Use the same network as Docker Host`, for more about host net, please [check](/docs/en/self-host/rustdesk-server-oss/docker/#net-host).
fix images in tr 2023-08-25 15:36:48 +02:00			`![](/docs/en/self-host/rustdesk-server-oss/synology/images/host-net.png)`
synogy 2022-04-20 21:36:57 +02:00
Update _index.en.md 2023-07-22 23:36:10 +02:00			- Mount a host directory (e.g. `/home/rustdesk/`) to `/root`, hbbs will generate some files (database and `key` files) in this directory which need to be persistent over reboots.
Update _index.en.md 2023-08-27 20:57:17 +02:00
synogy 2022-04-20 21:36:57 +02:00			`\| Mount \| Files generated in the host directory \|`
Update _index.en.md 2023-08-27 20:57:17 +02:00			`\| --- \| --- \|`
Update _index.en.md 2023-09-13 23:24:23 +02:00			`\| ![](/docs/en/self-host/rustdesk-server-oss/synology/images/mount.png) \| ![](/docs/en/self-host/rustdesk-server-oss/synology/images/mounted-dir.png) \|`
synogy 2022-04-20 21:36:57 +02:00
			`- Set command`
			`{{% notice note %}}`
Update _index.en.md 2023-01-16 19:48:27 +01:00			Synology's OS is Debian based, so host net (--net=host) works fine, we do not need to map ports with `-p` option.
synogy 2022-04-20 21:36:57 +02:00
Update _index.en.md 2023-08-27 20:57:17 +02:00			`192.168.16.98` is an internal IP used here for demonstration only, please set it to a public IP when you deploy (or you can use your DDNS address if you have configured one in "Control Panel -> Connectivity -> DDNS") and don't forget to open ports on your router and your Synology firewall if this is enabled ("Control Panel -> Connectivity -> Firewall")!
synogy 2022-04-20 21:36:57 +02:00
			`{{% /notice %}}`

fix images in tr 2023-08-25 15:36:48 +02:00			`![](/docs/en/self-host/rustdesk-server-oss/synology/images/hbbs-cmd.png?v2)`
synogy 2022-04-20 21:36:57 +02:00
			`- Done`
Update _index.en.md 2023-07-15 22:07:38 +02:00
fix images in tr 2023-08-25 15:36:48 +02:00			`![](/docs/en/self-host/rustdesk-server-oss/synology/images/hbbs-config.png)`
synogy 2022-04-20 21:36:57 +02:00
			`### Create hbbr container`

Update _index.en.md 2023-07-22 23:36:10 +02:00			Please repeat above `hbbs` steps, but name the container `hbbr` and command (for Set Command Step) should be `hbbr -k _`.
synogy 2022-04-20 21:36:57 +02:00
fix images in tr 2023-08-25 15:36:48 +02:00			`![](/docs/en/self-host/rustdesk-server-oss/synology/images/hbbr-config.png)`
synogy 2022-04-20 21:36:57 +02:00
			`### hbbr/hbbs containers`

Update _index.en.md 2023-09-13 23:24:23 +02:00			`![](/docs/en/self-host/rustdesk-server-oss/synology/images/containers.png)`
synogy 2022-04-20 21:36:57 +02:00

			`\| Double click on container and check log \| Double confirm hbbs/hbbr using host network \|`
Update _index.en.md 2023-08-27 20:57:17 +02:00			`\| --- \| --- \|`
Update _index.en.md 2023-09-13 23:24:23 +02:00			`\| ![](/docs/en/self-host/rustdesk-server-oss/synology/images/log.png) \| ![](/docs/en/self-host/rustdesk-server-oss/synology/images/network-types.png) \|`
Update _index.en.md 2023-07-22 23:36:10 +02:00
			`### Retrieve your Key`

Update _index.en.md 2023-08-27 20:57:17 +02:00			Browse to the folder setup before using File Station, download `id_ed25519.pub` and open with a text editor to via your key.