Synology: Install Homarr With Portainer

by

Synology Install Homarr With Portainer

My previous guide for Homarr involved the use of Task Scheduler. Today I’m offering a recommended and excellent alternative for installing the latest Homarr version via Portainer. Homarr is a simple and lightweight homepage for your server that helps you easily access all of your services in one place. The thing I like most about Homarr is its speed and simplicity in adding links of your favorite docker apps. You can use it as a bookmark as well. Great integration with Plex, Sonarr, Radarr etc. Homarr supports multiple configs and persistent storage. In this step by step guide I will teach you how to install Homarr on your Synology NAS device using Docker & Portainer.

💡Note: This guide works perfectly with the latest Homarr v0.13.4 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 homarr. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Homarr Synology NAS Portainer Set up 1

  • STEP 4

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

Homarr Synology NAS Portainer Set up 1

  • STEP 5

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 6

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

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

version: "3.9"
services:
  homarr:
    container_name: Homarr
    image: ghcr.io/ajnart/homarr:latest
    mem_limit: 2g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    restart: on-failure:5
    ports:
      - 4755:7575
    volumes:
      - /volume1/docker/homarr:/app/data/configs:rw
      - /volume1/docker/homarr/icons:/app/public/icons:rw
      - /var/run/docker.sock:/var/run/docker.sock
    environment:
     PASSWORD: mariushosting
     EDIT_MODE_PASSWORD: mariusboosting
     DISABLE_EDIT_MODE: FALSE #or TRUE
     TZ: Europe/Bucharest

Note: Before you paste the code above in the Web editor area, change the value for PASSWORD and add your own password. mariushosting is an example for a password. You have to insert your own password. You will need this password later at STEP 10.
Note: Before you paste the code above in the Web editor area, change the value for EDIT_MODE_PASSWORD and add your own password. mariusboosting is an example for an edit mode password. You have to insert your own edit mode password.
Note: Before you paste the code above in the Web editor area below, change the value for TZ. (Select your current Time Zone from this list.)

Homarr Synology NAS Portainer Set up 3

  • STEP 7

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.

Homarr Synology NAS Portainer Set up 4

  • STEP 8

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

Homarr Synology NAS Portainer Set up 5

  • STEP 9

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

  • STEP 10

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:4755 Type in your own PASSWORD that you have previously chosen at STEP 6. Click Sign in. Follow the instructions in the image below.

Homarr Synology NAS Portainer Set up 6

  • STEP 11

At the top right of the page click on the three horizontal lines. Switch to Dark Mode then click Settings. Follow the instructions in the image below.

Homarr Synology NAS Portainer Set up 7

  • STEP 12

Click on the Customization tab then Layout. Check Enable docker integration. Follow the instructions in the image below.

Homarr Synology NAS Portainer Set up 8

  • STEP 13

Click on Page Metadata. You can add your own page title. You can add an URL to your own logo and favicon. You can change your meta title description. Follow the instructions in the image below.

Homarr Synology NAS Portainer Set up 9

  • STEP 14

Click on Appearance. You can add an URL to your own background image. Follow the instructions in the image below.

Homarr Synology NAS Portainer Set up 10

  • STEP 15

At the top right of the page click on the Docker icon. Follow the instructions in the image below.

Homarr Synology NAS Portainer Set up 11

  • STEP 16

Select a Docker container, then click the + Add to Homarr button to add the selected container to your Homarr dashboard. Follow the instructions in the image below.

Homarr Synology NAS Portainer Set up 12

  • STEP 17

Go to Appearance then type in the name of your app. From the list, select an icon for your Docker app. Click Save. Follow the instructions in the image below.

Homarr Synology NAS Portainer Set up 13

  • STEP 18

At the top right of the page click on the Edit mode icon. Follow the instructions in the image below.

Homarr Synology NAS Portainer Set up 14

  • STEP 19

Select your current app, then click the gear icon to edit it. Click Edit. Follow the instructions in the image below.

Homarr Synology NAS Portainer Set up 15

  • STEP 20

Click the General tab, then type in the address link of your favorite application. Click Save. Follow the instructions in the image below.

Homarr Synology NAS Portainer Set up 16

  • STEP 21

At the top right of the page click on the Edit mode icon to save your dashboard settings. Follow the instructions in the image below.

  • STEP 22

Your Homarr dashboard at a glance!

Homarr Synology NAS Portainer Set up 17

Enjoy Homarr!

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

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: Find out how to update the Homarr container with the latest image.
Note: How to Add USB Support on DSM 7.2.
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 Tuesday / September 26th, 2023 at 2:26 AM

🧡 I Need Your Help!