Skip to content

daemonless/audiobookshelf

Repository files navigation

Audiobookshelf

Build Status Last Commit

Self-hosted audiobook and podcast server.

Port 13378
Registry ghcr.io/daemonless/audiobookshelf
Source https://github.com/advplyr/audiobookshelf
Website https://www.audiobookshelf.org/

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users. Matches Linux Docker behavior.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

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"
    restart: unless-stopped

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=audiobookshelf
PUID=1000
PGID=1000
TZ=UTC

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  audiobookshelf:
    name: audiobookshelf
    options:
      - container: 'boot args:--pull'
      - expose: '13378:13378 proto:tcp' \
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - audiobookshelf: /config
      - audiobookshelf_metadata: /metadata
      - audiobookshelf_audiobooks: /audiobooks
volumes:
  audiobookshelf:
    device: '/path/to/containers/audiobookshelf'
  audiobookshelf_metadata:
    device: '/path/to/containers/audiobookshelf/metadata'
  audiobookshelf_audiobooks:
    device: '/path/to/containers/audiobookshelf/audiobooks'

Makejail:

# Makejail

ARG tag=latest

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

Note: 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 IPv4 address assigned by the virtual network.

Podman CLI

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

AppJail

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

Note: 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 IPv4 address assigned by the virtual network.

Ansible

- 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"

Access at: http://localhost:13378

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

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.1


Need help? Join our Discord community.

Releases

No releases published

Packages

 
 
 

Contributors