Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/raydak-labs/configarr

Sync TRaSH Guides + custom configs with Sonarr/Radarr
https://github.com/raydak-labs/configarr

notifiarr radarr recyclarr servarr sonarr sync

Last synced: 1 day ago
JSON representation

Sync TRaSH Guides + custom configs with Sonarr/Radarr

Awesome Lists containing this project

README 

        
# Configarr



[![GitHub License](https://img.shields.io/github/license/raydak-labs/configarr)](https://github.com/raydak-labs/configarr/blob/main/LICENSE)

[![GitHub Release](https://img.shields.io/github/v/release/raydak-labs/configarr?logo=github)](https://github.com/raydak-labs/configarr/releases/)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/bf3242f8502145d5b4395b9b2aa7c7c6)](https://app.codacy.com/gh/raydak-labs/configarr/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

[![Documentation](https://img.shields.io/badge/Documentation-blue)](https://configarr.raydak.de)



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](https://github.com/recyclarr/recyclarr) or [Notifiarr](https://notifiarr.wiki/) but support for additional specification and not only what [TrashGuides](https://trash-guides.info/) offer.



Other projects:



- https://github.com/recyclarr/recyclarr

- https://notifiarr.wiki/

- https://github.com/Dictionarry-Hub/profilarr



## Features



- Use TrashGuide 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 TrashGuide

  - Sync with local file CFs

  - Provide CFs directly in config (Convert JSON with https://www.bairesdev.com/tools/json2yaml/)

  - Merge order is `TrashGuide -> LocalFiles -> CFs in Config`



### Supported \*arr Applications



- Radarr

- Sonarr

- Whisparr (experimental)

- Readarr (experimental)



## Configuration



Full documentation can be found here: https://configarr.raydak.de



- `config.yml`

  - Check the template file [template](./config.yml.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 key `secretKey`

    - `value: !env ENV_NAME`: Loads the value from the environment variable `ENV_NAME`



## Custom formats



This repository also provide additional custom formats what TrashGuide does not offer.



See [here](./custom/cfs/)



- Most CustomFormats used from @PCJones

  - See here: https://github.com/PCJones/radarr-sonarr-german-dual-language

  - Or good german guide: https://github.com/PCJones/usenet-guide



## Development



1. Optionally setup the local sonarr instance

   1. Run `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

2. Open the sonarr [Settings > General](http://localhost:8989/settings/general) page and copy the API key

3. Create a `secrets.yml` from the template

   1. `cp secrets.yml.template secrets.yml`

   2. Replace the placeholder with your sonarr API key

4. Create a `config.yml` from the template

   1. `cp config.yml.template config.yml`

   2. Overwrite the hosts in case you are not using the local setup with docker compose

5. Run the app with `pnpm start` or with the vscode task



## Examples



Some examples for configuration are provided [Examples](./examples/)