How to Install Umbrel OS on Your Synology NAS

by

How to Install Umbrel OS on Your Synology NAS

Umbrel OS is a beautiful home server OS for self-hosting with an app store. Umbrel OS is the operating system of Umbrel Bitcoin and Lightning node. It’s based on Raspberry Pi OS (formerly Raspbian) and uses pi-gen for customization. In this step by step guide I will show you how to install Umbrel OS on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Umbrel OS v1.2.2 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

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

Umbrel OS Synology NAS Set up 1

  • STEP 4

Now create two new folders inside the umbrel folder that you have previously created at STEP 3 and name them app-data and tor. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Umbrel OS Synology NAS Set up 2

  • STEP 5

Now create one new folder inside the tor folder that you have previously created at STEP 4 and name it data. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Umbrel OS Synology NAS Set up 3

  • STEP 6

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.

1 Synology Portainer Add Stack

  • STEP 7

In the Name field type in umbrel. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

services:
  umbrel:
    image: dockurr/umbrel
    container_name: Umbrel-OS
    healthcheck:
       test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/80' || exit 1
       interval: 10s
       timeout: 5s
       retries: 3
       start_period: 90s
    ports:
      - 3253:80
    volumes:
      - /volume1/docker/umbrel:/data:rw
      - /var/run/docker.sock:/var/run/docker.sock
    restart: on-failure:5

Umbrel OS Synology NAS Set up 4

  • STEP 8

Scroll down on the page until you see a button called 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.

Umbrel OS Synology NAS Set up 5

  • STEP 9

If everything goes right, you will see this message at the top right of your screen: “Success Stack successfully deployed“.

Umbrel OS Synology NAS Set up 6

  • STEP 10

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

  • STEP 11

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 http://Synology-ip-address:3253 Click Start. Follow the instructions in the image below.

Umbrel OS Synology NAS Set up 7

  • STEP 12

Type in your own details, then click Create. Follow the instructions in the image below.

Umbrel OS Synology NAS Set up 8

  • STEP 13

Click Next. Follow the instructions in the image below.

Umbrel OS Synology NAS Set up 9

  • STEP 14

Select an app that you like. Follow the instructions in the image below.

Umbrel OS Synology NAS Set up 10

  • STEP 15

Install the app. Follow the instructions in the image below.

Umbrel OS Synology NAS Set up 11

  • STEP 16

Open the app. Follow the instructions in the image below.

Umbrel OS Synology NAS Set up 12

Enjoy Umbrel OS!

🆘TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article.

Note: If you want to run the Umbrel OS container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make Umbrel OS work via HTTPS, it’s mandatory to activate WebSocket.

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the Umbrel OS container with the latest image.
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 Monday / October 14th, 2024 at 11:47 PM

🧡 I Need Your Help!