Skip to main content

Resource Provider Configuration

resource_providers:
  # Git-based provider (trash-guides or config-templates)
  - name: my-custom-guides
    type: trash-guides
    clone_url: https://github.com/yourname/custom-guides.git
    reference: main
    replace_default: false
    cache_limit: 100MB

  # Local directory provider (custom-formats)
  - name: my-language-cfs
    type: custom-formats
    path: /home/user/custom-formats/radarr
    service: radarr
    replace_default: false

Each resource provider entry configures a source for configuration data. Properties are divided into common properties (all providers) and location-specific properties (git or local).

All Providers​

name​

Required.

Unique identifier for the provider. May only contain letters, numbers, hyphens, and underscores. Referenced in logs and error messages.

type​

Required.

Content type that determines what kind of data the provider supplies:

  • trash-guides: Full TRaSH Guides structure (custom formats, quality sizes, media naming). Requires metadata.json at root.
  • config-templates: Template configurations for quick setup. Requires includes.json and/or templates.json at root.
  • custom-formats: Simple flat folder of custom format JSON files. No structure required.

replace_default​

Optional. Default: false

When true, replaces the official provider for this type instead of supplementing it. Only one provider per type can have this set.

warning

When replace_default: true is set, the official repository for that type is not used. Only do this if your repository contains all the content you need.

Git Repositories​

clone_url​

Conditionally Required.

URL compatible with git clone. Required when using a git repository as the provider source. Mutually exclusive with path.

cache_limit​

Optional. Default: 100MB

Maximum size of the .git directory before Recyclarr rebuilds the cache. When the directory exceeds this limit, Recyclarr deletes it and performs a fresh shallow clone. Accepts a number followed by a unit: KB, MB, or GB.

Set to 0MB to disable automatic cleanup entirely.

If the fresh clone still exceeds the limit, Recyclarr logs a warning suggesting you raise the value. Rebuild failures are best-effort and don't interrupt the sync.

reference​

Optional. Default: auto-detected

Git reference to checkout: branch name, tag, or commit SHA.

When omitted, Recyclarr auto-detects the default branch by trying master then main. For config-templates providers, Recyclarr first tries v{major} (matching your Recyclarr version) to ensure template compatibility.

Specify reference explicitly when:

  • Pinning to a specific commit or tag for stability
  • Your repository uses a non-standard branch name (not master or main)

Local Directories​

path​

Conditionally Required.

Path to a local directory containing provider content. Can be absolute or relative to the app data directory. Required when using a local directory as the provider source. Mutually exclusive with clone_url.

tip

Relative paths are resolved against the app data directory. This is useful for keeping custom resources alongside Recyclarr's other data.

custom-formats Type​

service​

Conditionally Required.

Required when type is custom-formats. Specifies which service the custom formats are designed for: radarr or sonarr.

Custom formats aren't interchangeable between Radarr and Sonarr, so you must specify which service your custom formats target.