From 1e1ce603c7797fea30d4fbf6014e1e046e45c52b Mon Sep 17 00:00:00 2001 From: Eduard Marbach Date: Sun, 12 Jan 2025 13:23:44 +0100 Subject: [PATCH] feat(guide): add Configarr to 3rd party Guide Sync tools (#2200) --- docs/Guide-Sync/index.md | 61 +++++++++++++++++++++++++--------------- 1 file changed, 38 insertions(+), 23 deletions(-) diff --git a/docs/Guide-Sync/index.md b/docs/Guide-Sync/index.md index 89b49c160..c66ba6dbd 100644 --- a/docs/Guide-Sync/index.md +++ b/docs/Guide-Sync/index.md @@ -9,32 +9,32 @@ These are third-party applications that sync several sections of the guide with ## Radarr Features -| Radarr Features | Notifiarr | Recyclarr | -| ---------------------------------------------------------------------------------- | :----------------: | :----------------: | -| GUI (graphical user interface) | :white_check_mark: | | -| Custom Formats | :white_check_mark: | :white_check_mark: | -| Interactive Flowchart (choose the correct Custom Formats for your Quality Profile) | :white_check_mark: | | -| Predefined config files available (editable to personal preferences) | | :white_check_mark: | -| Predefined profiles sync (with several personal selectable options) | :white_check_mark: | | -| Clear all Custom Formats | :white_check_mark: | :white_check_mark: | -| Scores | :white_check_mark: | :white_check_mark: | -| Quality Settings (File Size) | :white_check_mark: | :white_check_mark: | -| Naming Scheme | :white_check_mark: | :white_check_mark: | -| Quality Profiles | :white_check_mark: | :white_check_mark: | +| Radarr Features | Notifiarr | Recyclarr | Configarr | +| ---------------------------------------------------------------------------------- | :----------------: | :----------------: | :----------------: | +| GUI (graphical user interface) | :white_check_mark: | | | +| Custom Formats | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Interactive Flowchart (choose the correct Custom Formats for your Quality Profile) | :white_check_mark: | | | +| Predefined config files available (editable to personal preferences) | | :white_check_mark: | :white_check_mark: | +| Predefined profiles sync (with several personal selectable options) | :white_check_mark: | | | +| Clear all Custom Formats | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Scores | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Quality Settings (File Size) | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Naming Scheme | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Quality Profiles | :white_check_mark: | :white_check_mark: | :white_check_mark: | ## Sonarr Features -| Sonarr Features | Notifiarr | Recyclarr | -| -------------------------------------------------------------------- | :----------------: | :----------------: | -| GUI (graphical user interface) | :white_check_mark: | | -| Custom Formats | :white_check_mark: | :white_check_mark: | -| Predefined config files available (editable to personal preferences) | | :white_check_mark: | -| Predefined profiles sync (with several personal selectable options) | :white_check_mark: | | -| Clear all Custom Formats | :white_check_mark: | :white_check_mark: | -| Scores | :white_check_mark: | :white_check_mark: | -| Quality Settings (File Size) | :white_check_mark: | :white_check_mark: | -| Naming Scheme | :white_check_mark: | :white_check_mark: | -| Quality Profiles | :white_check_mark: | :white_check_mark: | +| Sonarr Features | Notifiarr | Recyclarr | Configarr | +| -------------------------------------------------------------------- | :----------------: | :----------------: | :----------------: | +| GUI (graphical user interface) | :white_check_mark: | | | +| Custom Formats | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Predefined config files available (editable to personal preferences) | | :white_check_mark: | :white_check_mark: | +| Predefined profiles sync (with several personal selectable options) | :white_check_mark: | | | +| Clear all Custom Formats | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Scores | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Quality Settings (File Size) | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Naming Scheme | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| Quality Profiles | :white_check_mark: | :white_check_mark: | :white_check_mark: | --- @@ -67,4 +67,19 @@ Once set up, it is fully automated and checks for updates to custom formats and Recyclarr is a command line application utilizing configuration files to sync the guides to Radarr & Sonarr. +## Configarr + +[Github](https://github.com/raydak-labs/configarr){:target="\_blank" rel="noopener noreferrer"} // [Documentation](https://configarr.raydak.de){:target="\_blank" rel="noopener noreferrer"} + +Configarr is a synchronization tool primarily designed to run as a scheduled job (e.g., Cron) within containerized environments like Docker or Kubernetes. +Configarr is compatible with the Recyclarr templates until v7.4.0. +It enables the use of all Custom Formats and Quality Profiles defined in TRaSH-Guides while also allowing users to create new Custom Formats tailored to their specific setup. + +Main features are: + +- Support all of TRaSH-Guide provided JSON structures (CustomFormats, QualityProfiles, Naming) +- Customizability: Create and adjust everything as you need for your setup like own CustomFormats, different QualityProfiles, ... +- Container focus for best support in Docker and Kubernetes environments +- more in the Configarr docs + --8<-- "includes/support.md"