Skip to main content

The documentation here is for an unreleased version of Recyclarr.

Visit the documentation site for the Current Version instead.

Include

ServiceSupported
Sonarr (v4)
Radarr
# See "Basic Setup" for `service_type` and `instance_name`
service_type:
  instance_name:
    # Include Configuration
    include:
      - template: uhd-bluray-web
      - config: my-config.yml

YAML includes are a mechanism to support reusable configurations. Including YAML is the process of taking the contents of one YAML file and merging it into the source (root) YAML.

Recommended Reading

For more details about how includes and merging work, see the Include Behavior page.

include​

Optional. Default: Nothing is included.

A sequence of include directives. There are multiple types of include directives. Each type will have one or more properties. Use the appropriate include directive for the kind of inclusion you wish to perform. The sequence may contain a mixture of different include directive types.

The sections that follow correlate to types of include directives.

Config Includes​

Use this directive to include YAML files on your local filesystem.

config​

Required.

An absolute or relative path to the YAML file you wish to include. If relative paths are used, see the app data directory page for where those files should be located.

Examples​

include:
  # An absolute include path
  - config: /home/john/my-include.yml

  # A relative include path
  # Equivalent absolute path is (on Linux):
  #   /home/john/.config/recyclarr/includes/my-include.yml
  - config: my-include.yml

Template Includes​

Utilize the Configuration Templates repository to include YAML files.

template​

Required.

The ID of an include template. The corresponding YAML in the configuration templates repository will be included. IDs matching include templates from a non-matching service type are not allowed (e.g. trying to include a Sonarr template inside a Radarr config).

tip

To get a list of eligible include templates, see the config list templates command.

Examples​

include:
  # Includes YAML templates with these IDs
  - template: radarr-quality-definition-movie
  - template: radarr-quality-profile-anime
  - template: radarr-custom-formats-anime