Skip to content

Navigation Menu

Sign in
Sign up

Settings Reference

MMagTech edited this page Mar 25, 2026 · 12 revisions

Settings Reference

This page documents every setting available in Nudgarr, grouped by tab. All settings are stored in /config/nudgarr-config.json and are also editable via the web UI.


Settings tab

Scheduler

Setting Default Description
Automatic Sweeps Off Enables the cron-based scheduler. When off, sweeps only run when you press Run Now.
Cron Expression 0 */6 * * * A standard 5-field cron expression defining when sweeps fire. The field is validated on change — an amber glow indicates an invalid expression. See cron syntax below.
Container Time (display only) The current container local time, shown beneath the cron field so you can confirm your schedule at a glance. Controlled by the TZ environment variable.

Note: Nudgarr does not sweep on startup. The first sweep fires when the cron expression next matches, or immediately if you press Run Now.

Maintenance Window

Scheduled sweeps can be suppressed during a defined time window each week. Manual Run Now is never affected — suppression applies only to cron-triggered fires.

Setting Default Description
Enable Maintenance Window Off Toggle to activate the window. When off, all other maintenance window fields are greyed out and the window has no effect.
Start Time (empty) Time in 24-hour HH:MM format when the suppression window begins.
End Time (empty) Time in 24-hour HH:MM format when the suppression window ends. Overnight ranges are supported — a window from 23:00 to 07:00 stays active past midnight until 07:00.
Days (none) Individual day-of-week pill toggles (Mon through Sun). The window only suppresses sweeps on the selected days. If no days are selected the feature has no effect even when enabled.

A hint line below the time inputs describes the active window once both times and at least one day are set, and explicitly flags overnight ranges. Suppressed sweeps are logged at INFO level.

Cron syntax

Nudgarr uses standard 5-field cron: minute hour day-of-month month day-of-week

Example Meaning
0 */6 * * * Every 6 hours on the clock (default)
0 * * * * Every hour
30 2 * * * Daily at 02:30 container time
*/30 * * * * Every 30 minutes

Use the TZ environment variable to make the schedule fire in your local timezone rather than UTC.


Search Limits

Setting Default Description
Max Movies per Run 1 Maximum number of Cutoff Unmet movies to search per sweep.
Max Episodes per Run 1 Maximum number of Cutoff Unmet episodes to search per sweep.
Cooldown (hours) 48 How long Nudgarr waits before searching the same item again. Applies to both Cutoff Unmet and Backlog searches.

Throttling

Setting Default Description
Batch Size 1 Number of items sent in a single search API call. Increasing this reduces the number of API calls but may exceed indexer limits.
Sleep (seconds) 5 Fixed wait between batches during a sweep.
Jitter (seconds) 2 Random additional wait added on top of Sleep, up to this value. Helps avoid predictable API timing patterns.

Sample Mode

Controls the order in which eligible items are picked for searching. Set independently for Radarr and Sonarr.

Mode Behaviour
Random Picks items in a random order each run (default)
Alphabetical Picks items sorted A → Z by title
Oldest Added Prioritises items added to your library first
Newest Added Prioritises items added most recently

Advanced tab

The Advanced tab has two areas:

  • Left card — split into two pages using the and arrows at the top
  • Right card — always visible, contains Data Retention, Import Check, Security, and UI Preferences

Left card — Page 1: Backlog Nudges

Backlog settings control the optional missing-content search. Disabled by default. See Radarr & Sonarr Backlog for full details.

Setting Default Description
Radarr Backlog Off Enables missing movie searches for Radarr instances
Radarr Missing Max 1 Max missing movies to search per sweep per instance
Radarr Missing Added Days 14 Only search movies added at least this many days ago. 0 disables the age filter.
Sonarr Backlog Off Enables missing episode searches for Sonarr instances
Sonarr Missing Max 1 Max missing episodes to search per sweep per instance

Note: Sonarr does not have a Missing Added Days filter — that setting is Radarr only.

Page 1 also contains the Per-Instance Overrides toggle under "For the Arr-tists". Enabling it adds an Overrides tab to the main navigation. See Per-Instance Overrides for full details.

Left card — Page 2: Auto-Exclusion

Setting Default Description
Auto-Exclude Movies After 0 Auto-exclude a movie after this many searches with no confirmed import. 0 disables auto-exclusion for Radarr entirely and greys out the Unexclude Days field.
Unexclude Movies After (days) 0 Automatically remove a movie from auto-exclusions after this many days, making it eligible for searching again. 0 means auto-excluded movies stay excluded until manually removed. Only active when the threshold above is above 0.
Auto-Exclude Shows After 0 Auto-exclude a show after this many searches with no confirmed import. 0 disables auto-exclusion for Sonarr entirely.
Unexclude Shows After (days) 0 Automatically remove a show from auto-exclusions after this many days. 0 means auto-excluded shows stay excluded until manually removed.

Right card — always visible

Setting Default Description
State Retention (days) 180 History and cooldown entries older than this are pruned on the next sweep. 0 disables pruning.
Import Check (minutes) 120 How often Nudgarr polls Radarr/Sonarr to confirm imports. Runs on its own independent timer. Also triggers the auto-exclusion evaluation after each cycle.
Require Login On Requires login before accessing the UI. Disabling removes the login screen entirely.
Session Timeout (minutes) 30 Minutes of inactivity before requiring re-login.
Show Support Link On Controls whether the donate/support link appears in the header.
Log Level INFO Nudgarr's logging verbosity — DEBUG, INFO, WARNING, or ERROR. Takes effect immediately without a container restart. Log output goes to stdout and /config/logs/nudgarr.log.

Onboarding: A Replay button under UI Preferences lets you re-run the first-run walkthrough at any time.

Import check interval and auto-exclusion: Auto-exclusion evaluates titles at the end of each import check cycle, not during the sweep. If your import check interval is longer than your cron schedule, a title may accumulate extra searches before it is evaluated. To keep auto-exclusion responsive, set the import check interval equal to or shorter than your cron schedule.

If you forget your password, stop the container, delete nudgarr-config.json, and restart — Nudgarr will re-run onboarding. You will need to re-enter all settings.

Danger Zone

At the bottom of the Advanced tab. All actions are irreversible.

Button What it does
Reset Config Resets all settings to factory defaults. Your history and database are preserved.
Reset Auto-Exclusions Removes all auto-excluded entries. Manual exclusions are not affected.
Clear History Deletes all search history entries. Cooldown records are removed — all items become immediately eligible for searching. Intel data is not affected.
Clear Stats Deletes all confirmed import entries from the Imports tab. Lifetime Movies and Episodes totals are not affected. Intel data is not affected.
Clear Log Truncates the active nudgarr.log to zero bytes. The log resumes writing immediately. Rotation backups are unaffected.
Reset Intel Permanently clears all Intel dashboard data — resets the lifetime aggregate to zero and deletes all exclusion event history. Intel data begins accumulating again immediately on the next sweep. Does not affect search history, confirmed imports, exclusions, or any other data.

Notifications tab

See Notifications (Apprise) for full setup instructions.

Setting Default Description
Notifications Enabled Off Master toggle for all push notifications
Apprise URL (empty) One or more Apprise-format notification URLs
Notify on Sweep Complete On Send a notification after each sweep with a summary of searches and skips
Notify on Import On Send a notification when a confirmed import is detected
Notify on Auto-Exclusion On Send a notification when a title is auto-excluded, including the title, search count, and instance name
Notify on Error On Send a notification when a sweep or instance error occurs

Clone this wiki locally

AltStyle によって変換されたページ (->オリジナル) /