How to Install Koillection on Your Synology NAS

How to Install Koillection on Your Synology NAS

Koillection is a self-hosted collection manager created to keep track of physical (mostly) collections of any kind like books, DVDs, stamps, games etc. As Koillection is meant to be used for any kind of collections, it doesn’t support automatic download of metadata but, it offers the option to add your own metadata freely. In this step by step guide I will show you how to install Koillection on your Synology NAS using Docker & Portainer.

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

Koillection Synology NAS Set up 1 new 2024

  • STEP 4

Now create three new folders inside the koillection folder that you created at STEP 3 name them conf, db, uploads. Follow the instructions in the image below.
Note: Be careful enter only lowercase, not uppercase letters.

Koillection Synology NAS Set up 2 new 2024

  • 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 koillection. Follow the instructions in the image below.

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

version: '3.9'
services:
    koillection:
        image: koillection/koillection
        container_name: Koillection
        restart: on-failure:5
        ports:
            - 4460:80
        environment:
            - DB_DRIVER=pdo_pgsql
            - DB_NAME=koillection
            - DB_HOST=db
            - DB_PORT=5432
            - DB_USER=koillectionuser
            - DB_PASSWORD=koillectionpass
            - DB_VERSION=16
            - PHP_TZ=Europe/Bucharest
            - HTTPS_ENABLED=0
            - PUID=1026
            - PGID=100
        depends_on:
            - db
        volumes:
            - /volume1/docker/koillection/conf:/conf:rw
            - /volume1/docker/koillection/uploads:/uploads:rw
    db:
        image: postgres:16
        container_name: Koillection-DB
        mem_limit: 512m
        cpu_shares: 768
        security_opt:
            - no-new-privileges:true
        healthcheck:
         test: ["CMD", "pg_isready", "-q", "-d", "koillection", "-U", "koillectionuser"]
         timeout: 45s
         interval: 10s
         retries: 10
        environment:
            - POSTGRES_DB=koillection
            - POSTGRES_USER=koillectionuser
            - POSTGRES_PASSWORD=koillectionpass
        volumes:
            - /volume1/docker/koillection/db:/var/lib/postgresql/data:rw
        restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value for PHP_TZ. (Select your current Time Zone from this list.)
Note: Before you paste the code above in the Web editor area below, change the value numbers for PUID and PGID with your own values. (Follow my step by step guide on how to do this.)

Koillection Synology NAS Set up 3 new 2024

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

Koillection Synology NAS Set up 4 new 2024

  • STEP 8

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

Koillection Synology NAS Set up 5 new 2024

  • 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:4460 If everything goes right you will see the installation page. Type in your own Username, Email, Password, Time zone, then select your favorite Date format. Click Submit. Follow the instructions in the image below.

Koillection Synology NAS Set up 6 new 2024

  • STEP 11

At the top right of the page click on your profile then Settings. Change the Theme to Dark then scroll down the page to save. Follow the instructions in the image below.

Koillection Synology NAS Set up 7 new 2024

  • STEP 12

Your Koillection dashboard at a glance!

Koillection Synology NAS Set up 10

Enjoy Koillection!

🆘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 Koillection container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make Koillection 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 Koillection 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 Saturday / February 24th, 2024 at 5:49 PM