Fully Featured audiobook request and downloading engine to bring audiobooks up to speed with the modern automation standards
Find a file
kikootwo f460f17ed8 Bump package version to 1.2.3
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HgZBHgvrYzmGkhNZu16HJB
2026-09-14 11:24:32 -04:00
.github Add volume mapping docs and build/version metadata 2026-02-05 10:26:07 -05:00
docker/unified Add credential recovery script, docs, and Redis wait 2026-05-15 12:04:19 -04:00
documentation Fix/jwt secret derivation (#301) 2026-09-14 11:18:03 -04:00
prisma Add release blocklist feature 2026-05-18 12:15:51 -04:00
public Merge branch 'main' of https://github.com/kikootwo/ReadMeABook 2026-03-05 11:31:49 -05:00
screenshots Update README quick-start and adjust tests 2026-02-05 12:22:26 -05:00
scripts Add credential recovery script, docs, and Redis wait 2026-05-15 12:04:19 -04:00
src Fix/jwt secret derivation (#301) 2026-09-14 11:18:03 -04:00
tests Fix/jwt secret derivation (#301) 2026-09-14 11:18:03 -04:00
.dockerignore Initial commit 2026-01-28 11:41:24 -05:00
.gitattributes Initial commit 2026-01-28 11:41:24 -05:00
.gitignore Fix/jwt secret derivation (#301) 2026-09-14 11:18:03 -04:00
AGENTS.md fix: try next release after transient grab failure (#275) 2026-08-18 16:09:36 -04:00
CLAUDE.md Enforce build+tests; add indexer option in test 2026-05-16 10:46:06 -04:00
docker-compose.debug.yml Initial commit 2026-01-28 11:41:24 -05:00
docker-compose.local.yml Initial commit 2026-01-28 11:41:24 -05:00
docker-compose.yml Add configurable file/dir perms and UMASK support 2026-03-09 16:37:30 -04:00
docker-entrypoint.sh Initial commit 2026-01-28 11:41:24 -05:00
dockerfile.unified Add paginated requests API and My Requests UI 2026-03-06 10:41:17 -05:00
documentation-agent-prompt.md Add manual-import and download-access features 2026-02-27 12:15:23 -05:00
eslint.config.mjs Initial commit 2026-01-28 11:41:24 -05:00
LICENSE Add notification system with admin UI and backend 2026-01-28 11:42:00 -05:00
next.config.ts Add indexer flag bonuses and SSL verify toggle 2026-01-28 11:41:58 -05:00
package-lock.json Bump version to 1.2.0 and update tests 2026-05-15 15:12:31 -04:00
package.json Bump package version to 1.2.3 2026-09-14 11:24:32 -04:00
postcss.config.mjs Initial commit 2026-01-28 11:41:24 -05:00
README.md Use dynamic Docker pulls badge 2026-02-05 13:49:31 -05:00
rmab_icon.ico Initial commit 2026-01-28 11:41:24 -05:00
tsconfig.json Add backend unit test framework and modularize settings UI 2026-01-28 11:41:59 -05:00
unraid.xml Update Unriad Template to fix permisions and WebUI link 2026-02-12 16:20:59 -08:00
vitest.config.ts Add series fields to audiobooks and update related logic 2026-01-28 11:42:00 -05:00

RMAB_hero.png

Audiobook automation for Plex and Audiobookshelf

Ko-Fi GitHub Sponsors Build Status Tests Docker Pulls License GitHub Stars Discord

Radarr/Sonarr + Overseerr for audiobooks, all in one

Features • Setup • Screenshots • Discord


What is this?

You run Plex or Audiobookshelf with audiobooks. You want more audiobooks. You search indexers, download torrents or NZBs, organize files, wait for your server to scan. ReadMeABook does all of that automatically.

Request a book → Prowlarr searches → qBittorrent or SABnzbd downloads → Files organized → Library imports. Done.

Also includes BookDate: AI recommendations with a Tinder-style swipe interface. Swipe right to request.

User friendly audible-backed searches, multi-file chapter merging, e-book sidecar support, OIDC OAuth, admin approval workflows, and more.

Features

  • Plex or Audiobookshelf
  • Torrents via qBittorrent
  • Usenet via SABnzbd
  • Prowlarr for indexer search (torrents + NZBs)
  • BookDate: AI recommendations (OpenAI/Claude/Local) with swipe interface
  • Chapter merging: Multi-file downloads → single M4B with chapters
  • E-book sidecar: Optional EPUB/PDF downloads from Shadow Library
  • Request approval: Admin approval workflow for multi-user setups
  • Setup wizard: Step-by-step guided config with connection testing

Setup

Prerequisites: Docker, Plex or Audiobookshelf, qBittorrent or SABnzbd, Prowlarr

Quick Start

# Download docker-compose.yml
curl -fsSL https://raw.githubusercontent.com/kikootwo/readmeabook/main/docker-compose.yml -o docker-compose.yml

# Start the container
docker compose up -d

Open http://localhost:3030 and follow the setup wizard.

Manual Setup

If you prefer to customize the compose file:

services:
  readmeabook:
    image: ghcr.io/kikootwo/readmeabook:latest
    container_name: readmeabook
    restart: unless-stopped
    ports:
      - "3030:3030"
    volumes:
      - ./config:/app/config
      - ./cache:/app/cache
      - ./downloads:/downloads        # Your download client's path
      - ./media:/media                # Your audiobook library
      - ./pgdata:/var/lib/postgresql/data
      - ./redis:/var/lib/redis
    environment:
      PUID: 1000                      # Optional: your user ID
      PGID: 1000                      # Optional: your group ID
      PUBLIC_URL: "https://audiobooks.example.com"  # Required for OAuth

Then run docker compose up -d to start.

Important: Your download client (qBittorrent/SABnzbd) and RMAB must see files at the same path. See the Volume Mapping Guide if downloads aren't being detected.

Screenshots

image image image

Community

Join the Discord: https://discord.gg/kaw6jKbKts

Feature and fix Contributions are highly welcome. Documentation in documentation/ if you want to contribute. Discord is a great place to ask questions!

Support

If you find this project useful, consider supporting development via GitHub Sponsors or Ko-fi.

If you'd like to support but cannot sponsor, a simple star on the GitHub repo is also greatly appreciated!

Built with AI Assistance

This is a human-engineered application. Architecture, design decisions, code review, and project direction are managed by a principal engineer with nearly 15 years of professional software development experience.

AI tools (Claude, GitHub Copilot) serve as force multipliers. Accelerating implementation, maintaining consistency, and handling boilerplate, while human expertise drives the technical vision. This mirrors how AI assistance is used at leading technology companies today.

The workflow:

  • Token-optimized documentation system designed for AI consumption (CLAUDE.md)
  • Structured navigation enabling AI to find relevant context without reading entire codebases
  • Consistent architectural patterns that AI tools can follow and extend
  • Human review of all AI-generated code before merge

The result: enterprise-grade velocity on a solo project without sacrificing code quality or architectural integrity.


AGPL v3 License