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 quality profiles, custom formats from TRaSH guides, media naming configuration, and template 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 = [{
      name = "WEB-2160p";
      upgrade = {
        allowed = true;
        until_quality = "WEB 2160p";
        until_score = 10000;
      };
      min_format_score = 0;
      quality_sort = "top";
      qualities = [
        { name = "WEB 2160p"; qualities = ["WEBDL-2160p" "WEBRip-2160p"]; }
        { name = "WEB 1080p"; qualities = ["WEBDL-1080p" "WEBRip-1080p"]; }
      ];
    }];
    custom_formats = [{
      trash_ids = [
        "85c61753df5da1fb2aab6f2a47426b09" # BR-DISK
        "9c11cd3f07101cdba90a2d81cf0e56b4" # LQ
      ];
      assign_scores_to = [{ name = "WEB-2160p"; }];
    }];
    include = [
      { template = "sonarr-v4-quality-profile-web-2160p-alternative"; }
    ];
  };
  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";
  };
}
Declared inmodules/recyclarr/config-option.nix