ReadMeABook

Audiobook request and management platform with AI recommendations.

Warning

Requires ocijail ≥ 0.6.0 (annotation support). This image needs the jail permission allow.sysvipc, applied via OCI annotations. FreeBSD quarterly ships ocijail 0.4.0, which has no annotation support — the container starts but the permission is silently dropped, so the app can crash or misbehave at runtime. Point your pkg repos at the latest branch (ocijail ≥ 0.6.0), then run with the annotation flag below. See the ocijail guide.

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. 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:
  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:
      - "/path/to/containers/readmeabook/app/config:/app/config"
      - "/path/to/containers/readmeabook/app/cache:/app/cache"
      - "/path/to/containers/readmeabook/var/lib/postgresql/data:/var/lib/postgresql/data"
      - "/path/to/containers/readmeabook/var/lib/redis:/var/lib/redis"
      - "/path/to/downloads:/downloads"
      - "/path/to/media:/media"
    ports:
      - "3030:3030"
    annotations:
      org.freebsd.jail.allow.sysvipc: "true"
    restart: unless-stopped

AppJail Director

.env:

# .env

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

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  readmeabook:
    name: readmeabook
    options:
      - container: 'boot args:--pull'
      - expose: '3030:3030 proto:tcp' \
      - template: !ENV '${PWD}/readmeabook.conf'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - LOG_LEVEL: !ENV '${LOG_LEVEL}'
        - PUBLIC_URL: !ENV '${PUBLIC_URL}'
    volumes:
      - readmeabook_app_config: /app/config
      - readmeabook_app_cache: /app/cache
      - readmeabook_var_lib_postgresql_data: /var/lib/postgresql/data
      - readmeabook_var_lib_redis: /var/lib/redis
      - downloads: /downloads
      - media: /media
volumes:
  readmeabook_app_config:
    device: '/path/to/containers/readmeabook/app/config'
  readmeabook_app_cache:
    device: '/path/to/containers/readmeabook/app/cache'
  readmeabook_var_lib_postgresql_data:
    device: '/path/to/containers/readmeabook/var/lib/postgresql/data'
  readmeabook_var_lib_redis:
    device: '/path/to/containers/readmeabook/var/lib/redis'
  downloads:
    device: 'downloads'
  media:
    device: 'media'

Makejail:

# Makejail

ARG tag=latest

OPTION overwrite=force
OPTION from=ghcr.io/daemonless/readmeabook:${tag}
SET allow.sysvipc=1

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 readmeabook \
  -p 3030:3030 \
  --annotation 'org.freebsd.jail.allow.sysvipc=true' \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e LOG_LEVEL=info \
  -e PUBLIC_URL= \
  -v /path/to/containers/readmeabook/app/config:/app/config \
  -v /path/to/containers/readmeabook/app/cache:/app/cache \
  -v /path/to/containers/readmeabook/var/lib/postgresql/data:/var/lib/postgresql/data \
  -v /path/to/containers/readmeabook/var/lib/redis:/var/lib/redis \
  -v /path/to/downloads:/downloads \
  -v /path/to/media:/media \
  ghcr.io/daemonless/readmeabook:latest

AppJail

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="3030:3030 proto:tcp" \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e LOG_LEVEL=info \
  -e PUBLIC_URL= \
  -o fstab="/path/to/containers/readmeabook/app/config /app/config <pseudofs>" \
  -o fstab="/path/to/containers/readmeabook/app/cache /app/cache <pseudofs>" \
  -o fstab="/path/to/containers/readmeabook/var/lib/postgresql/data /var/lib/postgresql/data <pseudofs>" \
  -o fstab="/path/to/containers/readmeabook/var/lib/redis /var/lib/redis <pseudofs>" \
  -o fstab="/path/to/downloads /downloads <pseudofs>" \
  -o fstab="/path/to/media /media <pseudofs>" \
  ghcr.io/daemonless/readmeabook:latest readmeabook

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 readmeabook
  containers.podman.podman_container:
    name: readmeabook
    image: "ghcr.io/daemonless/readmeabook:latest"
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
      LOG_LEVEL: "info"
      PUBLIC_URL: ""
    ports:
      - "3030:3030"
    volumes:
      - "/path/to/containers/readmeabook/app/config:/app/config"
      - "/path/to/containers/readmeabook/app/cache:/app/cache"
      - "/path/to/containers/readmeabook/var/lib/postgresql/data:/var/lib/postgresql/data"
      - "/path/to/containers/readmeabook/var/lib/redis:/var/lib/redis"
      - "/path/to/downloads:/downloads"
      - "/path/to/media:/media"
    annotation:
      org.freebsd.jail.allow.sysvipc: "true"

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
/media	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.