dankhostself-host anything

Audiobookshelf with Docker Compose

Audiobookshelf is a self-hosted audiobook and podcast server. In the project's words: Audiobookshelf README checked 2026-09-23

Runs on: amd64, arm64 from each image's registry manifest, checked 2026-09-25; a CPU counts only if every image has a build for it. Image by image

Add Audiobookshelf to the builder to use your own domain and combine it with other apps in one file.

What Audiobookshelf needs

Only figures Audiobookshelf's own documentation publishes, each linked to the page it is on. Where the project gives no number, this page does not invent one.

ResourceMinimumRecommended
RAMThe project publishes no figure
CPUThe project publishes no figure
DiskThe project publishes no figure

On top of this, Caddy (the reverse proxy in the file) is a single small container.

Which hardware Audiobookshelf has images for

Read from each image's manifest list in its registry (anonymous, read-only) when this page was built. An app counts for a CPU only if every one of its images lists it.

  • x86-64 PC or NAS (linux/amd64): every image has a build.
  • Raspberry Pi 4/5, 64-bit OS (linux/arm64): every image has a build.
  • Raspberry Pi 3 or Zero 2 W, 32-bit OS (linux/arm/v7): no image for audiobookshelf. No image for this hardware; the builder leaves the app out.
ServiceImagePlatforms in the manifestDigestRegistryChecked
audiobookshelfghcr.io/advplyr/audiobookshelf:latestamd64, arm64sha256:3528a93b6442ffe54bd46771bbbab7c97084e1101071586d9dc2254f30bb4358ghcr.io2026-09-25

A manifest says an image exists for a CPU, not how well Audiobookshelf runs on it: a build for arm64 or arm/v7 can still be too slow or need more memory than the board has. The RAM and disk Audiobookshelf publishes are in the table above and, for a whole set of apps against a Raspberry Pi, on Will it run on my machine?. A tag like latest can move to a new digest after the date checked.

docker-compose.yml

This is exactly what the builder writes for Audiobookshelf alone on example.org: the official definition with its published ports removed and Caddy added in front.

# docker-compose.yml built at dankhost.com for: Audiobookshelf
# Each app block is its official compose definition. Only the names were prefixed with
# the app slug (services, containers, volumes, bind folders, .env variables) so any set of
# apps can share one file; other differences are listed under "Changed:" in each block.
# Only Caddy publishes ports. Secrets live in .env next to this file.

services:
  # ---- Caddy: the one reverse proxy, HTTPS certificates from Let's Encrypt ----
  # Source: https://caddyserver.com/docs/running (checked 2026-09-23)
  # Source: https://github.com/dani-garcia/vaultwarden/wiki/Using-Docker-Compose (checked 2026-09-23)
  # Caddyfile goes in ./caddy/Caddyfile. Fixed address 172.30.0.2 so apps can trust it exactly.
  caddy:
    image: "caddy:2"
    container_name: "caddy"
    restart: "unless-stopped"
    ports:
      - "80:80"
      - "443:443"
      - "443:443/udp"
    volumes:
      - "./caddy:/etc/caddy"
      - "caddy-data:/data"
      - "caddy-config:/config"
    networks:
      proxy:
        ipv4_address: "172.30.0.2"

  # ---- Audiobookshelf (books.example.org) ----
  # Source: https://github.com/advplyr/audiobookshelf/blob/master/docker-compose.yml (checked 2026-09-23)
  # Source: https://github.com/advplyr/audiobookshelf (checked 2026-09-23)
  # Source: https://www.audiobookshelf.org/docs#docker-compose-install (checked 2026-10-01)
  # Changed: Removed the documented '13378:80' port; Caddy reaches audiobookshelf:80 on the proxy network. The README says Audiobookshelf needs a WebSocket connection, which Caddy passes by default.
  audiobookshelf:
    image: "ghcr.io/advplyr/audiobookshelf:latest"
    container_name: "audiobookshelf"
    volumes:
      - "./audiobookshelf/audiobooks:/audiobooks"
      - "./audiobookshelf/podcasts:/podcasts"
      - "./audiobookshelf/metadata:/metadata"
      - "./audiobookshelf/config:/config"
    restart: "unless-stopped"
    networks:
      proxy: {}

