Secrets YAML
Recyclarr can substitute secret values within your YAML configuration files. This keeps sensitive values out of your configuration files and enables configuration sharing without you having to remember to manually redact each time.
Secrets functionality was added as optional functionality in v3.0.0.
Specify secrets with a secrets.yml located in your application data directory.
The following rules apply:
- Secrets can be used in both the Recyclarr config and settings files.
- Only one secrets file is supported.
- This file is optional and does not need to exist in order for Recyclarr to work properly.
Secrets Definition
Define secrets in secrets.yml using key/value pairs. An example secrets.yml:
sonarr_some_url: http://localhost:8989
sonarr_some_apikey: f7e74ba6c80046e39e076a27af5a8444
radarr4k_another_url: http://localhost:7878
radarr4k_another_apikey: bf99da49d0b0488ea34e4464aa63a0e5
Naming Rules
- Keys can be named whatever you want.
- All key names must be unique. In other words, two keys cannot have the same name.
Using Secrets
Substitute secrets within your Recyclarr configuration or settings files using !secret <key_name>.
Usage example in recyclarr.yml (using the same secrets.yml example from the previous section):
radarr:
radarr4k:
base_url: !secret radarr4k_another_url
api_key: !secret radarr4k_another_apikey
Recyclarr will fail to load your configuration if there are references to keys that don't exist in
the secrets.yml.