AGPL-3.0🖥️ Self-hostable

Configarr

Configarr

Configarr is a configuration synchronisation tool for the *arr media stack. It takes the recommended settings published by TRaSH Guides — plus Recyclarr templates, local files or your own definitions — and applies them to your Sonarr and Radarr instances automatically: creating and updating custom formats, quality profiles, quality size limits and naming schemes. Instead of re-clicking through every instance’s web UI whenever the guides change, you keep a single config.yml (with credentials kept out in secrets.yml) and let Configarr reconcile your servers with it on each run. It is designed to run as a short-lived job in Docker or Kubernetes, or as a standalone binary from cron.

Key Features

  • TRaSH Guides sync — pulls custom formats, custom format groups, quality profiles, quality definitions and naming schemes directly from the TRaSH-Guides repository, so every instance follows community best practice.
  • Recyclarr template compatibility — reuses existing Recyclarr config templates (pinned to the legacy includes format) without forking or maintaining them by hand.
  • Bring your own custom formats — define custom formats directly in config.yml, or load them from local JSON/CF folders and local templates; the merge order is TRaSH-Guides → local files → config.
  • Declarative YAML configuration — one file describes instances, profiles, scores and optional extras, while !secret, !env and !file tags keep API keys out of version control.
  • Multi-instance, multi-app — full support for Sonarr v4+ and Radarr v5+, plus experimental support for Whisparr, Readarr, Lidarr and, since v1.31.0, Prowlarr (tags, sync profiles, indexers, indexer proxies and download clients).
  • Detailed diff reports — every run lists exactly what it created, updated, skipped or left untouched, and an optional JSON diff report can be written to disk for automation.
  • Optional cleanup — opt-in deletion of custom formats, quality profiles or metadata profiles that are no longer in your configuration, with ignore lists to protect hand-made entries.
  • Container- and cloud-native deployment — official images on GitHub Container Registry and Docker Hub, Kubernetes CronJob examples, and standalone binaries (since v1.17.0) for Linux, macOS and Windows.
  • Privacy-first telemetry — anonymous, aggregated and strictly opt-in; it is disabled by default and the collecting code is published in src/telemetry.ts.

Why Use Configarr?

Media servers drift. A TRaSH Guide update lands, someone tweaks a score in the web UI, and a second Radarr instance quietly ends up with different custom formats. Configarr turns that into a single source of truth — the same YAML applied to every instance on every run — and reports precisely what changed. Compared with Recyclarr it adds custom formats and quality profiles written in the config itself, profile renaming and cloning, and support beyond Sonarr and Radarr; compared with Notifiarr it is fully open source and driven from your own versioned files rather than a hosted GUI.

Use Cases

  • Keep several Sonarr and Radarr instances (HD, 4K, anime, non-English) on identical, guide-recommended scoring.
  • Schedule a nightly sync so custom formats and quality profiles track TRaSH Guides automatically.
  • Author your own quality profiles and custom formats in YAML and roll them out to the whole stack.
  • Manage Prowlarr indexers, sync profiles and download clients from the same configuration as your media managers.

Platform

Linux · macOS · Windows (standalone binary) · Docker and Kubernetes containers

Licence

GNU Affero General Public License v3.0 (AGPL-3.0) — source at github.com/raydak-labs/configarr

Website

configarr.de

Related Tool

Configarr pairs well with Bazarr — automatic subtitle management for Sonarr and Radarr.

Explore More Categories

Sign In

Register

Reset Password

Please enter your username or email address, you will receive a link to create a new password via email.