### Start Media Server Containers with Docker Compose

Source: https://configarr.de/docs/examples

This command initiates the media server containers defined in the `docker-compose.yml` file. It handles network creation and launches the Arr instances.

```bash
docker-compose up -d
```

--------------------------------

### Basic Configarr Configuration Example

Source: https://configarr.de/docs/installation/docker

A minimal `config.yml` example for Configarr. It includes settings for custom formats, Sonarr integration with quality definitions, and custom format mappings. Note the use of `!secret` for API keys, which requires proper secret management.

```yaml
#trashGuideUrl: https://github.com/BlackDark/fork-TRASH-Guides
#recyclarrConfigUrl: https://github.com/BlackDark/fork-recyclarr-configs
localCustomFormatsPath: /app/cfs
localConfigTemplatesPath: /app/templates

customFormatDefinitions:
  - trash_id: example-in-config-cf
    trash_scores:
      default: -10000
    trash_description: "Language: German Only"
    name: "Language: Not German"
    includeCustomFormatWhenRenaming: false
    specifications:
      - name: Not German Language
        implementation: LanguageSpecification
        negate: true
        required: false
        fields:
          value: 4

sonarr:
  instance1:
    # Set the URL/API Key to your actual instance
    base_url: http://sonarr:8989
    api_key: !secret SONARR_API_KEY

    quality_definition:
      type: series

    include:
      #### Custom
      - template: sonarr-cf # template name
      - template: sonarr-quality

    custom_formats:
      # Movie Versions
      - trash_ids:
          - 9f6cbff8cfe4ebbc1bde14c7b7bec0de # IMAX Enhanced
        quality_profiles:
          - name: ExampleProfile
            # score: 0 # Uncomment this line to disable prioritised IMAX Enhanced releases

radarr: {} # no radarr instance
```

--------------------------------

### Run Configarr with Docker Compose

Source: https://configarr.de/docs/examples

This command demonstrates how to run Configarr using Docker Compose after starting the media server containers. It specifies the job configuration file to use.

```bash
docker-compose -f docker-compose.jobs.yml run --rm configarr
```

--------------------------------

### Docker Compose Setup for Configarr

Source: https://configarr.de/docs/installation/docker

A recommended Docker Compose configuration for a maintainable Configarr setup. This file defines the service, image, container name, environment variables, and volume mounts for configuration, repositories, custom formats, and templates.

```yaml
#version: "3.8"
services:
  configarr:
    image: ghcr.io/raydak-labs/configarr:latest
    container_name: configarr
    #user: 1000:1000 # Optional, defaults to root:root
    environment:
      - TZ=Etc/UTC
    volumes:
      - ./config:/app/config # Contains the config.yml and secrets.yml
      - ./dockerrepos:/app/repos # Cache repositories
      - ./custom/cfs:/app/cfs # Optional if custom formats locally provided
      - ./custom/templates:/app/templates # Optional if custom templates
    # restart: "no" # optional make sure this is set to no or removed. Default is no
```

--------------------------------

### Synology NAS Task Scheduler Docker Command Example

Source: https://configarr.de/docs/installation/third-party

A concrete example of the Docker run command for Configarr on Synology NAS, specifying the time zone and volume paths.

```bash
docker run -d --rm --name=configarr -e TZ=Europe/Amsterdam -v /volume1/docker/configarr:/app/config ghcr.io/raydak-labs/configarr:1.12.0
```

--------------------------------

### Run Configarr with Docker

Source: https://configarr.de/docs/installation/docker

Quickly start Configarr using the official Docker image. This command mounts a local configuration directory to the container's config path. Ensure you replace `/path/to/config` with your actual configuration directory.

```shell
docker run -d \
  --name=configarr \
  -v /path/to/config:/config \
  ghcr.io/raydak-labs/configarr:latest

# Or use dockerhub image:

docker run -d \
  --name=configarr \
  -v /path/to/config:/config \
  configarr/configarr:latest
```

--------------------------------

### Use Local Templates with Configarr and Sonarr

Source: https://configarr.de/docs/examples

This configuration illustrates how to use locally stored templates with Configarr for Sonarr. It specifies a local path for templates and includes them in the Sonarr instance configuration.

```yaml
localConfigTemplatesPath: /app/templates

sonarr:
  instance1:
    base_url: !secret sonarr_url
    api_key: !secret sonarr_apikey

    include:
      - template: my-local-quality-definition-series
      - template: my-local-quality-profile
      - template: my-local-custom-formats
```

--------------------------------

### Redirect Configarr Cron Job Logs to File

Source: https://configarr.de/docs/examples

This example shows how to redirect the output of a Configarr cron job to a file for persistent logging. This is useful when running Configarr via cron to ensure logs are not lost.

