Skip to content

Settings Overview

Narratorr’s settings are accessible from Settings in the sidebar. The sidebar has these tabs: General, Audio Tools, Post Processing, Indexers, Download Clients, Search, Notifications, Connectors, Blacklist, Security, Import Lists, and System. Each tab stacks one or more sections on a single scrolling page.

This page documents the settings sections grouped by the tab they live under. Indexers, Download Clients, Notifications, Connectors, Blacklist, Security, and Import Lists have dedicated pages — linked at the bottom.

The General tab stacks the Library, File Naming, Import, Network, Discovery, Ebooks, Appearance, and Onboarding sections.

SettingDescription
Library PathRoot directory where Narratorr stores your audiobooks. In Docker, this maps to /audiobooks.
SettingDescription
PresetApply a naming preset (Standard, Detailed, Audiobookshelf, Plex, Last-First) that fills in both formats below; choosing your own tokens shows as “Custom”.
SeparatorWord separator applied to every rendered token. Options: Space, Period, Underscore, Dash. Default: Space.
CaseCasing transform applied to rendered names. Options: Default, lowercase, UPPERCASE, Title Case. Default: Default (no change).
Folder FormatTemplate for organizing audiobook folders. Uses tokens like {author}/{title}. See Folder Format Tokens.
File FormatTemplate for renaming audiobook files within folders.
SettingDescription
Delete After ImportRemove the downloaded torrent from the download client after files are imported.
Minimum Seed TimeFor torrents: minimum time (in minutes) a torrent must seed before Narratorr removes it. Only applies when Delete After Import is on. Default: 60.
Minimum Seed RatioMinimum upload ratio before removing a torrent. Only applies when Delete After Import is on. Default: 0 (disabled).
Redownload FailedAutomatically search for and grab a different release when a download fails. Default: on.
Minimum Free SpaceBlock imports when free disk space (in GB) is below this threshold. Default: 5. Set to 0 to disable.
SettingDescription
Proxy URLHTTP/HTTPS/SOCKS5 proxy for indexer search and test requests. A per-indexer “Route through proxy” toggle decides which indexers use it. See Network & Proxy.
SettingDescription
Enable DiscoveryToggle the recommendation engine on/off. Default: on.
Refresh IntervalRefresh frequency in hours. Range: 1–168. Default: 24.
Max Suggestions Per AuthorMaximum suggestions per author. Range: 1–50. Default: 5.
Suggestion ExpiryDays before unused suggestions expire. Default: 90.

See Discovery & Recommendations for details.

SettingDescription
Enable ebook supportShow ebooks already stored in a book’s folder, ready to download from the book page. Narratorr doesn’t search for or download ebooks. Enabling this also exposes them over the API, which is how Narratorr Requests offers Download and Send to Kindle. Default: off.
SettingDescription
Dark ModeSwitch between the light and dark theme. Stored per-browser, not in the database.
SettingDescription
Welcome tourRe-display the welcome modal that reviews key defaults and feature highlights.

The Search tab stacks the “When a New Book Is Added”, Search (including the RSS Sync subsection), Metadata, Filtering, and Quality sections.

Defaults applied whenever a book is added (manually, via import lists, or via discovery).

SettingDescription
Search ImmediatelyTrigger a search as soon as a book is added. Default: off.
SettingDescription
Enable Scheduled SearchToggle automatic searching on/off. Default: on.
Search IntervalHow often (in minutes) Narratorr searches for wanted books. Range: 5–1440. Default: 360 (6 hours).
Blacklist TTLHow many days temporary blacklist entries last. Range: 1–365. Default: 7. See Blacklist.
Search PriorityOrder results by Audio Quality (higher bitrate) or Narrator Accuracy (match the narrator from metadata). Default: Narrator Accuracy.
Protocol PreferencePrefer usenet, torrent, or no preference. Affects result ordering but does not exclude results. Default: no preference.

The RSS Sync subsection (at the bottom of the Search section) controls the RSS poller:

SettingDescription
Enable RSS SyncToggle RSS sync on/off. Default: off.
RSS IntervalPoll frequency in minutes. Range: 5–1440. Default: 30.

See RSS Feeds for details.

SettingDescription
RegionAudible region used for metadata lookups (cover art, descriptions, narrators). Options: us, ca, uk, au, fr, de, jp, it, in, es. Default: us.
Hardcover API KeyOptional key that populates the Series card on book pages with Hardcover-canonical members. Without a key, Series cards show only library books sharing the series name. Has a Test button to validate the key.

Gates which search results survive before quality evaluation.

