Skip to content

Recyclarr - Config

Configuration options for recyclarr config.

Available Options

This page documents 1 configuration options.

nixflix.recyclarr.config

Recyclarr configuration as a structured Nix attribute set. When set, this completely replaces the auto-generated configuration, giving you full control over the Recyclarr setup.

The structure is: { service_type.instance_name = { ... }; }

  • service_type: sonarr or radarr (only these two keys are allowed)
  • instance_name: arbitrary name for the instance (e.g., sonarr_main, radarr_4k)

Defaults are sonarr.sonarr, sonarr.sonarr_anime, and radarr.radarr.

Each instance supports guide-backed quality profiles (via trash_id) or user-defined ones (via name), custom formats and custom format groups from TRaSH guides, media naming, media management (e.g. Propers and Repacks handling), and template/file includes.

Config Reference

Typenull or (submodule)
Default 
"Generated from `nixflix.sonarr`, `nixflix.sonarr-anime`, and `nixflix.radarr` settings"
Example 
{
  sonarr.sonarr_main = {
    base_url = "http://127.0.0.1:8989";
    api_key._secret = "/run/credentials/recyclarr.service/sonarr-api_key";
    quality_definition.type = "series";
    quality_profiles = [{
      trash_id = "dfa5eaae7894077ad6449169b6eb03e0"; # WEB-2160p (Alternative)
      reset_unmatched_scores.enabled = true;
    }];
    custom_format_groups.add = [{
      trash_id = "e3f37512790f00d0e89e54fe5e790d1c"; # [Required] Golden Rule UHD
      select = [ "9b64dff695c2115facf1b6ea59c9bd07" ]; # x265 (no HDR/DV)
    }];
  };
  radarr.radarr_main = {
    base_url = "http://127.0.0.1:7878";
    api_key._secret = "/run/credentials/recyclarr.service/radarr-api_key";
    quality_definition.type = "movie";
    media_management.propers_and_repacks = "do_not_prefer";
  };
}
Declared inmodules/recyclarr/config-option.nix