```bash
# Example cron entry:
# 0 3 * * * /usr/local/bin/configarr >> /var/log/configarr.log 2>&1
```

--------------------------------

### Integrate Configarr with Sonarr Instance

Source: https://configarr.de/docs/examples

This YAML configuration demonstrates how to set up a Sonarr instance within Configarr. It includes the base URL, API key, and includes templates for quality definitions, profiles, and custom formats.

```yaml
sonarr:
  instance1:
    base_url: !secret sonarr_url
    api_key: !secret sonarr_apikey

    include:
      - template: sonarr-quality-definition-series
      - template: sonarr-v4-quality-profile-web-1080p
      - template: sonarr-v4-custom-formats-web-1080p
```

--------------------------------

### Implement TRaSH-Guide Profile in Radarr Config

Source: https://configarr.de/docs/examples

This snippet shows how to configure Radarr to use a TRaSH-Guide profile by specifying the `source` as `TRASH` and referencing the `trash_id` from the desired TRaSH-Guide profile JSON file.

```yaml
# ...  
radarr:
  instance1:
    # ...

    include:
      - template: 2b90e905c99490edc7c7a5787443748b
        source: TRASH

```

--------------------------------

### Example Config File with Telemetry Enabled

Source: https://configarr.de/docs/configuration/telemetry

This example shows a typical 'config.yml' file for Configarr, including the optional telemetry setting enabled.

```yaml
# Your normal configuration  
sonarr:  
  instance1:  
    base_url: http://sonarr:8989  
    api_key: !secret SONARR_API_KEY  
  
# Enable telemetry (optional)  
telemetry: true  

```

--------------------------------

### Verify Secret-Backed Environment Variables with Kubectl

Source: https://configarr.de/docs/installation/kubernetes

This command helps verify that your secret-backed environment variables are correctly configured and present in the Configarr pod. Use `kubectl describe pod <pod-name>` and inspect the 'Environment:' section. Replace `<pod-name>` with your pod's name.

```bash
kubectl describe pod <pod-name>
```

--------------------------------

### Apply Kubernetes Configuration using kubectl

Source: https://configarr.de/docs/installation/kubernetes

This shell command applies the Kubernetes resources defined in the `configarr.yaml` file to your cluster. Ensure `kubectl` is configured to access your cluster before running this command.

```shell
kubectl apply -f configarr.yaml
```

--------------------------------

### Integrate Metadata Profiles with Templates

Source: https://configarr.de/docs/configuration/experimental-support

This example demonstrates how metadata profiles can be defined in a template file and then merged with instance configurations. The final configuration includes profiles from both the template and the instance.

```yaml
templates/readarr.yml
metadata_profiles:
  - name: Standard
    min_popularity: 10

delete_unmanaged_metadata_profiles:
  enabled: true
  ignore: []

config.yml
readarr:
  instance1:
    include:
      - template: readarr
    metadata_profiles:
      - name: Audiobooks
        min_popularity: 5
```

--------------------------------

### Assign Scores to TRaSH-Guide Custom Formats in Radarr

Source: https://configarr.de/docs/examples

This configuration demonstrates how to assign specific scores to custom formats within Radarr, using `trash_ids` that correspond to entries in the TRaSH-Guide.

```yaml
# ...
radarr:
  instance1:
    # ...

    custom_formats:
      - trash_ids:
          - 3bc8df3a71baaac60a31ef696ea72d36
        assign_scores_to:
          - name: "[German] HD Bluray + WEB"
            score: 400

```

--------------------------------

### Stop and Remove Media Server Containers

Source: https://configarr.de/docs/examples

This command stops and removes all containers, networks, and volumes associated with the Docker Compose project, effectively cleaning up the environment.

```bash
docker-compose down -v
```

--------------------------------

### Implement HD Bluray + WEB Profile using Recyclarr Templates (Only Templates)

Source: https://configarr.de/docs/examples

This Radarr configuration snippet utilizes only Recyclarr templates to implement the 'HD Bluray + WEB' profile. It includes references to quality definition, custom formats, and quality profile templates from Recyclarr.

```yaml
# ...existing code...
radarr:
  hd-bluray-web-ger:
    # ...
    include:
      - template: radarr-quality-definition-movie
      - template: radarr-custom-formats-hd-bluray-web
      - template: radarr-quality-profile-hd-bluray-web

```

--------------------------------

### Define Custom Format in Configarr

Source: https://configarr.de/docs/examples

This snippet shows how to define a custom format directly within the configuration file. It specifies criteria for identifying media, such as language restrictions, and assigns a score.

