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.


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. Matches Linux Docker behavior.

Root Privileges Required

Podman on FreeBSD currently requires root. All commands must be run as root (or via doas/sudo).

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

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

# .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'
      - 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}'
    volumes:
      - READMEABOOK_APP_CONFIG_PATH: /app/config
      - READMEABOOK_APP_CACHE_PATH: /app/cache
      - READMEABOOK_VAR_LIB_POSTGRESQL_DATA_PATH: /var/lib/postgresql/data
      - READMEABOOK_VAR_LIB_REDIS_PATH: /var/lib/redis
      - DOWNLOADS_PATH: /downloads
      - MEDIA_PATH: /media
volumes:
  READMEABOOK_APP_CONFIG_PATH:
    device: '/path/to/containers/readmeabook/app/config'
  READMEABOOK_APP_CACHE_PATH:
    device: '/path/to/containers/readmeabook/app/cache'
  READMEABOOK_VAR_LIB_POSTGRESQL_DATA_PATH:
    device: '/path/to/containers/readmeabook/var/lib/postgresql/data'
  READMEABOOK_VAR_LIB_REDIS_PATH:
    device: '/path/to/containers/readmeabook/var/lib/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 \
  -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 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 \
  -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

- 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

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)

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.