Skip to content

Maintainerr - Rules

Configuration options for maintainerr rules.

Available Options

This page documents 13 configuration options.

nixflix.maintainerr.rules

Rule groups to declaratively manage in Maintainerr. Rule groups present in Maintainerr but not listed here will be deleted.

Note: changing dataType, library, manualCollection, or manualCollectionName on an existing rule group causes Maintainerr to clear all media currently in that collection.

Typelist of (submodule)
Default
[ ]
Example
[
  {
    name = "Movies To Delete";
    description = "Deletes movies that have been watched or around too long.";
    library = "Movies";
    dataType = "movie";
    radarrServerName = "Radarr";
    collection.deleteAfterDays = 14;
    rules = [
      {
        customVal = { ruleTypeId = 3; value = "1"; };
        operator = null;
        firstVal = [ 6 42 ];
        action = "EQUALS";
        section = 0;
      }
    ];
  }
]
Declared inmodules/maintainerr/rules/options.nix

nixflix.maintainerr.rules.*.arrAction

Action taken on media when deleteAfterDays elapses (ServarrAction).

Type(one of 7, 0, 5, 4, 3, 1, 2, 6) or (one of "CHANGE_QUALITY_PROFILE", "DELETE", "DELETE_SHOW_IF_EMPTY", "DO_NOTHING", "UNMONITOR", "UNMONITOR_DELETE_ALL", "UNMONITOR_DELETE_EXISTING", "UNMONITOR_SHOW_IF_EMPTY") convertible to it
Default
"DO_NOTHING"
Declared inmodules/maintainerr/rules/options.nix

nixflix.maintainerr.rules.*.dataType

Media type this rule group operates on.

Typeone of "movie", "show", "season", "episode"
Declared inmodules/maintainerr/rules/options.nix

nixflix.maintainerr.rules.*.description

Description of the rule group.

Typestring
Default
""
Declared inmodules/maintainerr/rules/options.nix

nixflix.maintainerr.rules.*.forceSeerr

Force deletion through Jellyseerr even when media has no active request.

Typeboolean
Default
false
Declared inmodules/maintainerr/rules/options.nix

nixflix.maintainerr.rules.*.isActive

Whether this rule group is active.

Typeboolean
Default
true
Declared inmodules/maintainerr/rules/options.nix

nixflix.maintainerr.rules.*.library

Jellyfin library title to target. Resolved to an ID at runtime via GET /api/media-server/libraries.

Typestring
Example
"Movies"
Declared inmodules/maintainerr/rules/options.nix

nixflix.maintainerr.rules.*.listExclusions

Add handled media to the Maintainerr exclusion list.

Typeboolean
Default
true
Declared inmodules/maintainerr/rules/options.nix

nixflix.maintainerr.rules.*.name

Rule group name as it appears in Maintainerr.

Typestring
Example
"Movies To Delete"
Declared inmodules/maintainerr/rules/options.nix

nixflix.maintainerr.rules.*.radarrServerName

Name of the Radarr server configured in nixflix.maintainerr.settings.radarr to associate with this rule group. Resolved to an integer ID at runtime.

Typenull or string
Default
null
Example
"Radarr"
Declared inmodules/maintainerr/rules/options.nix

nixflix.maintainerr.rules.*.ruleHandlerCronSchedule

Custom cron schedule for this rule group. null uses the global Maintainerr schedule.

Typenull or string
Default
null
Example
"0 4 * * *"
Declared inmodules/maintainerr/rules/options.nix

nixflix.maintainerr.rules.*.sonarrServerName

Name of the Sonarr server configured in nixflix.maintainerr.settings.sonarr to associate with this rule group. Resolved to an integer ID at runtime.

Typenull or string
Default
null
Example
"Sonarr"
Declared inmodules/maintainerr/rules/options.nix

nixflix.maintainerr.rules.*.useRules

Whether to use the rules engine (false = manual collection only).

Typeboolean
Default
true
Declared inmodules/maintainerr/rules/options.nix