```yaml
customFormatDefinitions:
  - trash_id: example-in-config-cf
    trash_scores:
      default: 10000
    trash_description: "Language: German Only"
    name: "Language: Not German"
    includeCustomFormatWhenRenaming: false
    specifications:
      - name: Not German Language
        implementation: LanguageSpecification
        negate: true
        required: false
        fields:
          value: 4
```

--------------------------------

### Deploy Configarr CronJob, Secret, and ConfigMap to Kubernetes

Source: https://configarr.de/docs/installation/kubernetes

This YAML defines the Kubernetes resources required to run Configarr as a CronJob. It includes a CronJob for scheduling, a Secret for sensitive environment variables like API keys, and a ConfigMap for the main configuration file (config.yml). The CronJob mounts volumes for repository caching and configuration, and injects environment variables from the Secret.

```yaml
---
apiVersion: batch/v1
kind: CronJob
metadata:
  name: configarr
spec:
  schedule: "0 * * * *" # Runs every hour
  successfulJobsHistoryLimit: 1
  failedJobsHistoryLimit: 1
  jobTemplate:
    spec:
      template:
        spec:
          containers:
            - name: configarr
              image: ghcr.io/raydak-labs/configarr:latest
              imagePullPolicy: Always
              tty: true # for color support
              envFrom:
                - configMapRef:
                    name: common-deployment-environment
                - secretRef:
                    name: configarr-env
              volumeMounts:
                - mountPath: /app/repos # Cache repositories
                  name: app-data
                  subPath: configarr-repos
                - name: config-volume # Mount specific config
                  mountPath: /app/config/config.yml
                  subPath: config.yml
          volumes:
            - name: app-data
              persistentVolumeClaim:
                claimName: media-app-data
            - name: config-volume
              configMap:
                name: configarr
          restartPolicy: Never
---
apiVersion: v1
kind: Secret
metadata:
  name: configarr-env
type: Opaque
stringData:
  SONARR_API_KEY: "your-sonarr-api-key-here"
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: configarr
data:
  config.yml: |
    trashGuideUrl: https://github.com/TRaSH-Guides/Guides
    recyclarrConfigUrl: https://github.com/recyclarr/config-templates

    sonarr:
      series:
        base_url: http://sonarr:8989
        api_key: !env SONARR_API_KEY

        quality_definition:
          type: series

        include:
          # WEB-1080p
          - template: sonarr-quality-definition-series
          - template: sonarr-v4-quality-profile-web-1080p
          - template: sonarr-v4-custom-formats-web-1080p

          # WEB-2160p
          - template: sonarr-v4-quality-profile-web-2160p
          - template: sonarr-v4-custom-formats-web-2160p

        custom_formats: []
    radarr: {}

```

--------------------------------

### Implement German HD Bluray + WEB Profile using Recyclarr Templates (Copy & Paste)

Source: https://configarr.de/docs/examples

This YAML configuration for Radarr shows how to include multiple Recyclarr templates to implement the 'German HD Bluray + WEB' profile, including quality definitions, custom formats, and quality profiles. It also includes commented-out options for fine-tuning custom format assignments.

```yaml
# ...existing code...
radarr:
  hd-bluray-web-ger:
    # ...
    include:
      - template: radarr-quality-definition-movie
      - template: radarr-custom-formats-hd-bluray-web-german
      - template: radarr-quality-profile-hd-bluray-web-german

    quality_profiles:
      - name: HD Bluray + WEB (GER)
        # min_format_score: 10000 # Uncomment this line to skip English Releases

    custom_formats:
      ### Optional
      - trash_ids:
        #  - b6832f586342ef70d9c128d40c07b872 # Bad Dual Groups
        #  - 90cedc1fea7ea5d11298bebd3d1d3223 # EVO (no WEBDL)
        #  - ae9b7c9ebde1f3bd336a8cbd1ec4c5e5 # No-RlsGroup
        #  - 7357cf5161efbf8c4d5d0c30b4815ee2 # Obfuscated
        #  - 5c44f52a8714fdd79bb4d98e2673be1f # Retags
        #  - f537cf427b64c38c8e36298f657e4828 # Scene
        assign_scores_to:
          - name: HD Bluray + WEB (GER)

      ### Movie Versions
      - trash_ids:
        # Uncomment any of the following lines to prefer these movie versions
        #  - 570bc9ebecd92723d2d21500f4be314c # Remaster
        #  - eca37840c13c6ef2dd0262b141a5482f # 4K Remaster
        #  - e0c07d59beb37348e975a930d5e50319 # Criterion Collection
        #  - 9d27d9d2181838f76dee150882bdc58c # Masters of Cinema
        #  - db9b4c4b53d312a3ca5f1378f6440fc9 # Vinegar Syndrome
        #  - 957d0f44b592285f26449575e8b1167e # Special Edition
        #  - eecf3a857724171f968a66cb5719e152 # IMAX
        #  - 9f6cbff8cfe4ebbc1bde14c7b7bec0de # IMAX Enhanced
        assign_scores_to:
          - name: HD Bluray + WEB (GER)

      ### Others
      - trash_ids:
        # - 839bea857ed2c0a8e084f3cbdbd65ecb # Uncomment this line to allow HDR/DV x265 HD releases
        assign_scores_to:
          - name: HD Bluray + WEB (GER)

      - trash_ids:
        #  - dc98083864ea246d05a42df0d05f81cc # Uncomment this line to allow any x265 HD releases
        #  - e6886871085226c3da1830830146846c # Uncomment this line to allow Generated Dynamic HDR
        assign_scores_to:
          - name: HD Bluray + WEB (GER)
            score: 0

```

