open-source-mirrors
/
recyclarr
mirror of https://github.com/recyclarr/recyclarr
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '1b6d42f719'
${ noResults }
recyclarr/wiki/Settings-Reference.md

3.2 KiB
Raw Blame History

This page contains the YAML reference for Recyclarr settings. Settings support was introduced in version 1.7.0.

The settings.yml file is located in the following locations (by default) depending on your platform:

Platform Location
Windows %APPDATA%\recyclarr\settings.yml
Linux ~/.config/recyclarr/settings.yml
MacOS ~/Library/Application Support/recyclarr/settings.yml

Settings in this file affect the behavior of Recyclarr regardless of instance-specific configuration for Radarr and Sonarr.

If this file does not exist, Recyclarr will create it for you. Starting out, this file will be empty and default behavior will be used. There is absolutely no need to touch this file unless you have a specific reason to. It is recommended that you only add the specific properties for the customizations you need and leave the rest alone.

Schema Validation

A schema file is provided for settings.yml to help assist in editing the file. To use it, simply add the below snippet to the first line in your settings.yml file:

# yaml-language-server: $schema=https://raw.githubusercontent.com/recyclarr/recyclarr/master/schemas/settings-schema.json

If you use VS Code to edit your settings file and install the YAML extension, it will suggest properties you can use and show you documentation for each without having to reference this page.

YAML Reference

Table of Contents

Global Settings

enable_ssl_certificate_validation: true
  • enable_ssl_certificate_validation
    If set to false, SSL certificates are not validated. This is useful if you are connecting to a Sonarr or Radarr instance using https and it is set up with self-signed certificates. Note that disabling this setting is a security risk and should be avoided unless you are absolutely sure what you are doing.

Repository Settings

NOTE: Never edit files in the locally cloned repo managed by Recyclarr. It will always destroy local changes in that repository.

repository:
  clone_url: https://github.com/TRaSH-/Guides.git
  branch: master
  sha1: e27659e3f90d9b60c1f0b0f204b2530bb2299b41

  • clone_url (Default: https://github.com/TRaSH-/Guides.git)
    A URL compatible with git clone that is used to clone the Trash Guides repository. This setting exists for enthusiasts that may want to instead have Recyclarr pull data from a fork instead of the official repository.

  • branch (Default: master)
    The name of a branch to check out in the repository.

  • sha1 (Default: empty)
    A SHA1 (commit hash) in Git to use. If specified, it overrides the branch setting. This SHA1 is passed to git reset --hard to force your local clone to this specific revision in the repository. If not specified, only the branch controls what revision is used in the repo.