General#

General configuration for Radarr are separated by category.

radarr:
  settings:
    general:
      host:
        bind_address: "*"
        port: 7878
        url_base: null
        use_ssl: false
        instance_name: Radarr (Buildarr Example)
      security:
        authentication: external
      proxy:
        enable: false
      logging:
        log_level: "INFO"
      analytics:
        send_anonymous_usage_data: true
      updates:
        branch: master
        automatic: false
        mechanism: docker
      backup:
        folder: Backups
        interval: 7
        retention: 28

Some of the settings may affect Buildarr's ability to connect with the Prowlarr instance. Take care when changing these settings.

Host#

Radarr instance connection and name configuration.

Many of these settings configure Radarr's external connection interface. If they are changed, the settings Buildarr uses to connect with this Radarr instance may need to be updated, so take care when modifying them.

Changing any of these settings require a restart of Radarr to take effect.

bind_address: Union[Literal['*'], IPv4Address] = '*' class-attribute instance-attribute #

Bind address for Radarr. Set to an IPv4 address bound to a local interface or * to bind on all interfaces.

Unless you run Radarr directly on a host machine (i.e. not via Docker) and want Radarr to only be available on a specific network or interface, this generally should be left untouched.

port: Port = 7878 class-attribute instance-attribute #

Unencrypted (HTTP) listening port for Radarr.

If Radarr is being run via Docker in the default bridge mode, this setting shouldn't be changed. Instead, change the external port it is bound to using --publish <port number>:7878.

ssl_port: Port = 9898 class-attribute instance-attribute #

Encrypted (HTTPS) listening port for Radarr.

If Radarr is being run via Docker in the default bridge mode, this setting shouldn't be changed. Instead, change the external port it is bound to using --publish <port number>:6969.

use_ssl: bool = False class-attribute instance-attribute #

Enable the encrypted (HTTPS) listening port in Radarr.

Instead of enabling HTTPS directly on Radarr, it is recommended to put Radarr behind a HTTPS-terminating reverse proxy such as Nginx, Caddy or Traefik.

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

Path to the TLS certificate file, in PFX format.

Required if encryption (HTTPS) is enabled.

ssl_cert_password: Optional[SecretStr] = None class-attribute instance-attribute #

Password to unlock the TLS certificate file, if required.

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

Add a prefix to all Radarr URLs, e.g. http://localhost:7878/<url_base>/settings/general.

Generally used to accommodate reverse proxies where Radarr is assigned to a subfolder, e.g. https://example.com/radarr.

instance_name: NonEmptyStr = 'Radarr' class-attribute instance-attribute #

Instance name in the browser tab and in syslog.

Security#

Radarr instance security (authentication) settings.

authentication: AuthenticationMethod = AuthenticationMethod.external class-attribute instance-attribute #

Authentication method for logging into Radarr.

Values:

  • none - No authentication (Radarr V4 only)
  • basic - Authentication using HTTP basic auth (browser popup)
  • form/forms - Authentication using a login page
  • external - External authentication using a reverse proxy (Radarr V5 and above)

Warning

When the authentication method is set to none or external, authentication is disabled within Radarr itself.

Make sure access to Radarr is secured, either by using a reverse proxy with forward authentication configured, or not exposing Radarr to the public Internet.

Requires a restart of Radarr to take effect.

Changed in version 0.2.0: Added support for the external authentication method.

authentication_required: AuthenticationRequired = AuthenticationRequired.enabled class-attribute instance-attribute #

Authentication requirement settings for accessing Radarr.

Available on Radarr V5 and above. Unused when managing Radarr V4 instances.

Values:

  • enabled - Enabled
  • local-disabled - Disabled for Local Addresses

New in version 0.2.0.

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

Username for the administrator user. Required if authentication is enabled.

Requires a restart of Radarr to take effect.

password: Optional[SecretStr] = None class-attribute instance-attribute #

Password for the administrator user. Required if authentication is enabled.

Requires a restart of Radarr to take effect.

certificate_validation: CertificateValidation = CertificateValidation.enabled class-attribute instance-attribute #

Change how strict HTTPS certification validation is. Do not change unless you understand the risks.

Values:

  • enabled - Validate HTTPS certificates for all hosts
  • local-disabled - Disable HTTPS certificate validation for hosts on the local network
  • disabled - Disable HTTPS certificate validation completely

Proxy#

Proxy configuration for Radarr.

enable: bool = False class-attribute instance-attribute #

Use a proxy server to access the Internet.

proxy_type: ProxyType = ProxyType.http class-attribute instance-attribute #

Type of proxy to connect to.

Values:

  • http - HTTP(S) proxy
  • socks4 - SOCKSv4 proxy
  • socks5 - SOCKSv5 proxy (Tor is supported)
hostname: Optional[str] = None class-attribute instance-attribute #

Proxy server hostname.

Required if using a proxy is enabled.

port: Port = 8080 class-attribute instance-attribute #

Proxy server access port.

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

Username to authenticate with. Only enter if authentication is required by the proxy.

password: Optional[SecretStr] = None class-attribute instance-attribute #

Password for the proxy user. Only enter if authentication is required by the proxy.

ignored_addresses: Set[NonEmptyStr] = set() class-attribute instance-attribute #

List of domains/addresses which bypass the proxy. Wildcards (*) are supported.

bypass_proxy_for_local_addresses: bool = True class-attribute instance-attribute #

Do not use the proxy to access local network addresses.

Logging#

Logging configuration for the Radarr application.

log_level: RadarrLogLevel = RadarrLogLevel.INFO class-attribute instance-attribute #

Verbosity of logging output.

Values:

  • INFO - Standard log output
  • DEBUG - Debugging log output
  • TRACE - Trace diagnostics log output

Analytics#

Configuration of analytics and telemetry from within Radarr.

send_anonymous_usage_data: bool = True class-attribute instance-attribute #

Send anonymous usage and error information to Radarr's servers.

This includes information on your browser, which Radarr Web UI pages you use, error reporting and OS/runtime versions. This information is reportedly used to prioritise features and bug fixes.

Requires a restart of Radarr to take effect.

Updates#

Settings for updating Radarr.

branch: NonEmptyStr = 'master' class-attribute instance-attribute #

Branch used by the external update mechanism. Changing this value has no effect on Docker installations.

If unsure, leave this undefined in Buildarr and use the value already set in Radarr.

automatic: bool = False class-attribute instance-attribute #

Automatically download and install updates. Manual updates can still be performed from System -> Updates.

This option must be left set to false on Docker installations.

mechanism: UpdateMechanism = UpdateMechanism.docker class-attribute instance-attribute #

Set the mechanism for updating Radarr. Must be set to docker on Docker installations.

Values:

  • builtin - Radarr built-in updater mechanism
  • script - Use the configured update script
  • external - External update mechanism
  • apt - Debian APT package
  • docker - Docker image
script_path: Optional[str] = None class-attribute instance-attribute #

Path to a custom script that takes an extracted update package and handles the remainder of the update process.

Required if mechanism is set to script.

Backup#

Settings for Radarr automatic backups.

folder: NonEmptyStr = 'Backups' class-attribute instance-attribute #

Folder to backup Radarr data to.

Relative paths will be under Radarr's AppData directory.

interval: int = Field(7, ge=1, le=7) class-attribute instance-attribute #

Interval between automatic backups, in days.

Must be set somewhere between 1 and 7 days.

retention: int = Field(28, ge=1, le=90) class-attribute instance-attribute #

Retention period for backups, in days. Backups older than the retention period will be cleaned up automatically.

Must be set somewhere between 1 and 90 days.