--------------------------------

### Check Configarr CronJob Logs with Kubectl

Source: https://configarr.de/docs/installation/kubernetes

This snippet shows how to retrieve logs for Configarr CronJobs. It involves listing pods and then fetching logs for a specific pod identified by its name. Ensure you replace `<pod-name>` with the actual name of your Configarr pod.

```bash
kubectl get pods | grep configarr
kubectl logs <pod-name>
```

--------------------------------

### Apply Custom Formats to Sonarr Quality Profiles

Source: https://configarr.de/docs/examples

This section shows how to apply custom formats to specific Sonarr quality profiles. It uses `trash_ids` to reference custom format definitions and assigns scores to profiles like 'WEB-1080p'.

```yaml
    custom_formats:
      - trash_ids:
          - example-in-config-cf
        quality_profiles:
          - name: WEB-1080p
            # score: 0 # Uncomment this line to add custom scoring

      - trash_ids:
          - e6258996055b9fbab7e9cb2f75819294 # WEB Tier 01
        quality_profiles:
          - name: WEB-1080p
            score: 123
```

--------------------------------

### Synology NAS Task Scheduler Docker Command for Configarr

Source: https://configarr.de/docs/installation/third-party

Example Docker run command to schedule Configarr on a Synology NAS using the Task Scheduler. It includes parameters for time zone and volume mapping.

```bash
docker run -d --rm --name=configarr -e TZ=[YOUR-TIMEZONE] -v /[SYNOLOGY-VOLUME]/[SYNOLOGY-SHARED-FOLDER-OF-YOUR-DOCKER-CONTAINERS]/[CONFIGARR-SUBFOLDER]:/app/config ghcr.io/raydak-labs/configarr:[REQUIRED-VERSION]
```

--------------------------------

### Configure Radarr Custom Formats with TRaSH IDs

Source: https://configarr.de/docs/examples

This configuration snippet demonstrates how to assign custom formats to Radarr using TRaSH-Guide IDs. It includes various tiers for anime (BD, Web, LQ, v0-v4, Raws, VOSTFR, Dubs Only) and streaming services (VRV), as well as general movie tiers (Remux, WEB). The 'assign_scores_to' directive specifies that these scores are for Anime.

```yaml
radarr:
  instance1:
    custom_formats:
      # Scores from TRaSH json
      - trash_ids:
          # Anime CF/Scoring
          - fb3ccc5d5cc8f77c9055d4cb4561dded # Anime BD Tier 01 (Top SeaDex Muxers)
          - 66926c8fa9312bc74ab71bf69aae4f4a # Anime BD Tier 02 (SeaDex Muxers)
          - fa857662bad28d5ff21a6e611869a0ff # Anime BD Tier 03 (SeaDex Muxers)
          - f262f1299d99b1a2263375e8fa2ddbb3 # Anime BD Tier 04 (SeaDex Muxers)
          - ca864ed93c7b431150cc6748dc34875d # Anime BD Tier 05 (Remuxes)
          - 9dce189b960fddf47891b7484ee886ca # Anime BD Tier 06 (FanSubs)
          - 1ef101b3a82646b40e0cab7fc92cd896 # Anime BD Tier 07 (P2P/Scene)
          - 6115ccd6640b978234cc47f2c1f2cadc # Anime BD Tier 08 (Mini Encodes)
          - 8167cffba4febfb9a6988ef24f274e7e # Anime Web Tier 01 (Muxers)
          - 8526c54e36b4962d340fce52ef030e76 # Anime Web Tier 02 (Top FanSubs)
          - de41e72708d2c856fa261094c85e965d # Anime Web Tier 03 (Official Subs)
          - 9edaeee9ea3bcd585da9b7c0ac3fc54f # Anime Web Tier 04 (Official Subs)
          - 22d953bbe897857b517928f3652b8dd3 # Anime Web Tier 05 (FanSubs)
          - a786fbc0eae05afe3bb51aee3c83a9d4 # Anime Web Tier 06 (FanSubs)
          - b0fdc5897f68c9a68c70c25169f77447 # Anime LQ Groups
          - c259005cbaeb5ab44c06eddb4751e70c # v0
          - 5f400539421b8fcf71d51e6384434573 # v1
          - 3df5e6dfef4b09bb6002f732bed5b774 # v2
          - db92c27ba606996b146b57fbe6d09186 # v3
          - d4e5e842fad129a3c097bdb2d20d31a0 # v4
          - 06b6542a47037d1e33b15aa3677c2365 # Anime Raws
          - 9172b2f683f6223e3a1846427b417a3d # VOSTFR
          - b23eae459cc960816f2d6ba84af45055 # Dubs Only

          # Anime Streaming Services
          - 60f6d50cbd3cfc3e9a8c00e3a30c3114 # VRV

          # Main Guide Remux Tier Scoring
          - 3a3ff47579026e76d6504ebea39390de # Remux Tier 01
          - 9f98181fe5a3fbeb0cc29340da2a468a # Remux Tier 02
          - 8baaf0b3142bf4d94c42a724f034e27a # Remux Tier 03

          # Main Guide WEB Tier Scoring
          - c20f169ef63c5f40c2def54abaf4438e # WEB Tier 01
          - 403816d65392c79236dcb6dd591aeda4 # WEB Tier 02
          - af94e0fe497124d1f9ce732069ec8c3b # WEB Tier 03
      assign_scores_to:
        - name: Anime

```

