How to Install Rancher on Your Synology NAS

Rancher is a complete software stack for teams adopting containers. It addresses the operational and security challenges of managing multiple Kubernetes clusters across any infrastructure, while providing DevOps teams with integrated tools for running containerized workloads. In this step by step guide I will show you how to install Rancher on your Synology NAS using Docker.

💡Note: This guide works perfectly with the latest RANCHER v2.7.3 release.

STEP 1

Please Support My work by Making a Donation.

STEP 2A

Install Container Manager via Synology “Package Center”. If you run an older DSM version (under 7.2), search for Docker instead of Container Manager.

STEP 2B

Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it rancher. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

STEP 3

Go to Control Panel / Task Scheduler / Create / Scheduled Task / User-defined script. Follow the instructions in the image below.

STEP 4

Once you click on User-defined script a new window will open. Follow the instructions below:

General: In the Task field type in Install Rancher. Uncheck the “Enabled” option. Select root User.
Schedule: Select Run on the following date then select “Do not repeat“.
Task Settings: Check “Send run details by email“, add your email then copy paste the code below in the Run command area. After that click OK.

docker run -d --name=rancher \
-p 8064:80 \
-p 5443:443 \
-e CATTLE_BOOTSTRAP_PASSWORD=mariushosting \
-v /volume1/docker/rancher:/var/lib/rancher \
--privileged \
--restart always \
rancher/rancher

Note: Before you paste the code above in the Run command area, change the value for CATTLE_BOOTSTRAP_PASSWORD and add your own password.
Note: mariushosting is an example of a password. You have to insert your own password.

STEP 5

After you click OK on STEP 4 a new warning pop up window will open. Click OK.

After you click OK, type in your DSM Password then click Submit. Follow the instructions in the image below.

STEP 6

After you click Submit on STEP 5, select your “Install Rancher” Task then click the “Run” tab. You will be asked to run Install Rancher – click OK. Follow the instructions in the image below.

STEP 7

Make sure you have a synology.me Wildcard Certificate. Follow my guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.

STEP 8

Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.

STEP 9

Now click the “Create” button. Follow the instructions in the image below.

STEP 10

After you click the Create button, the window below will open. Follow the instructions in the image below.

On the General area, set the Reverse Proxy Name description: type in Rancher. After that, add the following instructions:

Source:
Protocol: HTTPS
Hostname: rancher.yourname.synology.me
Port: 443

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 8064

STEP 11

Activate WebSocket. Go to Control Panel / Login Portal / select your Reverse Proxy then click the Custom Header tab. Click Create and then, from the drop-down menu, click on WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. Click Save. Follow the instructions in the image below.

STEP 12

Go back to STEP 1 or you will deal with karma 🙂

STEP 13

The installation process can take up to a few seconds/minutes. It will depend on your Internet speed connection. Now open your browser and type in https://rancher.yourname.synology.me Add your own Password which you have chosen at STEP 4. Click Log in. Follow the instructions in the image below.