networks:
  # Pinned so the trusted-proxy address given to each app (172.30.0.2) is exact.
  # If "docker compose up" reports "Pool overlaps", change 172.30.0 here, in Caddy's
  # ipv4_address and in every trusted-proxy value to a free 172.x.0 range.
  proxy:
    ipam:
      config:
        - subnet: "172.30.0.0/24"
          ip_range: "172.30.0.128/25"
          gateway: "172.30.0.1"

volumes:
  caddy-data:
  caddy-config:

Caddyfile save as caddy/Caddyfile

Caddy gets and renews the HTTPS certificate for books.example.org by itself once the DNS record points at your server and ports 80 and 443 reach it.

# Caddyfile built at dankhost.com. Save it as ./caddy/Caddyfile next to docker-compose.yml.
# Caddy gets and renews a Let's Encrypt certificate for each name below by itself,
# once the DNS records point at this server and ports 80 and 443 reach it.

# Audiobookshelf
books.example.org {
	reverse_proxy audiobookshelf:80
}

Already running nginx, Nginx Proxy Manager, Caddy or Traefik? The reverse-proxy settings Audiobookshelf needs, for all four, each cited to Audiobookshelf's own docs.

.env

Audiobookshelf needs no secret here; the builder adds nothing you have to fill in by hand.

# .env for Audiobookshelf, from dankhost.com/app/audiobookshelf/. Nothing here is secret.
# Keep this file private (chmod 600).
# None of the chosen apps needs a variable here.

Changes from the official file

Besides prefixing every service, container, volume, folder and variable with audiobookshelf (so any set of apps can share one file), these are all the differences from what the project documents:

  • Removed the documented '13378:80' port; Caddy reaches audiobookshelf:80 on the proxy network. The README says Audiobookshelf needs a WebSocket connection, which Caddy passes by default.

Notes for Audiobookshelf behind the proxy

  • The first visitor sets the root password, so open it straight away. Put books in ./audiobookshelf/audiobooks and podcasts in ./audiobookshelf/podcasts.
  • Keep ./audiobookshelf/config on a disk of the machine that runs the container, not on a NAS share or other network mount. It holds the database (users, books, libraries and settings, in audiobookshelf.sqlite). The official docker-compose.yml says: "The config directory needs to be on the same physical machine you are running ABS on"; Audiobookshelf's install docs say that beginning with 2.3.x it "needs to be on the same machine you are running ABS on".
  • The other folders are not tied to the machine in the same way. The official docker-compose.yml says "The metadata directory can be stored anywhere on your computer" (./audiobookshelf/metadata holds cache, streams, covers, downloads, backups and logs), and of the audiobooks and podcasts folders: "You can change these media directories or add as many as you want". Whatever you map, the install docs say volume mappings "should all be separate directories that are not contained in eachother".
  • Two documented options this file leaves out: the install docs set the time zone with the environment variable TZ (their example is TZ=America/Toronto), and the official docker-compose.yml carries a commented-out user: 1000:1000 directive to run the container as a specific user ("You will need to change the UID and GID to the correct values for your user"). Add either under the audiobookshelf service if you want it.

How to run it

  1. At your DNS provider, add an A record named books on your domain pointing at the server's public IP address, and forward TCP 80, TCP 443 and UDP 443 to it.
  2. Save the three files in one folder: docker-compose.yml and .env side by side, the Caddyfile at ./caddy/Caddyfile. Replace example.org with your domain in the Caddyfile, the compose file and the .env, or let the builder do it.
  3. Nothing in .env needs filling in; chmod 600 .env all the same.
  4. Start it:
    docker compose up -d
    docker compose logs -f caddy   # watch the certificate arrive
  5. Open the new address (books. plus your domain) in a browser and follow the notes above.

Back it up

Audiobookshelf makes its own database backups (Settings > Backups, stored in /metadata/backups), but they hold only the database and the cover images in metadata/, never your audiobooks or podcasts.

Below is the BACKUP.md the builder writes next to the compose file above: which of its folders and volumes hold data, what to copy with which container stopped, and a restore check. Pick more apps in the builder and it covers them all in one file.