--------------------------------

### Update Configarr with Docker Compose

Source: https://configarr.de/docs/installation/docker

Commands to update Configarr to the latest version using Docker Compose. First, pull the latest image, then run the container again to apply the update.

```shell
docker-compose pull
docker-compose run --rm configarr
```

--------------------------------

### Updating Configarr Version in Nix

Source: https://configarr.de/docs/installation/third-party

This guide outlines the process for updating Configarr to a new version within a Nix project. It involves modifying version numbers and hashes in the Nix package file and iteratively running `nix build` to obtain correct hashes for source and dependencies.

```text
1. Edit `nix/package.nix` and update the `version` field to the desired release (e.g., `"1.18.0"`)
2. Update the `rev` field in `fetchFromGitHub` to match: `"v1.18.0"`
3. Set both hash fields to empty strings (`hash = "";`)
4. Run `nix build` - it will fail and provide you with the correct hashes
5. Copy the hash from the error message for `fetchFromGitHub` and update the `src.hash` field
6. Run `nix build` again - it will fail again for the pnpm dependencies
7. Copy the hash from this error message and update the `pnpmDeps.hash` field
8. Run `nix build` once more - it should now succeed
```

--------------------------------

### Run Configarr with Docker Compose

Source: https://configarr.de/docs/installation/docker

Command to run Configarr using Docker Compose after saving the configuration to `docker-compose.yml`. This command ensures a clean run by removing any stopped containers associated with the service.

```shell
docker-compose run --rm configarr
```

--------------------------------

### Configure Radarr Quality Definition and Profiles

Source: https://configarr.de/docs/examples

This section configures Radarr's quality definition and profiles. It sets the default type to 'movie' and defines an 'Anime' quality profile. This profile enables score resetting for unmatched items, allows upgrades until a specific quality ('Remux-1080p') and score (10000), and sets a minimum format score. It also defines a hierarchy of quality definitions, prioritizing higher resolutions and specific types like Remux and WEB downloads.

```yaml
# if no anime use default
quality_definition:
  type: movie

quality_profiles:
  - name: Anime
    reset_unmatched_scores:
      enabled: true
    upgrade:
      allowed: true
      until_quality: Remux-1080p
      until_score: 10000
    min_format_score: 100
    score_set: anime-radarr
    quality_sort: top
    qualities:
      - name: Remux-1080p
        qualities:
          - Bluray-1080p
          - Remux-1080p
      - name: WEB 1080p
        qualities:
          - WEBDL-1080p
          - WEBRip-1080p
          - HDTV-1080p
      - name: Bluray-720p
      - name: WEB 720p
        qualities:
          - WEBDL-720p
          - WEBRip-720p
          - HDTV-720p
      - name: Bluray-576p
      - name: Bluray-480p
      - name: WEB 480p
        qualities:
          - WEBDL-480p
          - WEBRip-480p
      - name: DVD
      - name: SDTV

```

--------------------------------

### Custom Format Definition

Source: https://configarr.de/docs/configuration/experimental-support

Defines a custom format for use in media servers like Readarr or Lidarr. This example defines a custom format named 'ExampleReleaseTitleCF' that uses a regular expression to identify specific release titles.

