The documentation here is for an unreleased version of Recyclarr.
Visit the documentation site for the Current Version instead.Pre-Built Configuration Files
Recyclarr offers pre-built configuration files that can be used as a straightforward method of deploying one of more of the TRaSH Guides profiles:
These pre-built configuration files are composed of two primary elements:
-
Includes
Include templates are utilized to synchronize all mandatory elements of any given guide profile. These are split intoquality_definition
,quality_profile
andcustom_formats
elements. If any of these are not desired, they can be commented out. The content of these include templates can be found in the Recyclarr config-templates GitHub repository. -
Custom Formats
Custom formats that are added to the pre-built configuration file directly - i.e., not by way of an include - allow the user to choose from one or more profile variations. These choices mirror those described on the TRaSH Guides profile pages. Comments are provided in the pre-built configuration files, although these are supplementary in nature and the relevant guide profile page should be consulted for full information.
Deployment
The pre-built configuration files can be deployed in two ways:
- Via the CLI using
recyclarr config create -t
. - Manually, by copying the contents of the relevant pre-built configuration file into a supported file location. The files can be found in the index below.
Customization
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.
At this time, include templates can only be used with quality profiles that have the same name as shown in the equivalent guide profile page. The profile name is hard-coded into the include template.
As the pre-built configuration files feature include templates, these will need to be overridden by custom configuration added to the 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. From there, the quality profile include template can either be commented out, or if left enabled then Recyclarr will process the customized configuration as described in the include behavior section.
Additional custom formats can be added to the configuration file in the same way as normal.
Index
Radarr
HD Bluray + WEB
Click to show/hide
loading...
UHD Bluray + WEB
Click to show/hide
loading...
Remux + WEB 1080p
Click to show/hide
loading...
Remux + WEB 2160p
Click to show/hide
loading...
Anime (Radarr)
Click to show/hide
loading...
French HD Bluray + WEB MULTi
Click to show/hide
loading...
French HD Bluray + WEB VOSTFR
Click to show/hide
loading...
French UHD Bluray + WEB MULTi
Click to show/hide
loading...
French UHD Bluray + WEB VOSTFR
Click to show/hide
loading...
French Remux + WEB 1080p MULTi
Click to show/hide
loading...
French Remux + WEB 1080p VOSTFR
Click to show/hide
loading...
French Remux + WEB 2160p MULTi
Click to show/hide
loading...
French Remux + WEB 2160p VOSTFR
Click to show/hide
loading...
Sonarr v4
WEB-1080p
Click to show/hide
loading...
WEB-2160p
Click to show/hide
loading...
Anime (Sonarr)
Click to show/hide
loading...
French WEB-1080p MULTi
Click to show/hide
loading...
French WEB-1080p VOSTFR
Click to show/hide
loading...
French WEB-2160p MULTi
Click to show/hide
loading...
French WEB-2160p VOSTFR
Click to show/hide
loading...
French Anime MULTi
Click to show/hide
loading...
French Anime VOSTFR
Click to show/hide
loading...