#ReadAIrr Fork Status
ReadAIrr is a renamed fork and continuation of Readarr. The public docs use the ReadAIrr name, but the current app repo still contains many inherited Readarr identifiers.
#Repository Split
| Area | Repository |
|---|---|
| App code and container image | https://github.com/ReadAIrr/App |
| Documentation source | https://github.com/ReadAIrr/Docs |
| Public site and Cloudflare Pages update function | https://github.com/ReadAIrr/Site |
The app repo is the source of truth for runtime behavior. The docs repo should mirror app behavior, not the retired upstream wiki.
#Names That Still Say Readarr
The current app repo still uses Readarr for:
- executable and assembly names
- default app name from
BuildInfo.AppName - default app-data directory
Readarr:*configuration sectionsREADARR__...environment variables- custom-script environment variables
- generated OpenAPI title and some API labels
- many screenshots and inherited UI strings
Do not change documentation examples for these compatibility names unless the app code changes first.
#Current Deployment Shape
- First-party image:
ghcr.io/readairr/app - Public image tags:
dev,val,prod, andlatest devis published from thedevbranch.valis published from thevalbranch for validation builds.prod,latest,1, and1.0are published from theprodbranch.- Version tags:
v* - Default app port inside the container:
8787 - App deploy directory:
ReadAIrr/App/deploy - Default metadata source:
Goodreads hostedathttps://api.bookinfo.pro - Optional alternate metadata source:
Hardcover hostedathttps://hardcover.bookinfo.pro - Custom metadata source: external
rreading-glassesor another compatible URL managed outside the current Compose stack
#Cloudflare Pages Boundary
The public update API under /v1/update/* is implemented in the ReadAIrr/Site repo as a Cloudflare Pages function. The Docs repo links to that endpoint but does not implement it.
The local OpenAPI file in this Docs repo is copied from ReadAIrr/App/src/Readarr.Api.V1/openapi.json.
#Current Review Notes
The 2026-05-10 documentation pass was checked against current App commits, the working tree visible in ReadAIrr/App, and the live no-auth app at http://192.168.0.228:8787. Major user-facing differences from the previous docs pass include hosted metadata defaults, public GHCR dev/val/prod image channels, server-side Books/Wanted/Unmapped paging and search, Activity Overview, Narrator evidence workflows, manual audio tag editing, metadata confidence review panels, audiobook quality preferences, and metadata-service/database readiness status.
The App OpenAPI bundle was regenerated during this pass with the Swashbuckle CLI version matching the current App packages. It now includes newer controller endpoints for narrator evidence, unmapped review actions, metadata comparison, and audio tag editing.
#Toby Action Items Outside Docs
- Replace the placeholder
ReadAIrr/Sitedeploy credentials in Azure Key Vault if you want future deploys to use the documentedreadairr-deploySSH/SFTP path instead of the Proxmox root/LXC handoff path. - Confirm the
.228host control path for the no-auth review app. The shared DevOps registry now treatshttp://192.168.0.228:8787as the review truth URL, but this docs pass could not SSH to that host directly. - Redeploy the current App source to the no-auth review app after the
.228host control path is confirmed. The verified live page still displayed older advanced help text mentioning automatic self-hosted and original Readarr metadata. - Public GHCR channel docs should mention
dev,val, andprodwherever the normal image channels are discussed. Major tags1and1.0should stay limited to release/update details unless they become user-facing install recommendations.