```yaml
customFormatDefinitions:
  - trash_id: example-release-title-cf
    trash_scores:
      default: 0
    name: ExampleReleaseTitleCF
    includeCustomFormatWhenRenaming: false
    specifications:
      - name: Preferred Words
        implementation: ReleaseTitleSpecification
        negate: false
        required: false
        fields:
          value: "\\b(SPARKS|Framestor)\\b"
```

--------------------------------

### Ensure PersistentVolumeClaim is Bound with Kubectl

Source: https://configarr.de/docs/installation/kubernetes

This command checks the status of your PersistentVolumeClaims (PVCs) to ensure they are bound. A bound PVC is necessary for persistent storage, which Configarr might require. Run `kubectl get pvc` to list all PVCs and their status.

```bash
kubectl get pvc
```

--------------------------------

### Include TRaSH-Guides Format Templates from URLs

Source: https://configarr.de/docs/configuration/config-file

Shows how to include TRaSH-Guides format templates from URLs in config.yml. This enables the use of TRaSH-Guides quality profiles directly from remote JSON files. Specify `source: TRASH` for these entries and ensure the JSON files contain the `trash_id` field.

```yaml
sonarr:
  instance1:
    # ...
    include:
      - template: https://gist.githubusercontent.com/user/abc123/raw/trash-template.json
        source: TRASH
      - template: https://example.com/path/to/trash-profile.json
        source: TRASH

```

--------------------------------

### Test DNS Resolution within a Docker Container

Source: https://configarr.de/docs/faq

This command tests DNS resolution for a given host (e.g., github.com) from within a temporary BusyBox Docker container. It's useful for diagnosing 'Could not resolve host' errors.

```bash
docker run --rm -it busybox nslookup github.com
```

--------------------------------

### Define Quality Profile with Language - YAML

Source: https://configarr.de/docs/profiles

Example of defining a quality profile in a YAML configuration file, including support for specifying a language. This feature's availability depends on the specific *arr application version.

```yaml
radarr:
  instance1:
    # ...

    quality_profiles:
      - name: HD Bluray + WEB
        # Support added with 1.7.0. Not support in all *arr applications. Check the application if it is supported.
        language: Any # The name must match available names in *arr

```

--------------------------------

### Define Custom Format with Language Specification in Configarr

Source: https://configarr.de/docs/configuration/config-file

Example of defining a custom format with a language specification. This configuration targets media that is not in German, assigning a low score and setting it as not required for renaming. It uses the 'LanguageSpecification' implementation.

```yaml
# Optional. Custom Format Definitions  
customFormatDefinitions:  
  - trash_id: example-in-config-cf  
    trash_scores:  
      default: -10000  
    trash_description: "Language: German Only"  
    name: "Language: Not German"  
    includeCustomFormatWhenRenaming: false  
    specifications:  
      - name: Not German Language  
        implementation: LanguageSpecification  
        negate: true  
        required: false  
        fields:  
          value: 4  
```

--------------------------------

### Configure Readarr Instance with Release Title Specification - YAML

Source: https://configarr.de/docs/configuration/experimental-support

This YAML snippet illustrates the configuration for a Readarr instance within configarr, focusing on custom format definitions using a ReleaseTitleSpecification. It defines a custom format named 'ExampleReleaseTitleCF' that matches specific words in the release title. This is useful for prioritizing or filtering releases based on their titles.

```yaml
localCustomFormatsPath: /app/cfs
localConfigTemplatesPath: /app/templates

customFormatDefinitions:
  - trash_id: example-release-title-cf
    trash_scores:
      default: 0
    name: ExampleReleaseTitleCF
    includeCustomFormatWhenRenaming: false
    specifications:
      - name: Preferred Words
        implementation: ReleaseTitleSpecification
        negate: false
        required: false
        fields:
          value: "\\b(SPARKS|Framestor)\\b"

```

--------------------------------

### Calculating Configarr Source Hash from GitHub

Source: https://configarr.de/docs/installation/third-party

An alternative method to obtain the source hash for Configarr when updating. This involves downloading the source tarball directly from a GitHub release tag and then using the `nix hash file` command to calculate its hash.

```bash
https://github.com/raydak-labs/configarr/releases/tag/v[VERSION]
nix hash file [downloaded-file]
```

--------------------------------

### Overwrite Sonarr Quality Profile Scores with Local Templates

Source: https://configarr.de/docs/examples

This snippet shows how to overwrite existing quality profile scores in Sonarr when using local templates. It targets a specific custom format by `trash_id` and assigns a new score to a custom profile named 'MyLocalProfile'.

```yaml
    custom_formats:
      - trash_ids:
          - e6258996055b9fbab7e9cb2f75819294 # WEB Tier 01
        quality_profiles:
          - name: MyLocalProfile
            score: 123
```