# BACKUP.md built at dankhost.com for: Audiobookshelf

What to copy from the docker-compose.yml built with this file, the database dump each project documents (rewritten for the service names in that file), what to copy with which container stopped, and how to check the result. Run every command in the folder that holds docker-compose.yml.

The folders are owned by the containers' users: put sudo in front of tar if it says "Permission denied". Named volumes live under /var/lib/docker/volumes, not next to the compose file, so they are copied through a throwaway ubuntu container (Docker's documented --volumes-from method). tar makes a full copy each run; for large folders an incremental tool (restic, borg, rsync) saves time and space.

Never run "docker compose down -v" on this file: it deletes the named volumes of every app in it.

## Before you start

    BACKUP=/mnt/backup/selfhost   # change this: a disk or machine other than this server's system disk
    mkdir -p "$BACKUP"

## Every time: the three stack files

    tar czf "$BACKUP/stack-files.tar.gz" docker-compose.yml .env caddy

.env holds the database passwords and secret keys the apps were set up with; keep this archive as private as the data.

## Caddy (the reverse proxy)

Caddy's docs: 'The data directory must not be treated as a cache.' It holds the TLS certificates and their private keys; without it Caddy has to ask Let's Encrypt for every certificate again.

- caddy-data (named volume, /data in caddy)
  BACK UP: TLS certificates, private keys, OCSP staples.
- caddy-config (named volume, /config in caddy)
  SKIP: the last active configuration, kept for 'caddy run --resume', which this setup does not use: it starts from the Caddyfile.
- ./caddy (/etc/caddy in caddy)
  IN stack-files.tar.gz: the Caddyfile, copied with the stack files above.

Copy (Caddy keeps serving while you copy):

    docker run --rm --volumes-from caddy -v "$BACKUP":/backup ubuntu tar cvf /backup/caddy-data.tar /data

Restore check:

    tar tf "$BACKUP/caddy-data.tar" > /dev/null && echo OK
    docker run --rm --volumes-from caddy -v "$BACKUP":/backup ubuntu bash -c "cd /data && tar xvf /backup/caddy-data.tar --strip 1"

Sources:
- Caddy docs: Conventions, Data directory: https://caddyserver.com/docs/conventions#data-directory (checked 2026-09-24)
- Docker docs: Volumes, Back up, restore, or migrate data volumes: https://docs.docker.com/engine/storage/volumes/#back-up-restore-or-migrate-data-volumes (checked 2026-09-24)

## Audiobookshelf

Audiobookshelf makes its own database backups (Settings > Backups, stored in /metadata/backups), but they hold only the database and the cover images in metadata/, never your audiobooks or podcasts.

What this compose mounts:
- ./audiobookshelf/audiobooks (/audiobooks in audiobookshelf)
  YOUR FILES: your audiobook files; Audiobookshelf's backups never include them.
- ./audiobookshelf/podcasts (/podcasts in audiobookshelf)
  YOUR FILES: downloaded podcast episodes; not in the backups either.
- ./audiobookshelf/metadata (/metadata in audiobookshelf)
  BACK UP: authors/ and items/ metadata with cover images, and backups/ (the built-in backups).
- ./audiobookshelf/config (/config in audiobookshelf)
  BACK UP: audiobookshelf.sqlite, the database: users, libraries and listening progress.

YOUR FILES folders hold your own media, not Audiobookshelf data. If this server has the only copy, back them up like any other files; the steps below leave them out.

1. Stop audiobookshelf. The copy is taken in the same state Audiobookshelf's manual restore works in: with the container stopped.

    docker compose stop audiobookshelf

2. Copy while audiobookshelf is stopped:

    tar czf "$BACKUP/audiobookshelf-metadata.tar.gz" ./audiobookshelf/metadata
    tar czf "$BACKUP/audiobookshelf-config.tar.gz" ./audiobookshelf/config

3. Start it again:

    docker compose start audiobookshelf

Restore check:

    tar tzf "$BACKUP/audiobookshelf-metadata.tar.gz" > /dev/null && echo OK
    tar tzf "$BACKUP/audiobookshelf-config.tar.gz" > /dev/null && echo OK

