Recyclarr - Config - Sonarr¶
Configuration options for recyclarr config sonarr.
Available Options
This page documents 11 configuration options.
nixflix.recyclarr.config.sonarr¶
Sonarr instance configurations
| Type | null or (attribute set of (submodule)) |
| Default | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.sonarr.<name>.api_key¶
API key for the instance.
Warning
Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.
Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.
| Type | string or (submodule) |
| Default | |
| Example | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.sonarr.<name>.base_url¶
Base URL for the service instance (including port and URL base).
| Type | string |
| Example | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.sonarr.<name>.delete_old_custom_formats¶
Whether to delete custom formats in the service that are not defined in the configuration.
| Type | boolean |
| Default | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.sonarr.<name>.include¶
List of includes to merge into this instance. Each entry must set exactly one of template or config.
| Type | list of (submodule) |
| Default | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.sonarr.<name>.include.*.config¶
Path to a local YAML file (relative paths are resolved under the Recyclarr includes directory) to merge into this instance's config.
| Type | null or string |
| Default | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.sonarr.<name>.include.*.template¶
ID of a config include template from the Recyclarr config-templates repository (or a local replacement). As of Recyclarr v8 the official repository no longer ships any include templates, so this only works with a custom resource provider or user-supplied local includes.
| Type | null or string |
| Default | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.sonarr.<name>.media_management¶
Media management settings.
| Type | null or (submodule) |
| Default | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.sonarr.<name>.media_management.propers_and_repacks¶
How to handle Propers and Repacks. Set to do_not_prefer when using Custom Formats for repack/proper handling.
| Type | null or one of "prefer_and_upgrade", "do_not_upgrade", "do_not_prefer" |
| Default | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.sonarr.<name>.quality_definition¶
Quality definition configuration from TRaSH guides.
| Type | null or (submodule) |
| Default | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.sonarr.<name>.quality_definition.type¶
Type of quality definition to use from TRaSH guides.
| Type | one of "series", "anime" |
| Declared in | modules/recyclarr/config-option.nix |