Nomploy Nomad Packs

← All packs

calibre-web v0.1.0

Media

Calibre-Web — a clean web reader and OPDS server for your Calibre ebook library. Deployed as a single host-networked Nomad service.

nomad-pack run calibre-web --registry nomploy
…or one line (add registry + run)
curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- calibre-web

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

Source ↗ Project ↗ ★ 18.2k ⚑ Report an issue

1 task http 8083 2 volumes image lscr.io/linuxserver/calibre-web:latest tracks :latest image bumped today
Replaces Comixology / Kindle
Pairs with audiobookshelfkavitakomga
Alternatives kavitakomga
Variables 12
values.hcl

Save as values.hcl, edit, then run:

nomad-pack run calibre-web -f values.hcl --registry nomploy
# The name of the Nomad job.
job_name = "calibre-web"

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

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

# The Calibre-Web container image. Pin a tag in production.
image = "lscr.io/linuxserver/calibre-web:latest"

# Host port for the Calibre-Web web UI.
port = 8083

# Named volume mounted at /config (settings + app database).
data_volume = "calibre_web_data"

# Named volume mounted at /books — must contain a Calibre library (a metadata.db). Point it at an existing library or create one with the Calibre desktop app / calibredb.
books_volume = "calibre_web_books"

# User ID that owns the files (PUID).
puid = 1000

# Group ID that owns the files (PGID).
pgid = 1000

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

# Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# The task resources.
resources = {
    cpu    = 300
    memory = 256
  }
NameTypeDefaultDescription
job_name string 
"calibre-web"
 The name of the Nomad job.
namespace string 
"default"
 The Nomad namespace to deploy into.
datacenters list 
["*"]
 The datacenters to deploy to.
image string 
"lscr.io/linuxserver/calibre-web:latest"
 The Calibre-Web container image. Pin a tag in production.
port number 
8083
 Host port for the Calibre-Web web UI.
data_volume string 
"calibre_web_data"
 Named volume mounted at /config (settings + app database).
books_volume string 
"calibre_web_books"
 Named volume mounted at /books — must contain a Calibre library (a metadata.db). Point it at an existing library or create one with the Calibre desktop app / calibredb.
puid number 
1000
 User ID that owns the files (PUID).
pgid number 
1000
 Group ID that owns the files (PGID).
tz string 
"UTC"
 Container timezone (TZ), e.g. Europe/Bratislava.
constraints list 
[]
 Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources object 
{
    cpu    = 300
    memory = 256
  }
 The task resources.
Back up this pack

This pack stores data in 2 Docker named volumes: calibre_web_datacalibre_web_books

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/calibre_web_data/_data \
  /var/lib/docker/volumes/calibre_web_books/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/calibre_web_data/_data backup:<bucket>/calibre_web_data
rclone sync /var/lib/docker/volumes/calibre_web_books/_data backup:<bucket>/calibre_web_books

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

calibre-web

Calibre-Web — a clean, modern web app for browsing, reading and downloading books from an existing Calibre library. It serves an in-browser reader, an OPDS feed for reading apps, user accounts, and optional on-the-fly format conversion — without needing the Calibre desktop app running.

Single host-networked Nomad service with persistent config and library volumes.

Deploy

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

Configure

Variable Default Description
port 8083 Web UI port. Fixed inside the LinuxServer image — keep the container reachable on 8083.
image lscr.io/linuxserver/calibre-web:latest Container image. Pin a tag in production.
data_volume calibre_web_data /config — settings and the app database.
books_volume calibre_web_books /books — your Calibre library.
puid / pgid 1000 / 1000 User/group that owns the files (PUID/PGID).
tz UTC Container timezone (TZ).
resources { cpu = 300, memory = 256 } Task resources.

Needs a Calibre library: on first run, Calibre-Web asks for the path to a metadata.db. The /books volume must already contain a Calibre library (a metadata.db produced by the Calibre desktop app or calibredb). If you start from an empty volume, create the library first, e.g. calibredb add --with-library /books <file>.

First login: default credentials are admin / admin123 — change them immediately. Put Calibre-Web behind an authenticating reverse proxy over TLS before exposing it. Pin the job to the node holding the volumes with constraints.