kavita v0.1.0

Apps

Kavita — a fast, self-hosted digital library and reading server for manga, comics, ebooks (EPUB/PDF), and magazines, with a built-in web reader, collections, reading progress, and multi-user support. Deployed as a host-networked Nomad service with persistent config and library volumes.

nomad-pack run kavita --registry nomploy

…or one line (add registry + run)

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

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

Source ↗ Project ↗ ★ 11.7k ⚑ Report an issue

1 task http 5000 2 volumes image jvmilazz0/kavita:latest tracks :latest image bumped today

Variables 10

values.hcl

Save as values.hcl, edit, then run:

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

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

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

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

# The Kavita container image. Pin a tag in production.
image = "jvmilazz0/kavita:latest"

# Host port for the Kavita web UI. The container listens on 5000.
port = 5000

# Container timezone (TZ), e.g. Europe/Bratislava.
tz = "UTC"

# Named volume for Kavita config (/kavita/config): SQLite database, covers, bookmarks, logs, backups.
config_volume = "kavita_config"

# Named volume for your library files (/data): the manga, comics, and books Kavita scans.
library_volume = "kavita_library"

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

# Resources for the Kavita task.
resources = {
    cpu    = 500
    memory = 512
  }

Name	Type	Default	Description
job_name	string	"kavita"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"jvmilazz0/kavita:latest"	The Kavita container image. Pin a tag in production.
port	number	5000	Host port for the Kavita web UI. The container listens on 5000.
tz	string	"UTC"	Container timezone (TZ), e.g. Europe/Bratislava.
config_volume	string	"kavita_config"	Named volume for Kavita config (/kavita/config): SQLite database, covers, bookmarks, logs, backups.
library_volume	string	"kavita_library"	Named volume for your library files (/data): the manga, comics, and books Kavita scans.
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 = 500 memory = 512 }	Resources for the Kavita task.

Back up this pack

This pack stores data in 2 Docker named volumes: kavita_configkavita_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/kavita_config/_data \
  /var/lib/docker/volumes/kavita_library/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/kavita_config/_data backup:<bucket>/kavita_config
rclone sync /var/lib/docker/volumes/kavita_library/_data backup:<bucket>/kavita_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

kavita

Kavita — a fast, self-hosted digital library and reading server for manga, comics, ebooks (EPUB/PDF), and magazines. Ships a slick web reader, collections and reading lists, per-user reading progress, OPDS, and multi-user accounts.

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 kavita --registry=nomploy

Configure

Variable	Default	Description
`port`	`5000`	Web UI port. The container listens on 5000.
`config_volume`	`kavita_config`	`/kavita/config` — SQLite DB, covers, bookmarks, backups.
`library_volume`	`kavita_library`	`/data` — the files Kavita scans (manga/comics/books).
`tz`	`UTC`	Container timezone (`TZ`).
`image`	`jvmilazz0/kavita:latest`	Container image. Pin a tag in production.
`resources`	`{ cpu = 500, memory = 512 }`	Task resources.

On first run, open the UI to create the admin account, then add libraries pointing at folders under /data. To use existing media, copy it into the library volume or replace that mount with a bind to your media directory. Serves plain HTTP — front it with a reverse proxy for TLS. Pin the job to the node holding the volumes with constraints.