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.

Version Tags

Tag	Description	Best For
`latest`	FreeBSD Port. Installs from latest 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 Podman CLI Ansible

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/config:/app/config
      - /path/to/containers/readmeabook/cache:/app/cache
      - /path/to/containers/readmeabook/postgres:/var/lib/postgresql/data
      - /path/to/containers/readmeabook/redis:/var/lib/redis
      - /path/to/downloads:/downloads
      - /path/to/media:/media
    ports:
      - 3030:3030
    restart: unless-stopped

podman run -d --name readmeabook \
  -p 3030:3030 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e LOG_LEVEL=info \
  -v /path/to/containers/readmeabook/config:/app/config \ 
  -v /path/to/containers/readmeabook/cache:/app/cache \ 
  -v /path/to/containers/readmeabook/postgres:/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

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

Access the Web UI 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

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

Website Source Code

Need help? Join our Discord community.