Skip to main content

Recyclarr

This unofficial app installation guide is provided for your convenience. The guide is provided as-is and may not be updated or maintained by Ultra.cc. Unofficial support may be offered via Discord only and at the sole discretion of Ultra.cc staff. Use at your own risk and only proceed 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 Sonarr/Radarr instances.

  • More information can be found here.

Installation

  • Connect to your Ultra.cc service via SSH
  • Once connected, execute the following command:
wget "https://github.com/recyclarr/recyclarr/releases/latest/download/recyclarr-linux-x64.tar.xz" -O - | tar xJ --overwrite -C ~/bin
  • Next, add environment variable, create and set Recyclarr config directory to ~/.apps/recyclarr 
mkdir ~/.apps/recyclarr && echo -e '\nexport DOTNET_GCHeapHardLimit=10000000\nexport RECYCLARR_APP_DATA="$HOME/.apps/recyclarr/"' >> ~/.bashrc && source ~/.bashrc
  • To check if the installation was successful, execute the following command:
recyclarr --help
  • Done!

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 research and decide which custom formats and/or release profiles you want to add to Sonarr/Radarr.

  • To get a list of custom formats and their respective ID, execute the following command:

Custom formats:

recyclarr list custom-formats radarr

Release profiles:

recyclarr list release-profiles
  • By default, recyclarr.yml already have some custom formats included. Simply add/remove the custom formats you want to use. See below example:
- trash_ids:
    - ed38b889b31be83fda192888e2286d83 # BR-DISK
    - 90a6f9a284dff5103f6346090e6280c8 # LQ
    - dc98083864ea246d05a42df0d05f81cc # x265 (720/1080p)
    - b8cd450cbfa689c0259a01d9e29ba3d6 # 3D
  • Once you are satisified with your selection of custom formats. Execute the following command to synchronize them with your Sonarr/Radarr instances:
recyclarr sync
  • If done successfully, the below output will be shown in your shell:
===========================================
Processing Radarr Server: [movies]
===========================================

[INF] Created 5 New Custom Formats
[INF] Total of 5 custom formats were synced
[INF] Processing Quality Definition: movie
[INF] Number of updated qualities: 14
[INF] Completed at 10/23/2023 11:52:15 AM

===========================================
Processing Sonarr Server: [series]
===========================================

[INF] Created 3 New Release Profiles
[INF] Total of 3 release profiles were synced
[INF] Processing Quality Definition: series
[INF] Number of updated qualities: 14
[INF] Completed at 10/23/2023 11:52:16 AM
  • Done!

Uninstallation

  • Uninstalling Recyclarr is easily done by removing the binary and config directory:
rm -v ~/bin/recyclarr && rm -rfv ~/.apps/recyclarr
  • Done!
Back to top