Configarr
Configarr is an open-source tool designed to simplify configuration and synchronization for Sonarr and Radarr (and other experimental). It integrates with TRaSH Guides to automate updates of custom formats, quality profiles, and other settings, while also supporting user-defined configurations. Configarr offers flexibility with deployment options like Docker and Kubernetes, ensuring compatibility with the latest versions of Sonarr and Radarr. By streamlining media server management, it saves time, enhances consistency, and reduces manual intervention.
Official support for Sonarr v4 and the Sonarr v5 beta, and Radarr v5, v6 and v7. Radarr v5/v6/v7 use the same API v3 integration and configuration; no version selector is needed. Sonarr API versions are detected at runtime, so existing v4 configurations continue to work. See the configuration documentation for Sonarr v5-only settings.
This will be a project similar to Recyclarr or Notifiarr but support for additional specification and not only what TRaSH-Guides offer.
Container Images
Images are available via Github Container Registry (ghcr) and dockerhub with tags and latest (check the repos for all available tags):
-ghcr.io/raydak-labs/configarr:latest
- docker.io/configarr/configarr:latest or simply configarr/configarr:latest
Features
- Use TRaSH-Guides defined custom formats
- Compatible with recyclarr templates
- Include own defined custom formats
- Custom defined formats for different languages/countries like Germany
- Support all CustomFormat specifications
- Provide CFs in different ways
TRaSH-Guides -> LocalFiles -> CFs in Config
Supported \*arr Applications
- Radarr v5, v6 and v7
- Sonarr v4 and v5 beta (v5-only settings require a v5 instance)
- Whisparr (experimental)
- Readarr (experimental)
- Lidarr (experimental)
Configuration
Full documentation can be found here: Documentation
config.yml
value: !secret secretKey: Loads the value from the secrets file with the key secretKey
- value: !env ENV_NAME: Loads the value from the environment variable ENV_NAME
- value: !file FILE_NAME: Loads the value from the file FILE_NAME
- Make sure Configarr has enough permissions to read the file
Custom formats
This repository also provide additional custom formats what TRaSH-Guides does not offer.
See here
- Most CustomFormats used from @PCJones
Development
- Optionally setup the local sonarr instance
docker compose up -d to run the container
2. Open sonarr in your browser at http://localhost:8989 / radarr @ http://localhost:7878
3. Configure basic authentication, disable local authentication and create an initial user by specifying the e-mail and password
- Open the sonarr Settings > General page and copy the API key
- Create a
secrets.ymlfrom the template
cp secrets.yml.template secrets.yml
2. Replace the placeholder with your sonarr API key
- Create a
config.ymlfrom the template
cp config.yml.template config.yml
2. Overwrite the hosts in case you are not using the local setup with docker compose
- Run the app with
pnpm startor with the vscode task
full example and utilizing the docker container with mounted src directory.
Examples
Some examples for configuration are provided Examples
Related projects
You can compare features here: Feature Comparison
- https://github.com/recyclarr/recyclarr
- https://notifiarr.wiki/
- https://github.com/Dictionarry-Hub/profilarr