DOCSEARCHbyAlgolia
Submit Docs

Recyclarr Documentation

website·Indexed 33 days ago

https://recyclarr.dev

Documentation for Recyclarr, a tool used to sync TRaSH Guide quality profiles and custom formats to Sonarr and Radarr. Includes a complete configuration reference, CLI command usage, installation guides for Docker, and upgrade paths for versions v7.0 and v8.0.

Tokens
31.1K
Snippets
172
Records
254
Agent score
66%

What's inside Recyclarr

  1. Overview of Recyclarr synchronization

    Recyclarr is a tool designed to automatically synchronize custom formats, quality profiles, and naming schemes from TRaSH Guides to Sonarr and Radarr instances. It supports multi-instance management from a single YAML configuration file and is available via Docker or native binaries for Windows, macOS, Linux, and Unraid.

  2. Manage Recyclarr operational features and automation

    Recyclarr provides several operational features to manage the synchronization process:

    • Multiple Instances: Support for syncing any number of Sonarr and Radarr instances, which can be filtered by name or service type.
    • Docker: An official image featuring built-in cron scheduling for unattended operation.
    • Templates: Support for pre-built templates and reusable YAML includes to compose configurations.
    • Secrets & Variables: Secure storage of API keys using !secret and injection of environment variables using !env_var.
    • Preview Mode: A dry-run capability for sync and delete operations to validate changes before application.
    • Notifications: Integration with Apprise to send sync results to platforms like Discord, Slack, and email.
    • Global Settings: Configuration for SSL validation, log retention, and notification preferences.

  3. Understand Recyclarr's automatic migration system

    Recyclarr uses a Migration System to automatically perform upgrade steps (Migration Steps) between releases. These steps are designed to handle breaking changes automatically, typically corresponding to major releases, reducing the need for manual intervention during updates.

  4. Understand Recyclarr resource provider defaults

    By default, Recyclarr automatically uses official sources without any configuration. These include Trash Guides (https://github.com/TRaSH-Guides/Guides.git) for custom formats, quality sizes, and media naming, and Config Templates (https://github.com/recyclarr/config-templates.git) for pre-made YAML configurations. Most users do not need to configure resource_providers unless they wish to add custom formats, use modified guides, or replace official sources.

  5. Understand Recyclarr notification behavior

    Recyclarr sends a single consolidated notification upon the completion of the entire sync operation across all configured services (e.g., multiple Radarr and Sonarr instances).

    Each notification includes:

    • Overall Status: Success or failure of the operation.
    • Service-Specific Statistics: High-level metrics like the number of custom formats or quality profiles updated per instance.
    • Error and Warning Reports: Any critical issues or deprecation warnings encountered during the sync.

  6. Sync TRaSH Guide configurations to Sonarr and Radarr

    Recyclarr allows users to synchronize specific media management settings from TRaSH Guides into Sonarr and Radarr instances. Supported sync features include:

    • Custom Formats: Sync individual formats or curated groups, including score assignments and overrides.
    • Quality Profiles: Sync guide-backed definitions, including upgrade settings, qualities, and score sets.
    • Quality Definitions: Apply recommended quality sizes with optional per-quality overrides.
    • Media Naming: Sync file and folder naming formats, with the ability to exclude specific formats.
    • Media Management: Control the handling of Propers and Repacks.
    • Custom Content: Define custom formats and quality profiles beyond the provided guides.

  7. Understand Auto-Sync for Guide-Backed Quality Profiles

    When a quality profile is configured using a trash_id, Recyclarr automatically syncs Custom Format (CF) groups marked as defaults for that profile in the TRaSH Guide. This eliminates the need to manually list individual custom formats for most users.
    radarr:
  movies:
    quality_profiles:
      - trash_id: 64fb5f9858489bdac2af690e27c8f42f # UHD Bluray + WEB

  8. Understand Recyclarr sync state management

    Recyclarr maintains a state file in the state subdirectory of the main app data location. This state allows Recyclarr to accurately detect changes to custom formats in TRaSH guides, specifically handling changes made on the *arr side (such as renames). State files are managed automatically by Recyclarr and should not be edited by users.

  9. Extend or override official Recyclarr resources

    Recyclarr allows you to modify official resources by adding custom resource providers. The behavior depends on the identification key used:

    • Extend: Use a unique key to add new resources alongside official ones.
    • Override: Use the same key as an official resource to replace it entirely.

    Key comparisons are case-insensitive. Resources from custom providers override official ones with matching keys because they are processed after the implicit official provider.

  10. Understand the Recyclarr v9.0 resource ownership model

    v9.0
    Recyclarr v9.0 follows an authoritative sync model: if a resource is defined in your configuration, Recyclarr owns and manages it. To manually manage a resource, you must remove it from your Recyclarr configuration. When Recyclarr adopts an existing resource during sync, it will issue a warning to allow you to adjust your configuration if the adoption was unintended.

  11. Understand Recyclarr sync pipelines and data stages

    When running recyclarr sync, the configuration is processed through five independent stages (pipelines) to handle specific types of data:

    • Custom Formats: Syncs custom format definitions from TRaSH Guides.
    • Quality Profiles: Syncs quality profile settings and assigns custom format scores.
    • Quality Sizes: Syncs quality definition size limits (min/max/preferred).
    • Media Naming: Syncs file and folder naming formats.
    • Media Management: Syncs media management settings such as Propers and Repacks handling.

  12. List available Recyclarr configuration templates

    Use the config list templates command to view available ready-to-use templates for Sonarr and Radarr that match TRaSH Guide quality profiles.
    docker compose run --rm recyclarr config list templates