Skip to content

Audiobookshelf Audiobookshelf

Description / nameInput element
Container Registry
Container Configuration Root Path
Timezone
User ID
Group ID
Audiobookshelf Host Port
Audiobookshelf /config Path
Audiobookshelf /metadata Path
Audiobookshelf /audiobooks Path

Build Status Last Commit OCI Pulls

Self-hosted audiobook and podcast server.

Port 13378
Registry ghcr.io/daemonless/audiobookshelf
Daemonless daemonless/audiobookshelf
Source advplyr/audiobookshelf
Website www.audiobookshelf.org

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users — recommended.

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

services:
  audiobookshelf:
    image: "ghcr.io/daemonless/audiobookshelf:latest"
    container_name: audiobookshelf
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
    volumes:
      - "/path/to/containers/audiobookshelf:/config"
      - "/path/to/containers/audiobookshelf/metadata:/metadata"
      - "/path/to/containers/audiobookshelf/audiobooks:/audiobooks"
    ports:
      - "13378:13378"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

1
2
3
4
5
6
7
8
9
podman run -d --name audiobookshelf \
  -p 13378:13378 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -v /path/to/containers/audiobookshelf:/config \
  -v /path/to/containers/audiobookshelf/metadata:/metadata \
  -v /path/to/containers/audiobookshelf/audiobooks:/audiobooks \
  ghcr.io/daemonless/audiobookshelf:latest

Save as run.sh, then run sh run.sh.

- name: Deploy audiobookshelf
  containers.podman.podman_container:
    name: audiobookshelf
    image: "ghcr.io/daemonless/audiobookshelf:latest"
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
    ports:
      - "13378:13378"
    volumes:
      - "/path/to/containers/audiobookshelf:/config"
      - "/path/to/containers/audiobookshelf/metadata:/metadata"
      - "/path/to/containers/audiobookshelf/audiobooks:/audiobooks"

Save as audiobookshelf-deploy.yaml, then run ansible-playbook audiobookshelf-deploy.yaml.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

1
2
3
4
5
6
# .env

DIRECTOR_PROJECT=audiobookshelf
PUID=1000
PGID=1000
TZ=UTC
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  audiobookshelf:
    name: audiobookshelf
    options:
      - container: 'args:--pull'
      - expose: '13378:13378 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - AUDIOBOOKSHELF_CONFIG_PATH: /config
      - AUDIOBOOKSHELF_METADATA_PATH: /metadata
      - AUDIOBOOKSHELF_AUDIOBOOKS_PATH: /audiobooks
volumes:
  AUDIOBOOKSHELF_CONFIG_PATH:
    device: '/path/to/containers/audiobookshelf'
  AUDIOBOOKSHELF_METADATA_PATH:
    device: '/path/to/containers/audiobookshelf/metadata'
  AUDIOBOOKSHELF_AUDIOBOOKS_PATH:
    device: '/path/to/containers/audiobookshelf/audiobooks'
1
2
3
4
5
6
7
# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/audiobookshelf:${tag}

Save the files above, then run appjail-director up.

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="13378:13378 proto:tcp" \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -o fstab="/path/to/containers/audiobookshelf /config <pseudofs>" \
  -o fstab="/path/to/containers/audiobookshelf/metadata /metadata <pseudofs>" \
  -o fstab="/path/to/containers/audiobookshelf/audiobooks /audiobooks <pseudofs>" \
  ghcr.io/daemonless/audiobookshelf:latest audiobookshelf

Save the files above, then run sh run.sh.

Experimental

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  audiobookshelf:
    name: audiobookshelf
    image: "ghcr.io/daemonless/audiobookshelf:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - "/path/to/containers/audiobookshelf:/config"
      - "/path/to/containers/audiobookshelf/metadata:/metadata"
      - "/path/to/containers/audiobookshelf/audiobooks:/audiobooks"

Save as bastille-compose.yml, then run bastille up.

1
2
3
4
5
6
7
8
bastille create -O \
  --env PUID=1000 \
  --env PGID=1000 \
  --env TZ=UTC \
  --volume /path/to/containers/audiobookshelf /config \
  --volume /path/to/containers/audiobookshelf/metadata /metadata \
  --volume /path/to/containers/audiobookshelf/audiobooks /audiobooks \
  audiobookshelf ghcr.io/daemonless/audiobookshelf:latest inherit

Access at: http://localhost:13378

Interactive Configuration

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container

Volumes

Path Description
/config Configuration and database
/metadata Metadata cache
/audiobooks Audiobook library path

Ports

Port Protocol Description
13378 TCP Web UI

Implementation Details

  • Architectures: amd64
  • User: bsd (UID/GID set via PUID/PGID). Defaults to 1000:1000.
  • Base: Built on ghcr.io/daemonless/base (FreeBSD 15.1).

Need help? Join our Discord community.