Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 1.33 KB

README.md

File metadata and controls

29 lines (21 loc) · 1.33 KB
Raw

Recyclarr Configuration Templates

This is the repository for pre-made Configuration for the Recyclarr command line tool. These pre-made YAML files are referred to as "templates" because it is expected to serve as a starting point to which users may optionally customize and branch out from.

Getting Started

If you are interested in using one of the configuration templates, see the tips below.

  1. If you haven't installed Recyclarr yet, do that first. You can read the docs for more info.
  2. Use the config create command to create one or more templates locally that you can edit and use. The CLI Reference can help you understand exactly how to run this command.
  3. Each template typically has a base_url and api_key properties that you are required to assign real values.
  4. Refer to the Configuration YAML Reference for details on the different parts of the template if you are interested in making changes or understanding more about it.

Contributing

See the CONTRIBUTING.md file if you're interested in contributing to the templates!