Skip to content

Book Manager and Automation (Sonarr for Ebooks)

License

Notifications You must be signed in to change notification settings

maddefientist/Readarr

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10,648 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Readarr Revival - OpenLibrary Edition

This is a community revival fork of Readarr. The original project was retired due to metadata source issues. This fork addresses those issues and brings Readarr back to production-ready status.

What's New in This Fork

✅ Complete Metadata Overhaul

  • Replaced broken BookInfo with Open Library integration
  • Resilient metadata fetching with retry logic and circuit breakers
  • Aggressive caching (30-90 day TTLs) to minimize API dependencies
  • Graceful degradation when metadata services are unavailable

✅ Modernized Stack

  • Upgraded to .NET 8 LTS (supported through November 2026)
  • Updated all dependencies for security and compatibility
  • Improved performance and security posture

✅ Docker-First Deployment

  • Production-ready Dockerfile with multi-stage builds
  • Docker Compose for easy deployment
  • Health checks and proper signal handling
  • Both SQLite and PostgreSQL support

✅ Improved Operations

  • Automated housekeeping (33 maintenance tasks)
  • Comprehensive health monitoring
  • Backup and restore procedures
  • Detailed operational documentation

✅ CI/CD & Security

  • GitHub Actions for automated builds and tests
  • Dependabot for dependency updates
  • Security scanning (CodeQL, Trivy, TruffleHog)
  • Vulnerability disclosure policy

Quick Start (Docker)

git clone https://github.com/maddefientist/Readarr.git
cd Readarr
cp .env.example .env
# Edit .env with your settings
docker compose up -d

Access at: http://localhost:8787

Documentation

Revival Status

Component Status
.NET 8 Upgrade ✅ Complete
Open Library Integration ✅ Complete
Docker Deployment ✅ Complete
CI/CD Pipeline ✅ Complete
Documentation ✅ Complete

Original README

Note from original Servarr team: The Readarr project was officially retired in June 2025 due to metadata source issues. This community fork addresses those issues.

Readarr

Build Status Translated Docker Pulls Donors on Open Collective Sponsors on Open Collective Mega Sponsors on Open Collective

Readarr is currently in beta testing and is generally still in a work in progress. Features may be broken, incomplete, or cause spontaneous combustion

Readarr is an ebook and audiobook collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new books from your favorite authors and will grab, sort, and rename them. Note that only one type of a given book is supported. If you want both an audiobook and ebook of a given book you will need multiple instances.

Major Features Include

  • Can watch for better quality of the ebooks and audiobooks you have and do an automatic upgrade. e.g. from PDF to AZW3
  • Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
  • Automatically detects new books
  • Can scan your existing library and download any missing books
  • Automatic failed download handling will try another release if one fails
  • Manual search so you can pick any release or to see why a release was not downloaded automatically
  • Advanced customization for profiles, such that Readarr will always download the copy you want
  • Fully configurable book renaming
  • SABnzbd, NZBGet, QBittorrent, Deluge, rTorrent, Transmission, uTorrent, and other download clients are supported and integrated
  • Full integration with Calibre (add to library, conversion) (Requires Calibre Content Server)
  • And a beautiful UI

Support

Wiki Discord

Note: GitHub Issues are for Bugs and Feature Requests Only

GitHub - Bugs and Feature Requests Only

Contributors & Developers

API Documentation

This project exists thanks to all the people who contribute.

Contributors List

Backers

Thank you to all our backers! 🙏 Become a backer

Backers List

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor

Sponsors List

Mega Sponsors

Mega Sponsors List

DigitalOcean

This project is also supported by DigitalOcean

License

About

Book Manager and Automation (Sonarr for Ebooks)

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 68.2%
  • JavaScript 28.3%
  • CSS 1.8%
  • TypeScript 1.4%
  • Shell 0.2%
  • HTML 0.1%