Repolode
raydak-labs

raydak-labs/configarr

Open-source tool that syncs TRaSH Guides and custom configs into Sonarr and Radarr instances, automating custom formats and quality profiles.

Stars
675
Forks
30
Open issues
27
Last commit
15 hours ago

What is it?

Configarr automates configuration of Sonarr and Radarr, the media managers used with download clients. It pulls custom formats, quality profiles and related settings from TRaSH Guides, and can also load custom formats from local files or directly from its config file. When sources overlap, the merge order runs from TRaSH Guides to local files to inline config.

It runs as a container via Docker or Kubernetes, and is driven by a config.yml file that supports secret, environment variable and file-based value references. Sonarr v4 and v5 beta, and Radarr v5, v6 and v7 are supported officially, with Whisparr, Readarr and Lidarr marked experimental. The project is designed to be compatible with Recyclarr templates.

The repository also ships extra custom formats that TRaSH Guides does not cover, including German-language formats adapted from community work.

Key features

  • 01Syncs custom formats and quality profiles from TRaSH Guides.
  • 02Loads custom formats from local files or inline in the config.
  • 03Compatible with Recyclarr templates.
  • 04Supports secret, environment variable and file value references.
  • 05Runs via Docker or Kubernetes.
  • 06Officially supports Sonarr v4/v5 beta and Radarr v5/v6/v7.

Use cases

  • Keeping a Sonarr or Radarr setup aligned with TRaSH Guides without manual edits.
  • Managing media server configuration as code across Docker or Kubernetes deployments.
  • Adding custom formats for languages or regions not covered by TRaSH Guides.

Quick start

  1. 1

    Get the container image from GHCR or DockerHub

  2. 2

    Create config.yml from the template

    cp config.yml.template config.yml
  3. 3

    Run the app with pnpm (development setup)

    pnpm start

Things to know

  • Licensed under AGPL-3.0, a copyleft license that requires derivative works to be shared under the same terms.
  • Support for Whisparr, Readarr and Lidarr is experimental.

Topics

FAQ

What is configarr?
Open-source tool that syncs TRaSH Guides and custom configs into Sonarr and Radarr instances, automating custom formats and quality profiles. Configarr automates configuration of Sonarr and Radarr, the media managers used with download clients. It pulls custom formats, quality profiles and related settings from TRaSH Guides, and can also load custom formats from local files or directly from its config file. When sources overlap, the merge order runs from TRaSH Guides to local files to inline config.
Is configarr free to use? What license does it have?
configarr is open source under the AGPL-3.0 license. Check the license terms before using it in commercial products.
Is configarr still maintained?
Actively maintained. The last commit to configarr was on Nov 6, 2026.
What can I use configarr for?
Keeping a Sonarr or Radarr setup aligned with TRaSH Guides without manual edits. Managing media server configuration as code across Docker or Kubernetes deployments. Adding custom formats for languages or regions not covered by TRaSH Guides.
How do I install configarr?
Get the container image from GHCR or DockerHub Create config.yml from the template: cp config.yml.template config.yml Run the app with pnpm (development setup): pnpm start
Where can I get configarr?
The source code and installation instructions are on GitHub: https://github.com/raydak-labs/configarr

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects