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. It has great integration with Plex, Sonarr, Radarr, Pi-hole etc. Homarr supports multiple configs and persistent storage. In this step by step guide I will teach you how to install Homarr on your UGREEN NAS device using Docker & Portainer.

💡Note: This guide works perfectly with the latest Homarr v1.3.1 release.

💡Note: Check out my new guide on how to Install Homarr on Your Synology NAS.

• 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 UGREEN NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

• STEP 3

⚠️Mandatory Add Read & Write Permissions to the Docker Folder. If you have already added the Read and Write Permissions to the Docker Folder, skip this STEP.

• STEP 4

Go to File Manager 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 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.

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

services:
  homarr:
    container_name: Homarr
    image: ghcr.io/homarr-labs/homarr:latest
    healthcheck:
      test: ["CMD-SHELL", "nc -z 127.0.0.1 7575 || exit 1"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - /volume1/docker/homarr:/appdata:rw
    environment:
       SECRET_ENCRYPTION_KEY: E0AF06FF6D1FA23AE02C026DD4B5D177EEC497E20B74B0AEF8816366CD96E004
    ports:
      - 7575:7575
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value for SECRET_ENCRYPTION_KEY. Generate your own 64 Digit Hex Code for free.

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

• STEP 8

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

• STEP 9

🟢Please Support My work by Making a Donation. Almost 99,9% of the people that install something using my guides forget to support my work, or just ignore STEP 1. I’ve been very honest about this aspect of my work since the beginning: I don’t run any ADS, I don’t require subscriptions, paid or otherwise, I don’t collect IPs, emails, and I don’t have any referral links from Amazon or other merchants. I also don’t have any POP-UPs or COOKIES. I have repeatedly been told over the years how much I have contributed to the community. It’s something I love doing and have been honest about my passion since the beginning. But I also Need The Community to Support me Back to be able to continue doing this work.

• 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://ugreen-ip-address:7575 Choose your Favorite Language and the Theme Skin. Click Start from scratch to start a fresh new Homarr installation or import your settings from Homarr before the 1.0 version. In the guide below I have Started from scratch. Follow the instructions in the image below.

• STEP 11

Type in your own Username and Password, then click Create user. Follow the instructions in the image below.

• STEP 12

Adjust your Analytics, Crawling, and Indexing preferences, then click Continue. Follow the instructions in the image below.

• STEP 13

Click Create your first board. Follow the instructions in the image below.

• STEP 14

You will be prompted to add your own Username and Password that you have previously created at STEP 11. Click Login. Follow the instructions in the image below.

• STEP 15

Your management dashboard at a glance! On the left sidebar, click Boards to create your first dashboard. Follow the instructions in the image below.

• STEP 16

Create your first board!

Enjoy Homarr on your UGREEN NAS!

🆘TROUBLESHOOTING

Note: If you want to run the Homarr container over HTTPS, check out How to Run Docker Containers Over HTTPS on Your UGREEN NAS.

This post was updated on Wednesday / January 29th, 2025 at 1:14 AM