ReadMeABook

Description / name	Input element
Container Registry
Container Configuration Root Path
Global /downloads 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
ReadMeABook /audiobooks 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 — 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 AppJail Bastille

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:
      - "/containers/readmeabook/config:/app/config"
      - "/containers/readmeabook/cache:/app/cache"
      - "/containers/readmeabook/data:/var/lib/postgresql/data"
      - "/containers/readmeabook/redis:/var/lib/redis"
      - "/path/to/downloads:/downloads"
      - "/containers/readmeabook/audiobooks:/audiobooks"
    ports:
      - "3030:3030"
    annotations:
      org.freebsd.jail.allow.sysvipc: "true"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

Warning

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 jail's IPv4 address or hostname assigned by the virtual network.

# .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: 'args:--pull'
      - expose: '3030:3030 proto:tcp'
      - template: !ENV '${PWD}/readmeabook.conf'
      - template: !ENV '${PWD}/template.conf'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - LOG_LEVEL: !ENV '${LOG_LEVEL}'
    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
      - READMEABOOK_AUDIOBOOKS_PATH: /audiobooks
volumes:
  READMEABOOK_CONFIG_PATH:
    device: '/containers/readmeabook/config'
  READMEABOOK_CACHE_PATH:
    device: '/containers/readmeabook/cache'
  READMEABOOK_DATA_PATH:
    device: '/containers/readmeabook/data'
  READMEABOOK_REDIS_PATH:
    device: '/containers/readmeabook/redis'
  DOWNLOADS_PATH:
    device: '/path/to/downloads'
  READMEABOOK_AUDIOBOOKS_PATH:
    device: '/containers/readmeabook/audiobooks'

# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/readmeabook:${tag}

# template.conf

exec.start: "/bin/sh /etc/rc"
exec.stop: "/bin/sh /etc/rc.shutdown jail"
mount.devfs
persist
allow.sysvipc

Save the files above, then run appjail-director up.

Experimental

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  readmeabook:
    name: readmeabook
    image: "ghcr.io/daemonless/readmeabook:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - LOG_LEVEL=info
    volumes:
      - "/containers/readmeabook/config:/app/config"
      - "/containers/readmeabook/cache:/app/cache"
      - "/containers/readmeabook/data:/var/lib/postgresql/data"
      - "/containers/readmeabook/redis:/var/lib/redis"
      - "/path/to/downloads:/downloads"
      - "/containers/readmeabook/audiobooks:/audiobooks"

Save as bastille-compose.yml, then run bastille up.

Open http://<server>:3030 from another machine (the server's own browser can't use a published port).

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
`/audiobooks`	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.