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 show you how to install Homarr on your Synology NAS using Docker.

💡Note: This guide works perfectly with the latest Homarr v0.13.4 release.

💡Note: Check out my new guide on how to Install Homarr Using Portainer.

• STEP 1

Please Support My work by Making a Donation.

• STEP 2

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 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.

• STEP 4

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

• STEP 5

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

• STEP 6

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

1. General: In the Task field type in Install Homarr. Uncheck the “Enabled” option. Select root User.
2. Schedule: Select Run on the following date then select “Do not repeat“.
3. 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=homarr \
-p 4755:7575 \
-v /volume1/docker/homarr:/app/data/configs \
-v /volume1/docker/homarr/icons:/app/public/icons \
-v /var/run/docker.sock:/var/run/docker.sock \
-e PASSWORD=mariushosting \
-e EDIT_MODE_PASSWORD=mariusboosting \
-e DISABLE_EDIT_MODE=FALSE \
-e TZ=Europe/Bucharest \
--restart always \
ghcr.io/ajnart/homarr:latest

Note: Before you paste the code above in the Run command 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 Run command 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 Run command area below, change the value for TZ. (Select your current Time Zone from this list.)

• STEP 7

After you click OK on STEP 6 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 8

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

• 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.

• 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.

• STEP 12

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

• 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.

• STEP 14

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

• STEP 15

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

• 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.

• 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.

• STEP 18

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

• STEP 19

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

• 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.

• 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!

🆘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 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: Add Dash Monitors to Homarr Dashboard.
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 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 Sunday / September 17th, 2023 at 10:40 PM