Getting Started

Recyclarr automatically syncs recommended settings from TRaSH Guides to your Sonarr and Radarr instances. This guide walks you through installation to your first sync.

Step 1: Install Recyclarr

Choose your preferred installation method:

Docker Compose (Recommended)

Create a docker-compose.yml file:

services:
  recyclarr:
    image: ghcr.io/recyclarr/recyclarr
    container_name: recyclarr
    user: 1000:1000
    volumes:
      - ./config:/config
    environment:
      TZ: America/Santiago

For networking setup, image tags, and advanced options, see the Docker Compose guide.

Homebrew (macOS & Linux)

brew tap recyclarr/recyclarr
brew install recyclarr

To upgrade later: brew update && brew upgrade recyclarr

Source: github.com/recyclarr/homebrew-recyclarr

Manual Download

Download the latest release for your platform:

Platform	Binary
Windows	x64, arm64
Linux	x64, arm64, arm
macOS	x64, arm64

Extract and place the recyclarr binary somewhere in your $PATH.

For installation scripts and details, see the Manual Installation guide.

Unraid

Search for "recyclarr" in the Community Apps tab, or use the un.recyclarr plugin.

See the Unraid guide for details.

Step 2: Create Configuration

Native

recyclarr config create

Docker

docker compose run --rm recyclarr config create

This creates recyclarr.yml in your application data directory.

Step 3: Edit Configuration

Open recyclarr.yml and configure at minimum:

• base_url: Your Sonarr/Radarr instance URL
• api_key: Found in Sonarr/Radarr under Settings → General

See the configuration reference and examples for guidance.

Step 4: Run Sync

Native

recyclarr sync

Docker

To run manually:

docker compose run --rm recyclarr sync

Or start in Cron Mode for automatic daily syncs:

docker compose up -d

Next Steps

• Configuration Reference - All available settings
• Config Examples - Real-world configuration patterns
• CLI Reference - All commands and options
• File Structure - Where Recyclarr stores data