komga v0.1.0

Media

Komga — a self-hosted media server for comics, manga, and ebooks (CBZ/CBR/PDF/EPUB) with a web reader, OPDS, and Kobo/Tachiyomi sync. Deployed as a single host-networked Nomad service with a config volume and a library volume.

nomad-pack run komga --registry nomploy

…or one line (add registry + run)

curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- komga

Needs nomad-pack on PATH. The script only adds the nomploy registry and runs this pack.

Source ↗ Project ↗ ★ 6.8k ⚑ Report an issue

1 task http 25600 2 volumes image gotson/komga:latest tracks :latest image bumped 27 days ago

Variables 9

values.hcl

Save as values.hcl, edit, then run:

nomad-pack run komga -f values.hcl --registry nomploy

# The name of the Nomad job.
job_name = "komga"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The Komga container image. Pin a tag in production.
image = "gotson/komga:latest"

# Host port for the Komga web UI (SERVER_PORT).
port = 25600

# Named volume for Komga config, the SQLite database, and thumbnails (/config).
config_volume = "komga_config"

# Named volume for your comics/manga/ebook library (/data). Fill it with your files.
library_volume = "komga_library"

# Placement constraints. Pin to the node holding the volumes. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# The task resources (JVM).
resources = {
    cpu    = 1000
    memory = 1024
  }

Name	Type	Default	Description
job_name	string	"komga"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"gotson/komga:latest"	The Komga container image. Pin a tag in production.
port	number	25600	Host port for the Komga web UI (SERVER_PORT).
config_volume	string	"komga_config"	Named volume for Komga config, the SQLite database, and thumbnails (/config).
library_volume	string	"komga_library"	Named volume for your comics/manga/ebook library (/data). Fill it with your files.
constraints	list	[]	Placement constraints. Pin to the node holding the volumes. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources	object	{ cpu = 1000 memory = 1024 }	The task resources (JVM).

Back up this pack

This pack stores data in 2 Docker named volumes: komga_configkomga_library

restic

# Run on the node hosting this pack. Point restic at your repo first:
#   export RESTIC_REPOSITORY="s3:https://<account>.r2.cloudflarestorage.com/<bucket>"
#   export RESTIC_PASSWORD="<repo-password>"
#   export AWS_ACCESS_KEY_ID=<key>  AWS_SECRET_ACCESS_KEY=<secret>
restic backup \
  /var/lib/docker/volumes/komga_config/_data \
  /var/lib/docker/volumes/komga_library/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/komga_config/_data backup:<bucket>/komga_config
rclone sync /var/lib/docker/volumes/komga_library/_data backup:<bucket>/komga_library

Paths assume the default Docker volume location (/var/lib/docker/volumes). Restore by stopping the job, restoring files into the same volume, and re-running the pack.

Readme

komga

Komga — a self-hosted media server for comics, manga, and ebooks (CBZ/CBR/PDF/EPUB) with a web reader, OPDS, and Kobo/Tachiyomi sync.

Single host-networked Nomad service with a config volume and a library volume.

Deploy

nomad-pack registry add nomploy https://github.com/Nomploy/nomad-packs
nomad-pack run komga --registry=nomploy

Configure

Variable	Default	Description
`port`	`25600`	Web UI port (`SERVER_PORT`).
`config_volume`	`komga_config`	`/config` — database, thumbnails, settings.
`library_volume`	`komga_library`	`/data` — your library.
`image`	`gotson/komga:latest`	Container image. Pin a tag in production.
`resources`	`{ cpu = 1000, memory = 1024 }`	Task resources (JVM).

Create the admin on first visit and add a library at /data (fill that volume with your files). See also the audiobookshelf pack. Pin the job to the node holding the volumes with constraints.