Maintainerr - Rules¶
Configuration options for maintainerr rules.
Available Options
This page documents 13 configuration options.
Additional Options¶
This page has the following additional 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.
| Type | list of (submodule) |
| Default | |
| Example | |
| Declared in | modules/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 | |
| Declared in | modules/maintainerr/rules/options.nix |
nixflix.maintainerr.rules.*.dataType¶
Media type this rule group operates on.
| Type | one of "movie", "show", "season", "episode" |
| Declared in | modules/maintainerr/rules/options.nix |
nixflix.maintainerr.rules.*.description¶
Description of the rule group.
| Type | string |
| Default | |
| Declared in | modules/maintainerr/rules/options.nix |
nixflix.maintainerr.rules.*.forceSeerr¶
Force deletion through Jellyseerr even when media has no active request.
| Type | boolean |
| Default | |
| Declared in | modules/maintainerr/rules/options.nix |
nixflix.maintainerr.rules.*.isActive¶
Whether this rule group is active.
| Type | boolean |
| Default | |
| Declared in | modules/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.
| Type | string |
| Example | |
| Declared in | modules/maintainerr/rules/options.nix |
nixflix.maintainerr.rules.*.listExclusions¶
Add handled media to the Maintainerr exclusion list.
| Type | boolean |
| Default | |
| Declared in | modules/maintainerr/rules/options.nix |
nixflix.maintainerr.rules.*.name¶
Rule group name as it appears in Maintainerr.
| Type | string |
| Example | |
| Declared in | modules/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.
| Type | null or string |
| Default | |
| Example | |
| Declared in | modules/maintainerr/rules/options.nix |
nixflix.maintainerr.rules.*.ruleHandlerCronSchedule¶
Custom cron schedule for this rule group. null uses the global Maintainerr schedule.
| Type | null or string |
| Default | |
| Example | |
| Declared in | modules/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.
| Type | null or string |
| Default | |
| Example | |
| Declared in | modules/maintainerr/rules/options.nix |
nixflix.maintainerr.rules.*.useRules¶
Whether to use the rules engine (false = manual collection only).
| Type | boolean |
| Default | |
| Declared in | modules/maintainerr/rules/options.nix |