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. 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
      - PGID=1000
      - TZ=UTC
      - LOG_LEVEL=info
    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:

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

appjail-director.yml:

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  readmeabook:
    name: readmeabook
    options:
      - container: 'boot args:--pull'
      - template: !ENV '${PWD}/readmeabook.conf'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - LOG_LEVEL: !ENV '${LOG_LEVEL}'
    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:

ARG tag=latest

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

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

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

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.0

---

Need help? Join our Discord community.