Host Configuration#

By default, Buildarr will look for a single instance at http://sonarr:8989. Most configurations are different, and to accommodate those, you can configure how Buildarr connects to individual Sonarr instances.

Configuration of a single Sonarr instance:

sonarr:
  hostname: "sonarr.example.com"
  port: 8989
  protocol: "http"
  settings:
    ...

Configuration of multiple instances:

sonarr:
  # Configuration and settings common to all instances.
  port: 8989
  settings:
    ...
  instances:
    # Sonarr instance 1-specific configuration.
    sonarr1:
      hostname: "sonarr1.example.com"
      settings:
        ...
    # Sonarr instance 2-specific configuration.
    sonarr2:
      hostname: "sonarr2.example.com"
      api_key: "..." # Explicitly define API key
      settings:
        ...
hostname: NonEmptyStr = 'sonarr' class-attribute instance-attribute #

Hostname of the Sonarr instance to connect to.

When defining a single instance using the global sonarr configuration block, the default hostname is sonarr.

When using multiple instance-specific configurations, the default hostname is the name given to the instance in the instances attribute.

sonarr:
  instances:
    sonarr1: # <--- This becomes the default hostname
      ...
port: Port = 8989 class-attribute instance-attribute #

Port number of the Sonarr instance to connect to.

protocol: SonarrProtocol = 'http' class-attribute instance-attribute #

Communication protocol to use to connect to Sonarr.

url_base: Optional[str] = None class-attribute instance-attribute #

The URL path the Sonarr instance API is available under, if behind a reverse proxy.

API URLs are rendered like this: <protocol>://<hostname>:<port><url_base>/api/v3/...

When unset, the URL root will be used as the API endpoint (e.g. <protocol>://<hostname>:<port>/api/v3/...).

Added in version 0.6.3.

api_key: Optional[SonarrApiKey] = None class-attribute instance-attribute #

API key to use to authenticate with the Sonarr instance.

If undefined or set to None, automatically retrieve the API key. This can only be done on Sonarr instances with authentication disabled.

version: Optional[str] = None class-attribute instance-attribute #

The expected version of the Sonarr instance. If undefined or set to None, the version is auto-detected.

This value is also used when generating a Docker Compose file. When undefined or set to None, the version tag will be set to latest.

settings: SonarrSettingsConfig = SonarrSettingsConfig() class-attribute instance-attribute #

Sonarr settings. Configuration options for Sonarr itself are set within this structure.