--------------------------------

### Unraid Docker Configuration for Ofelia (Scheduler)

Source: https://configarr.de/docs/installation/third-party

Configuration details for running Ofelia as a Docker container on Unraid to schedule Configarr. This includes the container name, repository, volume mappings for the Docker socket and Ofelia's config file, and arguments for the daemon.

```docker
Name: ofelia
Repository: mcuadros/ofelia:latest
Post Arguments: daemon --config=/opt/config.ini

(add volume mappings like your setups requires it. Example with <name> - <host/unraid path>:<container path>)
Docker socket - /var/run/docker.sock:/var/run/docker.sock (Read Only)
Ofelia config file - /mnt/user/appdata/ofelia/ofelia.ini:/opt/config.ini (Read only)
```

--------------------------------

### Unraid Docker Configuration for Configarr

Source: https://configarr.de/docs/installation/third-party

Configuration details for running Configarr as a Docker container on Unraid. This includes the container name, repository, and volume mappings for configuration, repo cache, custom formats, and templates.

```docker
Name: configarr
Repository: configarr/configarr:latest

(add volume mappings like your setups requires it. Example with <name> - <host/unraid path>:<container path>)
Config volume - /mnt/user/appdata/configarr/config:/app/config
Repo cache - /mnt/user/appdata/configarr/repos:/app/repos
Custom formats - /mnt/user/appdata/configarr/cfs:/app/cfs
Templates - /mnt/user/appdata/configarr/templates:/app/templates
```

--------------------------------

### Troubleshoot Git Clone Errors with Docker

Source: https://configarr.de/docs/faq

This snippet demonstrates how to execute a git clone command within a running Docker container to diagnose network or repository access issues. It requires the container name or ID.

```bash
docker exec -it <container_name> sh
git clone https://github.com/recyclarr/config-templates/
```

--------------------------------

### Configure Custom Repository URLs for Configarr

Source: https://configarr.de/docs/configuration/config-file

Allows specifying custom Git repository URLs for TRaSH Guides and recyclarr configurations. Configarr automatically handles cache updates when these URLs change, deleting old repositories and cloning new ones without manual intervention. Ensure the specified revision exists in the new repository.

```yaml
# Optional: Override default repositories  
#trashGuideUrl: https://github.com/BlackDark/fork-TRASH-Guides  
#recyclarrConfigUrl: https://github.com/BlackDark/fork-recyclarr-configs  
```

--------------------------------

### Enabling/Disabling *Arr Instances

Source: https://configarr.de/docs/configuration/config-file

Shows how to globally enable or disable specific *Arr applications (Sonarr, Radarr, Whisparr, Readarr, Lidarr) within the configuration. Individual instances can also be disabled using an `enabled` flag.

```yaml
# true or false
sonarrEnabled: false
radarrEnabled: false
whisparrEnabled: false
readarrEnabled: false
lidarrEnabled: false

# You can also disable on per instance basis
sonarr:
  instance1:
    # ...
    enabled: false
```

--------------------------------

### Configure Whisparr Instance with Custom Formats - YAML

Source: https://configarr.de/docs/configuration/experimental-support

This YAML snippet demonstrates how to configure a Whisparr instance within configarr. It includes settings for custom format definitions, API key, base URL, and quality profiles. Note that some features like quality definition presets and language mapping are experimental or not fully supported.

```yaml
localCustomFormatsPath: /app/cfs
localConfigTemplatesPath: /app/templates

customFormatDefinitions:
  - trash_id: example-in-config-cf
    trash_scores:
      default: -10000
    trash_description: "Language: German Only"
    name: "Language: Not German"
    includeCustomFormatWhenRenaming: false
    specifications:
      - name: Not German Language
        implementation: LanguageSpecification
        negate: true
        required: false
        fields:
          value: 4

# experimental support: check https://configarr.rayak.de/docs/configuration/experimental-support
whisparr:
  instance1: # Instance name (can be any unique identifier)
    base_url: http://whisparr:6969 # instance URL
    api_key: !secret WHISPARR_API_KEY # Reference to API key in secrets.yml

    quality_definition:
      type: movie # TODO: not checked yet

    include:
      # only custom defined templates available
      - template: whisparr

    custom_formats: # Custom format assignments
      - trash_ids:
          - example-in-config-cf
        assign_scores_to:
          - name: ExampleProfile
            score: 1000

    quality_profiles:
      # TODO: language not correctly mapped
      - name: ExampleProfile
        upgrade:
          until_score: 200
          # Not supported in whisparr
          #min_format_score: 200

```

--------------------------------

### Override TRaSH-Guides and Recyclarr Repository URLs

Source: https://configarr.de/docs/configuration/config-file

