Experimental support

This section describes experimental support for other *Arr tools. This means that some features of configarr are working as expected but not every feature must be supported.

warning

This is experimental and testing support. Support could be dropped in the future.

Whisparr v3

Experimental support for Whisparr was added with v1.4.0.

Configuration is mostly equal to the Sonarr or Radarr.

Following things are currently not supported or tested:

quality definition preset is not evaluated

quality_definition:
  type: movie # not checked yet

initial language of quality profiles is not correct -> 0
no available presets because nothings provided in TRaSH-Guides or recyclarr -> needs to be done manually with local templates and custom formats

Configuration File

Check configuration file reference for more information.

config.yml
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

Readarr v1

Experimental support for Readarr was added with v1.4.0.

Metadata profiles support was added with v1.19.0.

Configuration is mostly equal to the Sonarr or Radarr.

Following things are currently not supported or tested:

quality definition preset is not evaluated

quality_definition:
  type: movie # not checked yet

no available presets because nothings provided in TRaSH-Guides or recyclarr -> needs to be done manually with local templates and custom formats

Configuration File

Check configuration file reference for more information.

config.yml
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"

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

    # not supported
    # quality_definition:
    #   type: movie # Quality definition type

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

    custom_formats: # Custom format assignments
      - trash_ids:
          - example-release-title-cf
        assign_scores_to:
          - name: ExampleProfile
            score: 1000

    quality_profiles:
      - name: ExampleProfile
        upgrade:
          until_score: 200

    # Metadata Profiles (since v1.19.0)
    metadata_profiles:
      - name: Standard
        min_popularity: 10
        skip_missing_date: true
        skip_missing_isbn: false
        skip_parts_and_sets: false
        skip_secondary_series: false
        allowed_languages:
          - eng # ISO 639-3 language codes
          - deu
          - null # Allow books with no language
        min_pages: 50
        must_not_contain:
          - "Abridged"
          - "Large Print"

    # Delete unmanaged metadata profiles (since v1.19.0)
    delete_unmanaged_metadata_profiles:
      enabled: true
      ignore:
        - Default

Language Codes

Readarr metadata profiles use ISO 639-3 language codes (3-letter codes like eng, deu, fra).

Lidarr v2

Experimental support for Lidarr was added with v1.8.0.

Configuration is mostly equal to the Sonarr or Radarr.

Following things are currently not supported or tested:

quality definition preset is not evaluated

quality_definition:
  type: movie # not checked yet

no available presets because nothings provided in TRaSH-Guides or recyclarr -> needs to be done manually with local templates and custom formats

Configuration File

Check configuration file reference for more information.

config.yml
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"

# experimental support: check https://configarr.rayak.de/docs/configuration/experimental-support
lidarr:
  instance1:
    # Set the URL/API Key to your actual instance
    base_url: http://lidarr:8686
    api_key: !secret LIDARR_API_KEY

    # not supported
    # quality_definition:
    #   type: movie # Quality definition type

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

    custom_formats: # Custom format assignments
      - trash_ids:
          - example-release-title-cf
        assign_scores_to:
          - name: ExampleProfile
            score: 1000

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

    # Metadata Profiles (since v1.19.0)
    metadata_profiles:
      - name: Standard
        # at least one required
        primary_types:
          - Album
          - EP
          - Single
        # at least one required
        secondary_types:
          - Studio
          - Compilation
          - Soundtrack
        # at least one required
        release_statuses:
          - Official

    # Delete unmanaged metadata profiles (since v1.19.0)
    delete_unmanaged_metadata_profiles:
      enabled: true
      ignore:
        - SomeProfile

Lidarr Metadata Profile Fields

Field	Type	Description
`name`	string	Required. Profile name (must be unique)
`primary_types`	string array	Required. List of enabled primary album types (Album, EP, Single, Broadcast)
`secondary_types`	string array	Required. List of enabled secondary album types (Studio, Live, Compilation, etc.)
`release_statuses`	string array	Required. List of enabled release statuses (Official, Promotion, Bootleg, etc.)

How it works:

Only types/statuses listed in the arrays will be enabled (allowed)
All other types/statuses will be disabled

Example:

metadata_profiles:
  - name: Standard
    primary_types: [Album, EP] # Only Album and EP enabled
    secondary_types: [Studio, Compilation] # Only Studio and Compilation enabled
    release_statuses: [Official] # Only Official enabled

Metadata Profiles - Common Configuration

Both Readarr and Lidarr support metadata profiles to control what content is accepted.

Delete Unmanaged Profiles

You can automatically delete metadata profiles that exist on the server but are not defined in your configuration.

Simple form:

delete_unmanaged_metadata_profiles: true

Full form with ignore list:

delete_unmanaged_metadata_profiles:
  enabled: true
  ignore:
    - LegacyProfile
    - CustomProfile

Built-in Protection

The None profile (Lidarr/Readarr) is always protected from deletion, even if not in the ignore list.

Templates and Metadata Profiles

Metadata profiles can be defined in templates and merged with instance configurations.

Template:

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

delete_unmanaged_metadata_profiles:
  enabled: true
  ignore: []

Instance:

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

Result: Instance has both "Standard" (from template) and "Audiobooks" (from instance).

Best Practices

Test with dry run first:
```
DRY_RUN=true npm start
```
Use ISO 639-3 language codes for Readarr (e.g., eng, deu, not en, de)

Be explicit about deletion - always specify ignore list:

delete_unmanaged_metadata_profiles:
  enabled: true
  ignore:
    - Legacy

Use templates for shared profiles across instances

Whisparr v3​

Configuration File​

Readarr v1​

Configuration File​

Lidarr v2​

Configuration File​

Lidarr Metadata Profile Fields​

Metadata Profiles - Common Configuration​

Delete Unmanaged Profiles​

Templates and Metadata Profiles​

Best Practices​

Whisparr v3

Configuration File

Readarr v1

Configuration File

Lidarr v2

Configuration File

Lidarr Metadata Profile Fields

Metadata Profiles - Common Configuration

Delete Unmanaged Profiles

Templates and Metadata Profiles

Best Practices