mirror of https://github.com/nickyeoman/docker-compose-cookbooks.git synced 2026-09-03 18:36:22 +00:00

Files

T

codeandClaude Fable 5 340866f9f4 complete all stack READMEs to the 9-section template

Existing content preserved and reordered to the canonical section order;
missing sections generated from each stack's compose data (ports, volumes,
env vars, image links). Fixes copy-paste errors in Dockhand sections
(qbittorrent pointed at archivebox; invokeai/thunderbird said SERVICENAME)
and persistant->persistent typos in gatus.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

2026-07-16 06:25:05 +00:00

2.8 KiB

Raw Permalink Blame History

Readarr

Overview

Readarr is an automated eBook and audiobook collection manager for Usenet and BitTorrent users. It monitors authors on your watchlist, scans configured indexers for new releases or upgrades, and sends them to your download client. After download, it renames and organizes files into your book library and can notify your media server.

Project Details

Project Repository: https://readarr.com/
Container Image: ghcr.io/hotio/readarr
Reverse Proxy Port: 8787

Getting Started

Open http://localhost:8787 in your browser and complete the initial setup wizard:

Choose your UI language
Add a download client — select qBittorrent, enter its host/port/credentials
Add an indexer — or connect to Prowlarr for automatic indexer sync

Once the wizard finishes, you'll see an empty library. To populate it:

Go to Settings → Media Management and add a Root Folder (e.g., /books) — this is where your organized book library will live
Click Add Author and search by name — Readarr fetches metadata, covers, and available editions
Optionally connect a List (Goodreads, etc.) to auto-import authors from your reading lists

Download flow

qBittorrent downloads to its own directory → Readarr picks it up, renames the file, and moves it into <Root Folder>/Author Name/Book Name/

Environment Variable Notes

Variable	Description
`READARR_IMAGE`	Container image (default: `ghcr.io/hotio/readarr:release`)
`READARR_RESTART`	Restart policy (default: `unless-stopped`)
`READARR_PORT`	Published port for the web UI (default: `8787`)
`VOL_PATH`	Base path for persistent data volumes (default: `/data`)
`TZ`	Container timezone (default: `America/Vancouver`)

Volume Notes

Volume	Purpose
`${VOL_PATH:-/data}/readarr/config`	Application configuration and database
`${VOL_PATH:-/data}/readarr/data`	Download client data and working directory

Network Notes

Requires an external proxy network. Create it once with:

docker network create proxy

Docker Run

docker run -d \
  --name=readarr \
  -e PUID=1000 \
  -e PGID=1000 \
  -e UMASK=002 \
  -e TZ=America/Vancouver \
  -p 8787:8787 \
  -v ${VOL_PATH:-/data}/readarr/config:/config \
  -v ${VOL_PATH:-/data}/readarr/data:/data \
  --network proxy \
  --restart unless-stopped \
  ghcr.io/hotio/readarr:release

Additional Notes / Gotchas

Nothing specific to this stack so far.

Dockhand Stack, Deploy from Git

Cookbooks Repository
stackname: readarr_dev
Compose file path: readarr_dev/compose.yaml
Additional env file (optional): readarr_dev/sample.env

Load readarr_dev/sample.env into the Environment variables in Dockhand, then create the Stack.

2.8 KiB Raw Permalink Blame History