ReadMeABook

Description / name	Input element
Container Registry
Container Configuration Root Path
Global /downloads Path
Global /media Path
Timezone
User ID
Group ID
ReadMeABook Host Port
ReadMeABook /app/config Path
ReadMeABook /app/cache Path
ReadMeABook /var/lib/postgresql/data Path
ReadMeABook /var/lib/redis Path

Audiobook request and management platform with AI recommendations.

Requires ocijail with annotation support (≥ 0.6.0)

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. Point your pkg repos at the latest branch (ocijail ≥ 0.6.0) and run with the annotation flag shown below. See the ocijail guide.


Port	`3030`
Registry	`ghcr.io/daemonless/readmeabook`
Daemonless	daemonless/readmeabook
Source	kikootwo/readmeabook
Website	github.com/kikootwo/readmeabook

Version Tags

Tag	Description	Best For
`latest`	FreeBSD Port. Built from latest FreeBSD packages.	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

Podman Compose AppJail Director Podman CLI AppJail Ansible

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/config:/app/config"
      - "/path/to/containers/readmeabook/cache:/app/cache"
      - "/path/to/containers/readmeabook/data:/var/lib/postgresql/data"
      - "/path/to/containers/readmeabook/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

# .env

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

# 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_CONFIG_PATH: /app/config
      - READMEABOOK_CACHE_PATH: /app/cache
      - READMEABOOK_DATA_PATH: /var/lib/postgresql/data
      - READMEABOOK_REDIS_PATH: /var/lib/redis
      - DOWNLOADS_PATH: /downloads
      - MEDIA_PATH: /media
volumes:
  READMEABOOK_CONFIG_PATH:
    device: '/path/to/containers/readmeabook/config'
  READMEABOOK_CACHE_PATH:
    device: '/path/to/containers/readmeabook/cache'
  READMEABOOK_DATA_PATH:
    device: '/path/to/containers/readmeabook/data'
  READMEABOOK_REDIS_PATH:
    device: '/path/to/containers/readmeabook/redis'
  DOWNLOADS_PATH:
    device: '/path/to/downloads'
  MEDIA_PATH:
    device: '/path/to/media'

# Makejail

ARG tag=latest

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

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/config:/app/config \
  -v /path/to/containers/readmeabook/cache:/app/cache \
  -v /path/to/containers/readmeabook/data:/var/lib/postgresql/data \
  -v /path/to/containers/readmeabook/redis:/var/lib/redis \
  -v /path/to/downloads:/downloads \
  -v /path/to/media:/media \
  ghcr.io/daemonless/readmeabook:latest

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/config /app/config <pseudofs>" \
  -o fstab="/path/to/containers/readmeabook/cache /app/cache <pseudofs>" \
  -o fstab="/path/to/containers/readmeabook/data /var/lib/postgresql/data <pseudofs>" \
  -o fstab="/path/to/containers/readmeabook/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

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

Access at: http://localhost:3030

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

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).
sysvipc: Requires --annotation 'org.freebsd.jail.allow.sysvipc=true' (ocijail 0.5.0+)

Need help? Join our Discord community.