# Readarr •

[Readarr](https://readarr.com/) 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](https://goodreads.com) or import lists to keep up-to-date. Always be sure that your media has the correct metadata for your [Audiobookshelf](https://hub.subspace.services/books/audiobookshelf "Audiobookshelf ") or [Kavita](https://hub.subspace.services/books/kavita "Kavita") media server.

# Overview

[![Screen Shot 2025-03-07 at 12.01.28.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-12-01-28.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-12-01-28.png)

[Readarr](https://readarr.com/) 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](https://goodreads.com) or import lists to keep up-to-date. Always be sure that your media has the correct metadata for your [Audiobookshelf](https://hub.subspace.services/books/audiobookshelf "Audiobookshelf ") or [Kavita](https://hub.subspace.services/books/kavita "Kavita") media server.

<p class="callout warning">This software is currently in beta and may change at any time.</p>

- Connects to [Prowlarr](https://hub.subspace.services/books/prowlarr "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

<p class="callout info">Readarr v0.4.10.2734</p>

<table border="1" id="bkmrk-" style="border-collapse: collapse; width: 100%; border-width: 1px; height: 59.6px; border-color: rgb(88, 110, 117);"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr style="height: 29.8px;"><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 12.01.28.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-12-01-28.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-12-01-28.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 12.01.43.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-12-01-43.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-12-01-43.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 12.01.47.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-12-01-47.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-12-01-47.png)</td></tr><tr style="height: 29.8px;"><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 12.01.51.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-12-01-51.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-12-01-51.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 12.01.57.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-12-01-57.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-12-01-57.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 12.02.02.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-12-02-02.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-12-02-02.png)</td></tr><tr><td style="border-width: 1px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 12.02.06.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-12-02-06.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-12-02-06.png)</td><td style="border-width: 1px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 12.02.15.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-12-02-15.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-12-02-15.png)</td><td style="border-width: 1px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 12.10.18.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-12-10-18.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-12-10-18.png)</td></tr></tbody></table>

# 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

<details id="bkmrk-media-folders-radarr"><summary>Persistent Data</summary>

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

<p class="callout warning">Ensure your user has permissions to access the folder.</p>

</details><details id="bkmrk-media-folders-readar"><summary>Media Folders</summary>

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

<p class="callout warning">Ensure your user has permissions to access the folder.</p>

</details><details id="bkmrk-download-folder-rada"><summary>Download Folders</summary>

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

<p class="callout warning">Ensure your user has permissions to access the folder.</p>

</details>## Environment

<details id="bkmrk-tz-this-is-the-curre"><summary>TZ</summary>

This is the current time zone formatted using the [tz database.](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)

<p class="callout info">*For example:* America/Vancouver</p>

</details><details id="bkmrk-gid-%C2%A0"><summary>PUID</summary>

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

```bash
id -u
```

</details><details id="bkmrk-pgid-this-is-the-num"><summary>PGID</summary>

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

```bash
id -g
```

</details>

# Installation

The service can be installed through the Portainer web interface.

<p class="callout info">Learn about [creating a new stack](https://hub.subspace.services/books/portainer/page/creating-a-new-stack "Creating a New Stack").</p>

## Docker Compose

Use the following code to install the service:

```yaml
---
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

<p class="callout success">Re-Deploy the Stack</p>

This service has been optimized for running in Docker thanks to [LinuxServer.io](https://linuxserver.io).

This allows you to [re-deploy the stack through Portainer](https://hub.subspace.services/books/portainer/page/updating-a-stack "Updating a Stack") to download the latest updates.

# User Manual

# Development

<p class="callout info">This software is released under the [GPL-3.0 license](https://opensource.org/license/gpl-3-0).</p>

The software was developed as a form of [Sonarr](https://hub.subspace.services/books/sonarr "Sonarr"). Readarr is made available for Docker through the efforts of [LinuxServer.io](https://docs.linuxserver.io/images/docker-lidarr/) and their commitment to simplifying self-hosting.

You can learn more about how to contribute to Readarr through their [documentation](https://wiki.servarr.com/readarr/contributing).

The Readarr development team also accepts [donations](https://readarr.com/donate).

# Resources

## Official

- [Official Wiki](https://wiki.servarr.com/readarr)
- [Official Discord](https://readarr.com/discord)
- [Official GitHub Repository](https://github.com/Readarr/Readarr)
- [Official Website](https://readarr.com)
- [Installation Guide](https://wiki.servarr.com/readarr/installation)
- [Quick Start Guide](https://wiki.servarr.com/readarr/quick-start-guide)
- [Frequently Asked Questions](https://wiki.servarr.com/readarr/faq)
- [General Troubleshooting](https://wiki.servarr.com/readarr/troubleshooting)

## LinuxServer.io

- [Docker Image](https://docs.linuxserver.io/images/docker-readarr/)
- [Official Website](https://www.linuxserver.io/)
- [Official Documentation](https://docs.linuxserver.io/)
- [Official Discord](https://linuxserver.io/discord)
- [Official Forum](https://discourse.linuxserver.io/)
- [Official GitLab Repository ](https://gitlab.com/Linuxserver.io)
- [Frequently Asked Questions](https://docs.linuxserver.io/FAQ/)