Synology: Install Komga With Portainer

Synology Install Komga With Portainer

My previous guide for Komga involved the use of Task Scheduler. Today I’m offering a recommended and excellent alternative for installing the latest Komga version via Portainer. Komga is a free and open source comics/mangas server. You can easily browse libraries, series and books via a responsive web UI that works on desktops, tablets and phones. Komga supports the following file types: Comic book archives: CBZ and CBR (except RAR5 and solid archives) – Comic books in EPUB format – PDF files. In this step by step guide I will show you how to install Komga on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Komga v.1.14.1 release.

💡Note: Check out my new guide on how to Install Komga on Your UGREEN 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 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 komga. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Komga Synology NAS Portainer Set up 1

  • STEP 4

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

Komga Synology NAS Portainer Set up 2

  • STEP 5

Populate the data folder you have previously created at STEP 4 with your comics, ePUB, PDF, CBR, CBZ. Follow the instructions in the image below.

Komga Synology NAS Portainer Set up 3

  • STEP 6

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 7

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

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

version: "3.9"
services:
  komga:
    container_name: Komga
    image: gotson/komga
    mem_limit: 4g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    user: 1026:100
    restart: on-failure:5
    ports:
      - 8341:25600
    volumes:
      - /volume1/docker/komga/config:/config:rw
      - /volume1/docker/komga/data:/data:rw
    environment:
     TZ: Europe/Bucharest

Note: Before you paste the code above in the Web editor area below, change the value numbers for user with your own UID and GID values. (Follow my step by step guide on how to do this.) 1026 is my personal UID value and 100 is my personal GID value. You have to type in your own values.
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.)

Komga Synology NAS Portainer Set up 4

  • STEP 8

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.

Komga Synology NAS Portainer Set up 5

  • STEP 9

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

Komga Synology NAS Portainer Set up 6

  • STEP 10

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

  • STEP 11

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:8341 Choose an Email, a Password, the Language and Theme, then click CREATE USER ACCOUNT. Follow the instructions in the image below.

Komga Synology NAS Portainer Set up 7

  • STEP 12

Click on the ADD LIBRARY button. Follow the instructions in the image below.

Komga Synology NAS Portainer Set up 8

  • STEP 13

Choose a name for your Library. On the Root folder area type in /data then click NEXT. Follow the instructions in the image below.

Komga Synology NAS Portainer Set up 9

  • STEP 14

Click Next. Follow the instructions in the image below.

Komga Synology NAS Portainer Set up 10

  • STEP 15

Click ADD. Follow the instructions in the image below.

Komga Synology NAS Portainer Set up 11

  • STEP 16

Enjoy your Library with Komga! If you have a large library you will need to wait a few minutes before the files become visible in your Komga Home. The files need to be processed.

Komga Synology NAS Portainer Set up 12

Start reading your comics!

Komga Synology NAS Portainer Set up 13

Enjoy Komga!

🆘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 Komga container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make Komga 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 Komga 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 Thursday / October 17th, 2024 at 9:52 PM