ReadAIrr is a renamed fork of Readarr. Some inherited screenshots, executable names, config keys, API labels, and custom-script environment variables still say Readarr where the current app repo still requires that compatibility name. {.is-info}

#Table of Contents

This page will go through all the settings available in ReadAIrr and how they work. This is not meant to be a comprehensive "how to set up ReadAIrr." If you want that, please use the Quick Start page instead.

#Menu options

To get to the Settings page, please choose Settings from the left menu. The following sub-menu options will be available:

settings_1_menu.png

Also, note that for each individual settings page, there are some options at the top of the menu:

settings_2_topmenu.png

#Media Management

Some of these settings are only visible through Show Advanced Settings which is on the top bar under the search bar{.is-info}

#Root Folders

#Root Folder Settings

{#calibre}

* Only for use with ebooks, not audiobooks! * Note that this cannot be enabled on an existing root folder. * Note that this cannot be disabled on an existing Calibre enabled root folder. * Note that this requires Calibre Content Server and will not work with Calibre Web nor Calibre. * Note that hard links do not work with Calibre integration. * Note that this requires that Calibre to have Require username and password to access the content server to be enabled. * Failure to have Require username and password to access the content server enabled in Calibre will result in an error of Anonymous users are not allowed to make changes {.is-warning}

Non-Windows Users: * If you're using an NFS mount ensure nolock is enabled. * If you're using an SMB mount ensure nobrl is enabled. {.is-warning}

#Remote Path Mappings

#Book File Naming

bookfilenaming.png

If you are using Calibre integration, you do not get to name book files. Calibre takes care of this for you. You should only change these settings if you are not using Calibre.

Please note that while ReadAIrr is in beta; if you use Calibre it is recommended to disable Renaming in ReadAIrr just in case an unintended bug slips through. `{.is-info}

Commonly used naming schema are:

#Book Naming

If you leave Rename Books unchecked, then none of the naming below applies - you have told ReadAIrr you do not want any renaming done at all. The book will be imported directly into the author folder. {.is-info}

This does not apply if Calibre is used as Calibre handles file/folder naming using its own internal schema. {.is-info}

#Standard Book Format

#Author

#Book

#Release Date

#Quality

#Media Info

#Other

#Original

Original Filename is not recommended. It is the literal original filename and may be obfuscated t1i0p3s7i8yuti. Original Title is the release name and should be used instead. {.is-info}

#Author Folder Format

This does not apply if Calibre is used as Calibre handles file/folder naming using its own internal schema. {.is-info}

#Author

#Folders

mm_folders.png

One of those boxes can be checked, but they should not BOTH be checked. {.is-warning}

This does not apply if Calibre is used as Calibre handles file/folder naming using its own internal schema. {.is-info}

#Importing

mm_importing.png

You should ideally use this wherever possible. In order for hard links to be used, you must have your source/destination on the same file system (drive, partition) and mount points. See TRaSH's Hardlink Guide for more information

If you are using ReadAIrr for audiobooks, you should add .cue to this list, as it holds your chapter information! {.is-info}

#File Management

mm_filemgmt.png

* PROPER - means there was a problem with the previous release. Downloads tagged as PROPER shows that the problems have been fixed in that release. This is done by a Group that did not release the original. * REPACK - means there was a problem with the previous release and is corrected by the original Group. Downloads tagged as REPACK shows that the problems have been fixed in that release. This is done by a Group that did release the original. {.is-info}

It is highly recommended that you use a Recycling Bin. It's easy to delete files, and recovering them is easy if you use the bin. {.is-warning}

#Permissions

The drop down box has a preset list of very commonly used permissions that can be used. However, you can manually enter a folder octal if you wish. {.is-info}

This only works if the user running ReadAIrr is the owner of the file. It's better to ensure the download client sets the permissions properly. {.is-warning}

This only works if the user running ReadAIrr is the owner of the file. It's better to ensure the download client sets the permissions properly. {.is-warning}

#Profiles

#Quality Profiles

Quality profiles are used to determine what formats of books are acceptable for a book in your library.

qualityprofile.png

When selecting an existing profile or adding an additional profile a new window will appear Note: The quality which has a blue box is the quality at which any media with this profile will continue to be upgraded to. {.is-info}

Note: This is only applicable if you have AZW3 higher than EPUB within the Qualities section {.is-warning}

By default the qualities are set from "worst" (bottom) to "best" (top) {.is-info}

#Metadata Profiles

Metadata profiles are used to determine which books from GoodReads to add under an author when a new author is added.

metaprofiles.png

Setting this too high will result in books not being added to ReadAIrr, but setting it too low will result in obscure publications showing up. {.is-warning}

Set this to 10000000000 exactly to create a profile equivalent to None but still allow other filtering of editions and books. Note that None does not apply any metadata filters and you may get foreign editions. {.is-info}

You may create multiple metadata profiles, and apply a separate one to each author as needed. But, you may only apply a single metadata profile to any given author. {.is-info}

#Release Profiles

Release profiles are used to determine if indexer release names qualify for downloading.

releaseprofiles.png

Releases with a higher preferred word score than the existing file are ALWAYS an upgrade! {.is-info}

You should include {Preferred Words} in your file naming, and check this box if you're using them, because otherwise you can end up in a download loop. {.is-warning}

#Delay Profiles

#Uses

Some media will receive half a dozen different releases of varying quality in the hours after a release, and without delay profiles ReadAIrr might try to download all of them. With delay profiles, ReadAIrr can be configured to ignore the first few hours of releases.

Delay profiles are also helpful if you want to emphasize one protocol (Usenet or BitTorrent) over the other. (See Example 3)

#How Delay Profiles Work

The timer begins as soon as ReadAIrr detects a books has a release available. This release will show up in your Queue with a clock icon to indicate that it is under a delay.

The clock starts from the releases uploaded time and not from the time ReadAIrr sees it. {.is-info}

During the delay period, any new releases that become available will be noted by ReadAIrr. When the delay timer expires, ReadAIrr will download the single release which best matches your quality preferences.

The timer period can be different for Usenet and Torrents. Each profile can be associated with one or more tags to allow you to customize which shows have which profiles. A delay profile with no tag is considered the default and applies to all shows that do not have a specific tag.

Delay profiles start from the time stamp that the indexer reports the release was uploaded. This means that any content older than the number of minutes you have set are not impacted in any way by your delay profile, and will be downloaded immediately. In addition, any manual searches for content (non-RSS feed searches) will ignore delay profile settings. {.is-warning}

#Examples

#Example 1
#Example 2
#Example 3

#Quality

qualitydefinitions.png

#Quality Table Meanings

#Qualities Defined

#Indexers

Information on supported indexers can be found at the More Info (Supported) page for this section {.is-info}

#Supported Indexers

#Indexer Settings

#Usenet Indexer Configuration

#Torrent Tracker Configuration

#Options

If ReadAIrr has been offline for an extended period of time, ReadAIrr will attempt to page back to find the last release it processed in an attempt to avoid missing a release. As long as your indexer supports paging and it hasn’t been too long will be able to process the releases it would have missed and avoid you needing to perform a search for the missed releases.{.is-info}

#Download Clients

Information on supported download clients can be found at the More Info (Supported) page for this section {.is-info}

#Overview

#Download Client Processes

#Usenet Process

#Torrent Process

#Download Clients

Click on Settings =>Download Clients`, and then click the + to add a new download client. Your download client should already be configured and running.

#Supported Download Clients

Select the download client you wish to add, and there will be a pop-up box to enter connection details. These details are similar for most clients. Some will ask for a username or password, some will ask for whether to add new downloads in a paused/start state, etc.

#Usenet Client Settings

#Torrent Client Settings

#Torrent Client Remove Download Compatibility

Client Ratio Time
Aria2 :white_check_mark: :x:
Deluge :white_check_mark: :x:
Download Station :x: :x:
Flood :white_check_mark: :white_check_mark:
Hadouken :x: :x:
qBittorrent :white_check_mark: :white_check_mark:
rTorrent :white_check_mark: :white_check_mark:
Torrent Blackhole :x: :x:
Transmission :white_check_mark: Idle Limit
uTorrent :white_check_mark: :white_check_mark:
Vuze :white_check_mark: :white_check_mark:

Idle Limit - Transmission internally has an Idle Time check, but ReadAIrr compares it with the seeding time if the idle limit is set on a per-torrent basis. This is done as workaround to Transmission’s api limitations.{.is-info}

#Completed Download Handling

#Remove Completed Downloads

If you download using a BitTorrent client, the process is slightly different:

#Failed Download Handling

#Remote Path Mappings

If both *Arr and your Download Client are Docker Containers it is rare a remote path map is needed. It is suggested you review the Docker Guide and/or follow TRaSH's Tutorial {.is-info}

#Import Lists

Information on supported list types can be found at the More Info (Supported) page for this section {.is-info}

Import lists allow you to add items to ReadAIrr automatically from your GoodReads shelves or from other users. This has the potential to add a lot of unexpected items to your ReadAIrr database, so please use it with care.

importlists.png

#Import Lists

This shows you the lists you currently have, and allows you to add new lists. Adding lists is covered below in more detail.

#Import List Exclusions

Anything on here has been excluded from being added by lists, and will never be added from any list. You can remove items from this by clicking on it.

#Adding an Import List

After clicking the +, choose what kind of list you'd like to add:

addlist.png

In this instance, we're going to add a GoodReads Bookshelf list.

bookshelflist.png

This is going to add all authors, and ALL BOOKS from that author, to ReadAIrr!

It is highly recommended that you add a descriptive tag here. Otherwise, you will not know what list added these items to ReadAIrr, and once they're added you can never get this information again! This info is not logged!

Lists sync by default every 24 hours, but can be triggered manually from the Settings => Tasks page. You cannot automate this process any quicker than that.

#Connect

Information on supported connection types can be found at the More Info (Supported) page for this section {.is-info}

#Connections

Connections are how you want ReadAIrr to communicate with the outside world.

#Connection Triggers

#Metadata

{#write-metadata-to-book-files}

Information on supported metadata consumers can be found at the More Info (Supported) page for this section {.is-info}

This page allows you to create/update metadata tags/covers.

metadata.png

#Calibre Metadata

If you are using Calibre to manage your ebook collection, you will use these options to control it.

#Write Metadata to Audio Files

If you are using audiobooks, you will use these options to control it.

Current builds also include manual audio tag editing on book files. The audio tag editor can preview and write proposed tags, including a plexAudiobook template that uses book title as album, author as album artist, narrator as performer, an Audiobook genre fallback, and preserved safe file order. Narrator values come from accepted contributor evidence where available.

#Tags

It is highly recommended that you add a descriptive tag to an Import List aside from what is mentioned above.

Note: Tags do not influence any "Quality Profiles", "Metadata Profiles" or any other aspect not mentioned above. {.is-info}

#General

This page is for general ReadAIrr settings that are not covered in other sections.

#Host

genhost.png

Note: If using Docker do not touch this setting. {.is-warning}

Note: If using a reverse proxy (example: mydomain.com/readarr) you would enter '/readarr' for URL Base. {.is-info}

Note: Do not use this unless you know what you're doing. {.is-warning}

#Security

gensecurity.png

#Proxy

genproxy.png

#Logging

genlogging.png

#Analytics

genanalytics.png

#Updates

genupdates.png

#Updates

#Backups

genbackups.png

By default, backups are performed every 7 days, and the last 4 are kept.

#Development

ReadAIrr adds a Development settings page for selecting the metadata provider source, tuning matching behavior, and configuring manual AI/STT-assisted review workflows.

#Metadata Provider Source

Option Value
Goodreads hosted https://api.bookinfo.pro
Hardcover hosted https://hardcover.bookinfo.pro
Custom rreading-glasses URL Any valid compatible metadata URL, with http://rreading-glasses:8788 shown as an example

New installs default to the hosted Goodreads-compatible source in the current App source. The current app deploy files do not create or update rreading-glasses containers. Use a custom URL only when you operate a compatible service yourself and ReadAIrr can reach it from the runtime environment.

The live no-auth review app checked on 2026-05-10 still displayed older advanced help text that mentions automatic self-hosted rreading-glasses and original Readarr metadata. Treat that as deployment/version drift until the current App source is redeployed to that host.

Use Test Metadata Source before saving a custom source or when author/book metadata searches stop working. The test sends the pending source value to /config/development/test, defaults a blank value to https://api.bookinfo.pro in current source, validates custom values as HTTP/HTTPS URLs, and checks the metadata author/3389 route. Backend compatibility still accepts readarr://metadata/original. The result shows whether the source is reachable, details from the response, and the HTTP status when one is available.

#Matching

Setting Default Range Effect
Minimum Book Match Similarity 80 50 to 100 Rejects automatic and manual import matches below this confidence percentage

The default 80 matches the inherited Readarr behavior. Raise this value if imports are too permissive, or lower it if good files are being rejected with "Book match is not close enough" during downloads or manual import.

#AI / Deep Identification

AI Review and Deep Identify are opt-in manual actions for selected unmapped files. Normal matching does not require OpenRouter or speech-to-text.

Setting Purpose
OpenRouter enabled Enables manual AI Review suggestions for selected unmapped files
OpenRouter API key Stored server-side and redacted in API responses
OpenRouter base URL Defaults to https://openrouter.ai/api/v1
OpenRouter model Model used for manual AI Review suggestions
Timeout Request timeout in seconds
Max files per AI review Limits selected-file context sent to the provider

AI Review sends selected file path/name, parsed metadata, candidate summary, confidence, and rejection reasons to your configured provider. Suggestions are review-only and never auto-import.

#Speech-to-Text

Deep Identify Audio is manual-triggered only. When a speech-to-text provider is configured, ReadAIrr sends only the configured intro segment for selected files.

Provider option Notes
Disabled Deep Identify Audio will not send audio to a provider
OpenRouter speech-to-text Uses the OpenRouter settings and default model such as openai/whisper-1
OpenAI-compatible speech-to-text Uses the provider API key, base URL, and model configured on this page

#UI (User Interface)

This page allows you to customize the user interface display options.

#Calendar

uicalendar.png

#Dates

caldates.png

#Style

calstyle.png

#Language

callanguage.png