Readarr •
Readarr is a free and open-source media management tool that can automatically download, organize and manage your ebook and audiobook collection.  Organize your existing collection, add new authors from GoodReads or import lists to keep up-to-date.  Always be sure that your media has the correct metadata for your Audiobookshelf or Kavita media server.

Overview
Readarr is a free and open-source media management tool that can automatically download, organize and manage your ebook and audiobook collection.  Organize your existing collection, add new authors from GoodReads or import lists to keep up-to-date.  Always be sure that your media has the correct metadata for your Audiobookshelf or Kavita media server. 

 This software is currently in beta and may change at any time. 

 

 Connects to Prowlarr to aggregate Usenet and Torrent queries to multiple sources into one unified search result. 

 View all of your upcoming books on a calendar and export it for your calendar app. 

 Perform automatic searches to find media within your specifications, or manually search through the results. 

 Blacklist any failed downloads and Radarr will search for a different download. 

 Add a single book to your library, or make sure you have every book from that author.

Media
Screenshots 

 Readarr v0.4.10.2734

Setup & Configuration
We need to install the service through Portainer and configure any necessary settings.

Preparation
There are some things we need to do in preparation to install this service. 

 Volumes 

 

 Persistent Data 

 This is where the service will store its own application data and ensures we can quickly update the service image. 

 Ensure your user has permissions to access the folder. 

 

 

 Media Folders 

 Readarr will need access to the folders where you store your book and audiobook files.  

 Ensure your user has permissions to access the folder. 

 

 

 Download Folders 

 Readarr will need access to the folder where you torrent or usenet folder store their completed downloads. 

 Ensure your user has permissions to access the folder. 

 

 

 Environment 

 

 TZ 

 This is the current time zone formatted using the tz database. 

 For example: America/Vancouver 

 

 

 PUID 

 This is the numeric ID of the user account on Debian.  If you are unsure, open a terminal and run: 

 id -u 

 

 

 PGID 

 This is the numeric ID of the user account's group on Debian.  If you are unsure, open a terminal and run: 

 id -g

Installation
The service can be installed through the Portainer web interface.  

 Learn about creating a new stack . 

 

 Docker Compose 

 Use the following code to install the service: 

 ---

services:

 readarr:

 image: lscr.io/linuxserver/readarr:latest

 container_name: readarr

 network_mode: bridge

 environment:

 - PUID=1000

 - PGID=1000

 - TZ=America/Vancouver

 volumes:

 # Persistent Data

 - /srv/readarr/:/config

 # Media Folders

 - /mnt/books:/mnt/book

 # Download Folders

 - /media/data/Enclave:/media/data/Enclave

 ports:

 - 8787:8787

 restart: unless-stopped

Updating
Re-Deploy the Stack 

 This service has been optimized for running in Docker thanks to  LinuxServer.io .

 

 This allows you to  re-deploy the stack through Portainer to download the latest updates. 

User Manual



Development
This software is released under the  GPL-3.0 license . 

 The software was developed as a form of  Sonarr .  Readarr is made available for Docker through the efforts of LinuxServer.io and their commitment to simplifying self-hosting. 

 You can learn more about how to contribute to Readarr through their documentation .  

 The Readarr development team also accepts  donations .

Resources
Official 

 

 Official Wiki 

 Official Discord 

 Official GitHub Repository 

 Official Website 

 Installation Guide 

 Quick Start Guide 

 Frequently Asked Questions 

 General Troubleshooting   

 

 LinuxServer.io 

 

 Docker Image 

 Official Website 

 Official Documentation 

 Official Discord 

 Official Forum 

 Official GitLab Repository  

 Frequently Asked Questions