audiobookshelf v0.1.0

Media

Audiobookshelf — a self-hosted audiobook and podcast server with streaming apps for iOS/Android, progress sync, multi-user support, and podcast auto-download. Deployed as a single host-networked Nomad service with config, metadata, and library volumes.

nomad-pack run audiobookshelf --registry nomploy

…or one line (add registry + run)

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

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

Source ↗ Project ↗ ★ 14.7k ⚑ Report an issue

1 task http 13378 3 volumes image ghcr.io/advplyr/audiobookshelf:latest tracks :latest image bumped 28 days ago

Variables 10

values.hcl

Save as values.hcl, edit, then run:

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

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

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

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

# The Audiobookshelf container image. Pin a tag in production.
image = "ghcr.io/advplyr/audiobookshelf:latest"

# Host port for the Audiobookshelf web UI (PORT).
port = 13378

# Named volume for config and the database (/config).
config_volume = "audiobookshelf_config"

# Named volume for generated metadata — covers, cache (/metadata).
metadata_volume = "audiobookshelf_metadata"

# Named volume for your audiobooks and podcasts library (/audiobooks). Fill it with your media.
library_volume = "audiobookshelf_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.
resources = {
    cpu    = 500
    memory = 512
  }

Name	Type	Default	Description
job_name	string	"audiobookshelf"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"ghcr.io/advplyr/audiobookshelf:latest"	The Audiobookshelf container image. Pin a tag in production.
port	number	13378	Host port for the Audiobookshelf web UI (PORT).
config_volume	string	"audiobookshelf_config"	Named volume for config and the database (/config).
metadata_volume	string	"audiobookshelf_metadata"	Named volume for generated metadata — covers, cache (/metadata).
library_volume	string	"audiobookshelf_library"	Named volume for your audiobooks and podcasts library (/audiobooks). Fill it with your media.
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 }	The task resources.

Back up this pack

This pack stores data in 3 Docker named volumes: audiobookshelf_configaudiobookshelf_metadataaudiobookshelf_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/audiobookshelf_config/_data \
  /var/lib/docker/volumes/audiobookshelf_metadata/_data \
  /var/lib/docker/volumes/audiobookshelf_library/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/audiobookshelf_config/_data backup:<bucket>/audiobookshelf_config
rclone sync /var/lib/docker/volumes/audiobookshelf_metadata/_data backup:<bucket>/audiobookshelf_metadata
rclone sync /var/lib/docker/volumes/audiobookshelf_library/_data backup:<bucket>/audiobookshelf_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

audiobookshelf

Audiobookshelf — a self-hosted audiobook and podcast server with streaming apps for iOS/Android, progress sync, multi-user support, and podcast auto-download.

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

Deploy

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

Configure

Variable	Default	Description
`port`	`13378`	Web UI port (`PORT`).
`config_volume`	`audiobookshelf_config`	`/config` — settings + database.
`metadata_volume`	`audiobookshelf_metadata`	`/metadata` — covers, cache.
`library_volume`	`audiobookshelf_library`	`/audiobooks` — your media.
`image`	`ghcr.io/advplyr/audiobookshelf:latest`	Image. Pin a tag in production.
`resources`	`{ cpu = 500, memory = 512 }`	Task resources.

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