ReadMeABook

Audiobook request and management platform with AI recommendations.

Port	3030
Registry	ghcr.io/daemonless/readmeabook
Source	https://github.com/kikootwo/readmeabook
Website	https://github.com/kikootwo/readmeabook

Version Tags

Tag	Description	Best For
latest	FreeBSD Port. Built from latest FreeBSD packages.	Most users — recommended.

Prerequisites

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

Deployment

Podman Compose

services:
  readmeabook:
    image: "ghcr.io/daemonless/readmeabook:latest"
    container_name: readmeabook
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      - LOG_LEVEL=info  # Logging level (default: info)
      # - PUBLIC_URL=  # Public URL for OAuth callbacks (required for Plex/OIDC auth)
    volumes:
      - "/containers/readmeabook/config:/app/config"
      - "/containers/readmeabook/cache:/app/cache"
      - "/containers/readmeabook/data:/var/lib/postgresql/data"
      - "/containers/readmeabook/redis:/var/lib/redis"
      - "/path/to/downloads:/downloads"
      - "/containers/readmeabook/audiobooks:/audiobooks"
    ports:
      - "3030:3030"
    annotations:
      org.freebsd.jail.allow.sysvipc: "true"
    # 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.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=readmeabook
PUID=1000
PGID=1000
TZ=UTC
LOG_LEVEL=info

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  readmeabook:
    name: readmeabook
    options:
      - container: 'args:--pull'
      - expose: '3030:3030 proto:tcp'
      - template: !ENV '${PWD}/readmeabook.conf'
      - template: !ENV '${PWD}/template.conf'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - LOG_LEVEL: !ENV '${LOG_LEVEL}'
    volumes:
      - readmeabook_config: /app/config
      - readmeabook_cache: /app/cache
      - readmeabook_data: /var/lib/postgresql/data
      - readmeabook_redis: /var/lib/redis
      - downloads: /downloads
      - readmeabook_audiobooks: /audiobooks
volumes:
  readmeabook_config:
    device: '/containers/readmeabook/config'
  readmeabook_cache:
    device: '/containers/readmeabook/cache'
  readmeabook_data:
    device: '/containers/readmeabook/data'
  readmeabook_redis:
    device: '/containers/readmeabook/redis'
  downloads:
    device: 'downloads'
  readmeabook_audiobooks:
    device: '/containers/readmeabook/audiobooks'

Makejail:

# Makejail

ARG tag=latest

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

template.conf:

# template.conf

exec.start: "/bin/sh /etc/rc"
exec.stop: "/bin/sh /etc/rc.shutdown jail"
mount.devfs
persist
allow.sysvipc

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

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.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Bastille

Warning

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:
  readmeabook:
    name: readmeabook
    image: "ghcr.io/daemonless/readmeabook:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - LOG_LEVEL=info
    volumes:
      - "/containers/readmeabook/config:/app/config"
      - "/containers/readmeabook/cache:/app/cache"
      - "/containers/readmeabook/data:/var/lib/postgresql/data"
      - "/containers/readmeabook/redis:/var/lib/redis"
      - "/path/to/downloads:/downloads"
      - "/containers/readmeabook/audiobooks:/audiobooks"

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

Access at: http://localhost:3030

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
LOG_LEVEL	info	Logging level (default: info)
PUBLIC_URL	``	Public URL for OAuth callbacks (required for Plex/OIDC auth)

Volumes

Path	Description
/app/config	Application configuration and secrets
/app/cache	Thumbnail and metadata cache
/var/lib/postgresql/data	PostgreSQL database storage
/var/lib/redis	Redis data persistence
/downloads	Download client path
/audiobooks	Audiobook library

Ports

Port	Protocol	Description
3030	TCP	Web UI

ReadMeABook bundles PostgreSQL, which requires allow.sysvipc for shared memory. Create readmeabook.conf alongside appjail-director.yml:

exec.start: "/bin/sh /etc/rc"
exec.stop: "/bin/sh /etc/rc.shutdown jail"
mount.devfs
persist
allow.sysvipc

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

---

Need help? Join our Discord community.