SettingDescription
LanguagesMulti-select of languages to allow. Results in unselected languages are excluded; results with no detected language always pass through. Default: English. Deselect all to disable language filtering.
Minimum DurationMinimum runtime (in minutes) a release must have. Filters promo excerpts, TTS knockoffs, and supplementary clips. Default: 30. Set to 0 to disable.
Reject WordsComma-separated words that exclude a result if matched against its release (NZB) name, raw title, title, author, or narrator. Default: Virtual Voice, Free Excerpt, Sample, Behind the Scenes, Abridged.
Required WordsComma-separated words — at least one must appear in a result’s release name, raw title, title, author, or narrator for it to be kept.

Controls the minimum bar a release must clear to be eligible to grab. See Quality Gates for full details.

SettingDescription
MB/hr Grab MinimumMinimum quality in MB/hour. Releases below this are hidden. Default: 0 (disabled).
Minimum SeedersMinimum seeders for torrent releases (does not affect Usenet). Default: 1. Set to 0 to disable.
Min Download SizeMinimum download size in MB. Filters tracker-test uploads, single-track previews, and corrupt releases. Default: 50. Set to 0 to disable.
Max Download SizeMaximum download size in GB. Larger releases are hidden. Default: 5. Set to 0 to disable.

The Audio Tools tab holds the Merge & Convert section — the engine settings applied wherever audio is merged or converted: the per-book Merge button, bulk Convert, and auto-merge downloads.

Audio processing requires ffmpeg, but there is no path to configure — Narratorr auto-detects the binary (the FFMPEG_PATH environment variable if set, then /usr/bin/ffmpeg, then the system PATH) and shows the result in a status row at the top of the tab, including the detected version and path. In Docker, ffmpeg is pre-installed and always found. For manual installs, install ffmpeg on the system PATH, or point the FFMPEG_PATH environment variable at the binary. There is no master on/off toggle either — merge, convert, and Tag Embedding simply stay off until ffmpeg is detected.

SettingDescription
Output FormatTarget format: m4b or mp3. Default: m4b. (MP3 does not support embedded chapter markers.)
Target BitrateTarget bitrate in kbps (32–512). Default: 128. Ignored when “Keep original” is on.
Keep originalWhen on, the source file’s bitrate is used instead of the target. Note: files are still re-encoded — this drops the bitrate cap, it is not a lossless copy. Default: on.
Merge BehaviorWhen to merge multi-file downloads into a single chaptered file: always, multi-file-only, or never. Default: multi-file-only.
Max Concurrent JobsMaximum number of merge jobs that can run simultaneously — manual and automatic merges share this cap. Range: 1–8. Default: 1.

The Post Processing tab holds the automations that run on their own after a download lands — none run on Library Import or Manual Import. Merge and convert are manual by default (per-book Merge or bulk Convert), but the Auto-merge multi-file downloads toggle opts completed downloads into an automatic merge after import, using the Merge & Convert settings from the Audio Tools tab.

SettingDescription
Auto-merge multi-file downloadsAutomatically merge a completed download’s audio files into a single file once it lands in the library. Applies to downloads only — never Library Import or Manual Import. Default: off.
Post-Processing ScriptAbsolute path to a custom script run after each successful import. See Features Reference.
Script TimeoutMaximum script execution time in seconds. Required when a script is set. Default: 300.

Tagging is nested within this same tab as the Tag Embedding toggle, rather than a separate top-level section:

SettingDescription
Tag EmbeddingWrite book metadata into audio file tags on import. Requires ffmpeg. Default: off.
Tag Modepopulate_missing (only fill empty fields) or overwrite (replace all). Default: populate_missing.
Embed Cover ArtEmbed cover art into audio files. Default: off.
OPF Metadata SidecarWrite a metadata.opf file into each book folder so media servers (Audiobookshelf especially) can read narratorr’s metadata. Works independently of Tag Embedding — no ffmpeg needed. Default: off. See Tagging & Cover Art.

See Audio Processing and Tagging & Cover Art for more detail.

The System tab holds the health dashboard, the Backup Schedule and Backup & Restore sections, system info, the Housekeeping and Logging sections, scheduled tasks, and the Licenses & Third-Party Notices section — attribution and license texts for the FFmpeg binary bundled in the Docker image.

SettingSectionDescription
Backup IntervalBackup ScheduleMinutes between automatic backups. Range: 60–43,200. Default: 10,080 (weekly).
Backup RetentionBackup ScheduleNumber of backups to keep. Range: 1–100. Default: 7.
Event History RetentionHousekeepingHow many days to keep event history entries before pruning. Range: 1–365. Default: 90.
Log LevelLoggingHow verbose Narratorr’s logs are. Options: error, warn, info, debug, trace. Default: info. Turn up to debug when troubleshooting.

See Backup & Restore for details.