How to Install Home Gallery on Your Synology NAS

by

How to Install Home Gallery on Your Synology NAS

Home Gallery is a self-hosted, open-source web gallery to browse personal photos and videos featuring tagging, mobile-friendly, and AI powered image and face discovery. In this step by step guide I will show you how to install Home Gallery on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Home Gallery v1.15.0  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 home-gallery. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Home Gallery Server Synology NAS Set up 1

  • STEP 4

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

Home Gallery Server Synology NAS Set up 2

  • STEP 5

Download (click on the blue link below) then upload the gallery.config.yml file below in the home-gallery folder that you have previously created at STEP 3. Follow the instructions in the image below. 🔒Note: Support my work to unlock the password. You can use this password to download any file on mariushosting forever!

👉🏻gallery.config.yml

Home Gallery Server Synology NAS Set up 3

  • STEP 6

Populate your media folder that you have previously created at STEP 4 with your photos and videos.

  • STEP 7

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 8

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

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

version: "3.9"
services:
  api:
    image: xemle/home-gallery-api-server:latest
    container_name: HomeGallery-API
    hostname: homegallery-api
    mem_limit: 8g
    cpu_shares: 2048
    security_opt:
      - no-new-privileges:false
    environment:
#       TensorflowJS backends
#       cpu  -> slowest and best support
#       wasm -> good performance for arm64 and amd64 platforms
#       node -> best performance on amd64 platform
#      BACKEND: cpu
        BACKEND: wasm
#      BACKEND: node
    restart: on-failure:5

  gallery:
    image: xemle/home-gallery:latest
    entrypoint: ['node', '/app/gallery.js']
    command: ['run', 'server']
    container_name: HomeGallery
    hostname: homegallery 
    mem_limit: 8g
    cpu_shares: 2048
    security_opt:
      - no-new-privileges:false
    healthcheck:
      test: wget --no-verbose --tries=1 --spider http://localhost:3000
    ports:
      - 3179:3000
    volumes:
      - /volume1/docker/home-gallery/data:/data:rw
      - /volume1/docker/home-gallery/media:/media:ro
      - /volume1/docker/home-gallery/gallery.config.yml:/data/config/gallery.config.yml:ro
    environment:
      GALLERY_API_SERVER: http://homegallery-api:3000
      GALLERY_OPEN_BROWSER: false #or true
      GALLERY_BASE_DIR: 'data'
      GALLERY_CONFIG_DIR: 'data/config'
      GALLERY_CONFIG_PREFIX: 'data/db'
      GALLERY_CACHE_DIR: 'data/cache'
    restart: on-failure:5

Home Gallery Server Synology NAS Set up 4

  • STEP 9

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.

Home Gallery Server Synology NAS Set up 5

  • STEP 10

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

Home Gallery Server Synology NAS Set up 6

  • STEP 11

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

  • STEP 12

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:3179 Wait until your photos/videos are processed. Follow the instructions in the image below. ⚠️Note: The more photos/videos you have added at STEP 4, the longer the processing time and the longer it will take until you can see them.

Home Gallery Server Synology NAS Set up 7

Enjoy Home Gallery!

🆘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 Home Gallery container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make Home Gallery 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 Home Gallery 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 Tuesday / February 13th, 2024 at 9:40 PM

🧡 I Need Your Help!