Quick Setup Templates

New to Recyclarr?

See the Getting Started guide for a walkthrough of using these templates.

Recyclarr can create ready-made configuration files, called templates, that deploy a TRaSH Guides quality profile exactly as the guide describes it. Recyclarr generates one template for each guide quality profile, so new guide profiles become available as the guide updates.

Templates use guide-backed quality profiles and custom format groups to synchronize all mandatory elements of the guide profile. A single trash_id reference per quality profile replaces what previously required multiple include templates.

Choose a Profile

Read the TRaSH Guides quality profile descriptions to decide which profile fits your setup:

• Radarr: Quality Profiles, plus Anime, French, and German profiles
• Sonarr: Quality Profiles, plus Anime, French, and German profiles

Find the Template ID

List the available templates:

recyclarr config list templates

The list shows each template's ID next to the name of its guide profile, so you can match the profile you chose to its ID. See recyclarr config list templates for the options.

Preview a Template

To see what a template contains before you use it, write it to a file outside your configuration directory with --path:

recyclarr config create -t hd-bluray-web -p ./hd-bluray-web.yml

In Docker, write the file inside the container and print it:

docker exec recyclarr recyclarr config create -t hd-bluray-web -p /tmp/hd-bluray-web.yml
docker exec recyclarr cat /tmp/hd-bluray-web.yml

The file has one instance with placeholders for base_url and api_key, a quality definition, the guide-backed quality profile, and the profile's custom format groups. Optional groups are commented out so you can enable the ones you want. See Templates for details.

Deployment

Create a configuration file from a template with recyclarr config create:

recyclarr config create -t hd-bluray-web

In Docker, run the same command with docker exec recyclarr in front of it. Then fill in base_url and api_key, and restart the Recyclarr server so it loads the new file.

Customization

warning

The pre-built configuration files are designed as a simple mechanism to deploy one or more of the TRaSH Guides profiles, in exactly the same configuration as they appear on the guides pages. Minimal customization is possible, however more extensive customization usually necessitates building your own custom configuration file.

Guide-backed quality profiles pull their settings directly from the TRaSH Guides. To customize a profile, add overrides in your configuration file. Guidance is available on this behavior.

A common request is to add additional qualities to a quality profile. This is as simple as writing your own complete quality profile configuration and adding it to your configuration file. The guide-backed profile's qualities will be replaced by your custom list as described in the include behavior section.

Additional custom formats can be added to the configuration file in the same way as normal.