📘

Recyclarr

All unofficial application installers are provided for your convenience. The scripts are provided as-is and may not be updated or maintained by Ultra.cc. Clients are welcome to use and customize unofficial app installers for their unique needs and requirements. Unofficial support may be offered via Discord only and at the sole discretion of Ultra.cc staff. Use at your own risk and only if you are comfortable managing the application on your own.

Recyclarr is a command-line application that will automatically synchronize recommended settings from the TRaSH guides to your Radarr and Sonarr instances.

Official documentation for Recyclarr can be found here.

Installation

Connect to your Ultra service via SSH.
Once connected, execute the following command:

bash <(wget -qO- https://scripts.ultra.cc/main-v2/Recyclarr/main.sh)

Next, to install Recyclarr, press 1 and ENTER to confirm.

Configuration

Before you can start using Recyclarr, you need to create at least one YAML configuration file. By following the below instructions, a minimal configuration file will be created at ~/.apps/recyclarr/recyclarr.yml. In this guide, we will only show the bare minimum needed to set up Recyclarr. For more information regarding configuration, see the wiki.

Create recyclarr.yml by executing the following command:

recyclarr config create

Next, to edit the configuration file, execute the following command to open recyclarr.yml in the Nano editor.

nano ~/.apps/recyclarr/recyclarr.yml

Next, edit base_url and api_key for Sonarr/Radarr. See below example:

    base_url: https://username.hostname.usbx.me/radarr
    api_key: <YOUR_API_KEY_HERE>

Make sure to replace username and hostname with your specific username and hostname.
Also, make sure to set the correct Base URL for each section, e.g /radarr for the Radarr section, and /sonarr for the Sonarr section of the configuration file.
Lastly, replace <YOUR_API_KEY_HERE> for each section. The API key can be found in Settings > General in the webUI of Sonarr/Radarr.

At this point, the bare minimum needed for Recyclarr to work has been done, but before you run recyclarr sync we recommend that you do your own research and thouroghly read the Recyclarr wiki.

Uninstallation

Connect to your Ultra service via SSH.
Once connected, execute the following command:

bash <(wget -qO-  https://scripts.ultra.cc/main-v2/Recyclarr/main.sh)

Next, to uninstall Recyclarr, press 2 and ENTER to confirm.

If you require further assistance, you can open a support ticket here!

Feedback and suggestions regarding this article are welcome on our Discord server

Recyclarr
Installation
Configuration
Uninstallation