Configuration and synchronization tool for Sonarr and Radarr.
Official support only for Sonarr v4 and radarr v5.
This will be a project similar to Recyclarr or Notifiarr but support for additional specification and not only what TRaSH-Guides offer.
Other projects:
- https://github.com/recyclarr/recyclarr
- https://notifiarr.wiki/
- https://github.com/Dictionarry-Hub/profilarr
- 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
- Sync from TRaSH-Guides
- Sync with local file CFs
- Provide CFs directly in config (Convert JSON with https://www.bairesdev.com/tools/json2yaml/)
- Merge order is
TRaSH-Guides -> LocalFiles -> CFs in Config
- Radarr
- Sonarr
- Whisparr (experimental)
- Readarr (experimental)
Full documentation can be found here: https://configarr.raydak.de
config.yml
- Check the template file template or check the examples.
- You can provide values with the custom tags:
value: !secret secretKey
: Loads the value from the secrets file with the keysecretKey
value: !env ENV_NAME
: Loads the value from the environment variableENV_NAME
This repository also provide additional custom formats what TRaSH-Guides does not offer.
See here
- Most CustomFormats used from @PCJones
- Optionally setup the local sonarr instance
- Run
docker compose up -d
to run the container - Open sonarr in your browser at http://localhost:8989 / radarr @ http://localhost:7878
- Configure basic authentication, disable local authentication and create an initial user by specifying the e-mail and password
- Run
- Open the sonarr Settings > General page and copy the API key
- Create a
secrets.yml
from the templatecp secrets.yml.template secrets.yml
- Replace the placeholder with your sonarr API key
- Create a
config.yml
from the templatecp config.yml.template config.yml
- Overwrite the hosts in case you are not using the local setup with docker compose
- Run the app with
pnpm start
or with the vscode task
Tip: Beside from those steps you can also always test and work with the full example
and utilizing the docker container with mounted src
directory.
Some examples for configuration are provided Examples