Host Configuration#

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

Configuration of a single Prowlarr instance:

prowlarr:
  hostname: "prowlarr.example.com"
  port: 9696
  protocol: "http"
  settings:
    ...

Configuration of multiple instances:

prowlarr:
  # Configuration and settings common to all instances.
  port: 9696
  settings:
    ...
  instances:
    # Prowlarr instance 1-specific configuration.
    prowlarr1:
      hostname: "prowlarr1.example.com"
      settings:
        ...
    # Prowlarr instance 2-specific configuration.
    prowlarr2:
      hostname: "prowlarr2.example.com"
      api_key: "..." # Explicitly define API key
      settings:
        ...
hostname: NonEmptyStr = 'prowlarr' class-attribute instance-attribute #

Hostname of the Prowlarr instance to connect to.

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

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

prowlarr:
  instances:
    prowlarr1: # <--- This becomes the default hostname
      ...
port: Port = 9696 class-attribute instance-attribute #

Port number of the Prowlarr instance to connect to.

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

Communication protocol to use to connect to Prowlarr.

Values:

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

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

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

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

Added in version 0.5.1.

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

API key to use to authenticate with the Prowlarr instance.

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

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

The expected version of the Prowlarr 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.

image: NonEmptyStr = 'lscr.io/linuxserver/prowlarr' class-attribute instance-attribute #

The default Docker image URI when generating a Docker Compose file.

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

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