Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Sync TRaSH Guides + custom configs with Sonarr/Radarr

License

Notifications You must be signed in to change notification settings

raydak-labs/configarr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Configarr

GitHub License GitHub Release Codacy Badge Documentation

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 TrashGuides offer.

Other projects:

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

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

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