Skip to main content

Getting Started

warning

Please make sure you've reviewed the various installation methods before getting started here.

Recyclarr requires one or more YAML configuration files in order to work. The main configuration file, by default, is named recyclarr.yml and lives in your application data directory, which varies depending on your chosen platform.

Choose the section below representing your chosen installation method and run those steps if you want to get started with a minimal configuration file.

Docker

Installation Instructions

The steps below assume you are using Docker Compose with a service named recyclarr. You are responsible for translating these steps appropriately for other solutions like Docker Swarm, Kubernetes, raw Docker, etc.

  1. Run docker compose run --rm recyclarr config create to create a starter recyclarr.yml file in the application data directory (for Docker, this will be in /config/recyclarr.yml).
  2. Open the generated YAML file from the previous step. At a minimum you must update the base_url and api_key properties for each service that you want to use. Use the configuration reference and examples pages to assist you in understanding an editing other parts of the file as you see fit.

If you're using Cron Mode, your work ends here. If you want to verify the behavior by running manually, then you can execute docker compose run --rm recyclarr sync to update all instances using the configuration provided in the previous step.

Manual Installation

Installation Instructions

  1. Run recyclarr config create to create a starter recyclarr.yml file in the application data directory.
  2. Open the generated YAML file from the previous step. At a minimum you must update the base_url and api_key properties for each service that you want to use. Use the configuration reference and examples pages to assist you in understanding an editing other parts of the file as you see fit.
  3. Run recyclarr sync to update all instances using the configuration provided in the previous step.

Each command supports printing help on the command line. Simply run recyclarr --help for the main help output and a list of commands. You can then see the help for each command by running recyclarr [command] --help, where [command] is one of those commands (e.g. sync). You can also visit the CLI Reference page for detailed documentation as well.

tip

If you want to organize your configuration into multiple YAML files, learn about how YAML files are loaded and look at examples of how to split your files