Put a copy back (with audiobookshelf stopped):

    tar xzf "$BACKUP/audiobookshelf-metadata.tar.gz"   # recreates ./audiobookshelf/metadata; move the old folder aside first
    tar xzf "$BACKUP/audiobookshelf-config.tar.gz"   # recreates ./audiobookshelf/config; move the old folder aside first

Audiobookshelf's manual restore (2.3 and newer), with this file's paths: stop it, unzip the newest backup, copy the database and metadata back, start it.

    docker compose stop audiobookshelf
    cd ./audiobookshelf/metadata/backups && unzip <date>.audiobookshelf
    cp audiobookshelf.sqlite ../../config/audiobookshelf.sqlite && cp -r metadata-authors ../authors && cp -r metadata-items ../items
    cd - && docker compose start audiobookshelf

The Restore button on the Backups page does the same from the web app. Backups restore only onto the same operating system family (Linux to Linux).

Sources:
- Audiobookshelf docs: Backups: https://www.audiobookshelf.org/docs/documentation/server-management/backups (checked 2026-09-24)

Update it

What docker compose pull does depends only on how each image line in the compose file above is tagged. For Audiobookshelf as this page writes it:

ServiceImageHow it is pinnedWhat docker compose pull does
caddycaddy:2Major version only (tag 2)Takes the newest image tagged 2: minor and patch releases of 2, never 3. A new major version needs a tag edit.
audiobookshelfghcr.io/advplyr/audiobookshelf:latestNot pinned: moving tag latestMoves to the newest image published as latest, which can be a new major version.

What Audiobookshelf's docs say about updating

Audiobookshelf's docs for a Docker Compose install: make sure the image tag is either the version you want or latest for the newest release (to run a specific release, such as an older version, change the tag to that version number), then run these three commands:

docker compose pull
docker compose down
docker compose up --detach
  • This file keeps the latest tag of the official compose file, so docker compose pull takes the newest release. Write a version number in the tag instead to decide yourself when the next one arrives.
  • The steps below leave out docker compose down: docker compose up -d (-d is short for --detach) on its own replaces every container whose image changed. In a file with several apps, docker compose down stops and removes all of them, not only Audiobookshelf.

Source: Audiobookshelf docs: Upgrade, Docker Compose checked 2026-10-01

The steps

  1. Back up first, as in Back it up above. An update can migrate Audiobookshelf's data on its first start; the copy is the way back.
  2. Download the new images. Running containers are not touched yet:
    docker compose pull
  3. Recreate the containers whose image changed. Volumes and bind-mounted folders stay as they are:
    docker compose up -d
  4. Watch Audiobookshelf start (Ctrl+C stops following the log, not the app):
    docker compose logs -f audiobookshelf
  5. Optional: remove the old images the pull left without a tag. This covers every stack on the machine, not only this one:
    docker image prune

Docker's reference for these commands: Docker docs: docker compose pull checked 2026-09-30; Docker docs: docker compose up (recreates changed containers, keeps volumes) checked 2026-09-30; Docker docs: docker image prune checked 2026-09-30

Locked out? Reset the admin password

There is no reset command: Audiobookshelf's FAQ says a forgotten root password means clearing it in the SQLite database by hand. Other users are simpler: an admin resets their password on the Users page.

  1. Stop the server; the FAQ says it must not run while you edit the database. Source: Audiobookshelf FAQ: Server, How can I reset a password? read 2026-10-03; Docker docs: docker compose stop read 2026-10-03
    docker compose stop audiobookshelf
  2. Open ./audiobookshelf/config/audiobookshelf.sqlite with an SQLite tool (the FAQ suggests DB Browser for SQLite). In the users table, find the root user's row, set its pash column to NULL, save and close the database. Source: Audiobookshelf FAQ: Server, How can I reset a password? read 2026-10-03
  3. Start it again, log in as root with an empty password and set a new one. Source: Audiobookshelf FAQ: Server, How can I reset a password? read 2026-10-03; Docker docs: docker compose start read 2026-10-03
    docker compose start audiobookshelf

Run the commands in the folder that holds docker-compose.yml.

Sources

Every page below was fetched on the date shown.

Add Audiobookshelf to the builder All one hundred apps

Made with AI tools. ยท Privacy