Configures custom repository URLs for fetching TRaSH-Guides and Recyclarr templates. This allows users to point Configarr to their own forks or alternative sources for these template repositories, providing greater control over template management.

```yaml
# Use a custom TRaSH-Guides fork
trashGuideUrl: https://github.com/your-org/fork-TRASH-Guides

# Use a custom Recyclarr templates fork
recyclarrConfigUrl: https://github.com/your-org/fork-recyclarr-configs

```

--------------------------------

### Secret Management with !secret and !env

Source: https://configarr.de/docs/configuration/config-file

Demonstrates how to securely load sensitive information like API keys and URLs from external sources using YAML tags. `!secret` loads from a secrets file, while `!env` loads from environment variables, commonly used in containerized environments like Kubernetes.

```yaml
SECRETS_LOCATION=./config/secrets.yml,./config/overrides.yml
SECRETS_LOCATION=./config/secrets/*.yml
```

```yaml
sonarr:
  series:
    base_url: !env SONARR_URL
    api_key: !env SONARR_API_KEY

radarr:
  default:
    base_url: !secret RADARR_URL
    api_key: !secret RADARR_API_KEY
```

--------------------------------

### Configure Sonarr Download Clients with Configarr

Source: https://configarr.de/docs/configuration/config-file

This snippet demonstrates how to configure download clients for Sonarr using Configarr. It allows for the creation of download clients, management of their settings, and optional deletion of unmanaged clients. Ensure the 'api_key' and 'base_url' are correctly set for your Sonarr instance.

```yaml
sonarr:
  instance1:
    base_url: http://sonarr:8989
    api_key: !secret SONARR_API_KEY

    # (experimental) Manage Sonarr download clients
    download_clients:
      data:
        - name: "qBit 4K"
          type: qbittorrent
          enable: true
          priority: 1
          remove_completed_downloads: true
          remove_failed_downloads: true
          tags:
            - "4K" # Tag name (auto-resolved to ID)
          fields:
            host: qbittorrent
            port: 8080
            use_ssl: false
            url_base: /
            username: sonarr
            password: changeme
            tv_category: series-4k
       # Set to true to always update password otherwise existing passwords will not be updated because we can not retrieve existing passwords
       update_password: false
      # Delete unmanaged download clients
      delete_unmanaged:
        enabled: true
        ignore:
          - "Manual Test Client"
      # (since v1.19.0) Global download client configuration
      config:
        enable_completed_download_handling: true
        auto_redownload_failed: false
        auto_redownload_failed_from_interactive_search: false
        # Radarr only: Check interval for finished downloads (in minutes)
        # check_for_finished_download_interval: 1
```

--------------------------------

### Assign Custom Formats to Unmanaged Quality Profiles

Source: https://configarr.de/docs/configuration/config-file

Allows assigning custom formats to quality profiles that exist on the server but are not defined in the configuration file. This simplifies management by only needing to define the custom format mapping without specifying the quality profile details if it already exists.

```yaml
sonarr:
  instance1:
    base_url: http://sonarr:8989
    api_key: !secret SONARR_API_KEY

    # since v1.13.0. You can assign custom formats to quality profiles which are only managed on the server
    custom_formats:
      - trash_ids:
          - 47435ece6b99a0b477caf360e79ba0bb # x265 (HD)
        assign_scores_to:
          - name: Any

    # 'Any' already exists on server
    # quality_profiles:
    #   - name: Any
    #     # ...

```

--------------------------------

### Nix Flake Configuration for Configarr

Source: https://configarr.de/docs/installation/third-party

This snippet shows how to add Configarr as an input to your Nix flake and import its default NixOS module. It also demonstrates how to configure the configarr service, including setting up Radarr API key management using sops-nix.

```nix
inputs.configarr.url = "github:raydak-labs/configarr";

{
  config,
  inputs,
  ... 
}:
{
  imports = [
    inputs.configarr.nixosModules.default
  ];

  services.configarr = {
    config = 
      # yaml  
      ''
        radarr:
          radarr_instance:
            api_key: !env RADARR_API_KEY
            base_url: http://localhost:${toString config.services.radarr.settings.server.port}
            media_naming:
              folder: default
            root_folders:
              - /mnt/movies/English
      '';
    enable = true;
    environmentFile = "${config.sops.templates.configarr-ev.path}";
  };

  sops = {
    secrets = {
      radarr-api-key.sopsFile = ./secrets/radarr-api-key;
    };
    templates.configarr-ev = {
      content = ''
        LOG_LEVEL=debug
        LOG_STACKTRACE=true
        RADARR_API_KEY=${config.sops.placeholder.radarr-api-key}
      '';
      inherit (config.services.configarr) group;
      owner = config.services.configarr.user;
    };
  };
}
```