Recyclarr - Config - Radarr¶
Configuration options for recyclarr config radarr.
Available Options
This page documents 9 configuration options.
nixflix.recyclarr.config.radarr¶
Radarr instance configurations
| Type | null or (attribute set of (submodule)) |
| Default | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.radarr.<name>.api_key¶
The API key that Recyclarr should use to synchronize settings to your 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.radarr.<name>.base_url¶
The base URL of your instance. Basically this is the URL you bookmark to get to the front page.
| Type | string |
| Example | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.radarr.<name>.delete_old_custom_formats¶
If enabled, custom formats that you remove from your configuration or that are removed from the guide will be deleted from the service. Only applies to formats Recyclarr synchronized; manually added formats are preserved.
| Type | boolean |
| Default | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.radarr.<name>.include¶
A sequence of include directives 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.radarr.<name>.include.*.config¶
An absolute or relative path to the YAML file to include. Relative paths resolve from the includes directory in the Recyclarr app data folder.
| Type | null or string |
| Default | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.radarr.<name>.include.*.template¶
The ID of an include template from a resource provider. 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.radarr.<name>.media_management¶
Media management settings.
| Type | null or (submodule) |
| Default | |
| Declared in | modules/recyclarr/config-option.nix |
nixflix.recyclarr.config.radarr.<name>.media_management.propers_and_repacks¶
Controls how Sonarr/Radarr handles Propers and Repacks. This corresponds to the 'Propers and Repacks' dropdown in the Media Management settings.
| Type | null or one of "prefer_and_upgrade", "do_not_upgrade", "do_not_prefer" |
| Default | |
| Declared in | modules/recyclarr/config-option.nix |