ReadMeABook/README.md at d3dc6cf76d45fefb9d7c399e76440c351cbabc15

mirror of https://github.com/kikootwo/ReadMeABook.git synced 2026-06-02 20:30:10 +00:00

Files

T

kikootwo d3dc6cf76d Add volume mapping docs and build/version metadata

Add a volume-mapping guide and surface build/version metadata throughout the project.

Changes included:
- documentation: Add documentation/deployment/volume-mapping.md and update TABLEOFCONTENTS.md and README to reference it (helps users align download client and RMAB paths).
- CI: Capture package.json version in .github/workflows/build-unified-image.yml, pass APP_VERSION as a build-arg, and update the Discord notification to show the semantic version and pull `:latest`.
- Docker: Declare ARG APP_VERSION and expose NEXT_PUBLIC_APP_VERSION / APP_VERSION / GIT_COMMIT env vars in dockerfile.unified so runtime and client can read the semantic version and commit.
- App API/UI: Update src/app/api/version/route.ts and src/components/ui/VersionBadge.tsx to prefer semantic app version (APP_VERSION / NEXT_PUBLIC_APP_VERSION), include fullVersion and commit info, show commit in tooltip, and adjust fallback/dev labels.
- Tests: Update tests (system.routes.test.ts and VersionBadge.test.tsx) to reflect the new version/commit fields and behavior.
- Audible integration: Add ipRedirectOverride query param to multiple Audible requests to avoid IP-based region redirects.
- Misc: Bump package.json version to 1.0.0.

These changes make version information consistent between build, runtime, and UI, improve CI notifications, add user guidance for common volume-mapping issues, and harden Audible scraping against region redirects.

2026-02-05 10:26:07 -05:00

5.5 KiB

Raw Blame History

Audiobook automation for Plex and Audiobookshelf

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

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

docker compose up -d

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

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

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

5.5 KiB Raw Blame History