Skip to content

daemonless/readmeabook

Repository files navigation

ReadMeABook

Audiobook request and management platform with AI recommendations.

Port 3030
Registry ghcr.io/daemonless/readmeabook
Docs daemonless.io/images/readmeabook
Source https://github.com/kikootwo/readmeabook
Website https://github.com/kikootwo/readmeabook

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
    restart: unless-stopped

Podman CLI

podman run -d --name readmeabook \
  -p 3030:3030 \
  --annotation 'org.freebsd.jail.allow.sysvipc=true' \
  -e PUID=@PUID@ \
  -e PGID=@PGID@ \
  -e TZ=@TZ@ \
  -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

Access at: http://localhost:3030

Ansible

- name: Deploy readmeabook
  containers.podman.podman_container:
    name: readmeabook
    image: ghcr.io/daemonless/readmeabook:latest
    state: started
    restart_policy: always
    env:
      PUID: "@PUID@"
      PGID: "@PGID@"
      TZ: "@TZ@"
      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"

Configuration

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

Notes

  • Architectures: amd64
  • User: bsd (UID/GID set via PUID/PGID)
  • Base: Built on ghcr.io/daemonless/base (FreeBSD)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors