Komga in Docker Swarm

Get your FREE "elfhosted" Komga instance for demo / trial

Want to see a live demo, or "kick the tyres" before you commit to self-hosting Komga?

Try out an "ElfHosted" instance of Komga for FREE!

So you've just watched a bunch of superhero movies, and you're suddenly inspired to deep-dive into the weird world of comic books? You're already rocking AutoPirate with Mylar and NZBGet to grab content, but how to manage and enjoy your growing collection?

Komga Screenshot

Komga is a media server with a beautifully slick interface, allowing you to read your comics / manga in CBZ, CBR, PDF and epub format. Komga includes an integrated web reader, as well as a Tachiyomi plugin and an OPDS server for integration with other mobile apps such as Chunky on iPad.

Komga Requirements

Ingredients

Already deployed:

Docker swarm cluster with persistent shared storage
Traefik configured per design
DNS entry for the hostname you intend to use (or a wildcard), pointed to your keepalived IP

Traefik Forward Auth or Authelia to secure your Traefik-exposed services with an additional layer of authentication
AutoPirate components (specifically Mylar), for searching for, downloading, and managing comic books

Preparation

Setup data locations

First we create a directory to hold the komga database, logs and other persistent data:

mkdir /var/data/komga

Komga Docker Swarm config

Create a docker swarm config file in docker-compose syntax (v3), something like the example below:

Fast-track with premix! 🚀

I automatically and instantly share (with my sponsors) a private "premix" git repository, which includes necessary docker-compose and env files for all published recipes. This means that sponsors can launch any recipe with just a git pull and a docker stack deploy 👍.

🚀 Update: Premix now includes an ansible playbook, so that sponsors can deploy an entire stack + recipes, with a single ansible command! (more here)

version: "3.2"

services:
  komga:
    image: gotson/komga
    env_file: /var/data/config/komga/komga.env
    volumes:
      - /var/data/media/:/media
      - /var/data/komga:/config
    deploy:
      replicas: 1
      labels:
        # traefik common
        - traefik.enable=true
        - traefik.docker.network=traefik_public

        # traefikv1
        - traefik.frontend.rule=Host:komga.example.com
        - traefik.port=8080     

        # traefikv2
        - "traefik.http.routers.komga.rule=Host(`komga.example.com`)"
        - "traefik.http.services.komga.loadbalancer.server.port=8080"
        - "traefik.enable=true"

        # Remove if you wish to access the URL directly
        - "traefik.http.routers.komga.middlewares=forward-auth@file"
    networks:
      - traefik_public

networks:
  traefik_public:
    external: true

Serving

Avengers Assemble!

Launch the Komga stack by running docker stack deploy komga -c <path -to-docker-compose.yml>

Log into your new instance at https://YOUR-FQDN. Since it's a fresh installation, Komga will prompt you to setup a username and password, after which you'll be able to setup your library, and tweak all teh butt0ns!

Save teh wurld!

If Komga scratches your particular itch, please join me in sponsoring the developer

Chef's notes 📓

Since Komga doesn't need to communicate with any other services, we don't need a separate overlay network for it. Provided Traefik can reach Komga via the traefik_public overlay network, we've got all we need. ↩

Did you receive excellent service? Want to compliment the chef? (..and support development of current and future recipes!) Sponsor me on Github / Ko-Fi / Patreon, or see the contribute page for more (free or paid) ways to say thank you! 👏

Employ your chef (engage) 🤝

Is this too much of a geeky PITA? Do you just want results, stat? I do this for a living - I'm a full-time Kubernetes contractor, providing consulting and engineering expertise to businesses needing short-term, short-notice support in the cloud-native space, including AWS/Azure/GKE, Kubernetes, CI/CD and automation.

Learn more about working with me here.

Want to know now when this recipe gets updated, or when future recipes are added? Subscribe to the RSS feed, or leave your email address below, and we'll keep you updated.