Notifiarr Client¶

Description / name	Input element
Your domain name

Overview¶

Notifiarr Client is the unified client for Notifiarr.com. The client enables content requests from Media Bot in your Discord Server. It also provides reports for Plex usage and system health. Other features can be configured on the Notifiarr website..

Manual

Releases

Community

Configuration¶

Snapshot Feature Support¶

Add the following to your Inventory file to enable Privileged mode for Notifiarr and allow it access to system information
```
notifiarr_privileged: true
```
Run the Notifiarr role:
```
sb install sandbox-notifiarr
```

API Key¶

You will need a Notifiarr account api key to use Notifiarr. You can get one by signing up for a free account.

After logging in, you should be redirected to your profile screen.

Click on Generate API Key (This needs to be done)
Select your Country
Select your Timezone
Change your Time Format to your liking
Select your Notification Language
Don't forget to Save your changes

Add your API key to the Sandbox settings file

You also need to define a username and password for the Notifiarr client webui in the Sandbox settings file. You can review the password requirements here.

Deployment¶

sb install sandbox-notifiarr

Usage¶

The Notifiarr url will only display the app status https://notifiarr.iYOUR_DOMAIN_NAMEi

Now go to the Notifiarr website and configure your integrations and discord server. Refer to the Notifiarr documentation for more information.

The role will attempt to configure Sonarr, Radarr, Plex, and Tautulli. Other apps can be edited in the config file which can be found at "/opt/notifiarr/notifiarr.conf" in a standard install. From time to time new options will be added and an example config file can be found here.

A guide to setup and sync TRaSH guides with Radarr and Sonarr can be found on the TRaSH Guides website.

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
notifiarr_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like notifiarr_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

Instead, use the corresponding _custom variable (like notifiarr_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsSettingsWebDNSTraefikDockerDocker+Global Override Options

notifiarr_name

# Type: string
notifiarr_name: notifiarr

notifiarr_role_privileged

# Type: bool (true/false)
notifiarr_role_privileged: false

notifiarr_role_web_subdomain

# Type: string
notifiarr_role_web_subdomain: "{{ notifiarr_name }}"

notifiarr_role_web_domain

# Type: string
notifiarr_role_web_domain: "{{ user.domain }}"

notifiarr_role_web_port

# Type: string
notifiarr_role_web_port: "5454"

notifiarr_role_web_url

# Type: string
notifiarr_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='notifiarr') + '.' + lookup('role_var', '_web_domain', role='notifiarr')
                         if (lookup('role_var', '_web_subdomain', role='notifiarr') | length > 0)
                         else lookup('role_var', '_web_domain', role='notifiarr')) }}"

notifiarr_role_dns_record

# Type: string
notifiarr_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='notifiarr') }}"

notifiarr_role_dns_zone

# Type: string
notifiarr_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='notifiarr') }}"

notifiarr_role_dns_proxy

# Type: bool (true/false)
notifiarr_role_dns_proxy: "{{ dns_proxied }}"

notifiarr_role_traefik_sso_middleware

# Type: string
notifiarr_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

notifiarr_role_traefik_middleware_default

# Type: string
notifiarr_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

notifiarr_role_traefik_middleware_custom

# Type: string
notifiarr_role_traefik_middleware_custom: ""

notifiarr_role_traefik_certresolver

# Type: string
notifiarr_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

notifiarr_role_traefik_enabled

# Type: bool (true/false)
notifiarr_role_traefik_enabled: true

notifiarr_role_traefik_api_enabled

# Type: bool (true/false)
notifiarr_role_traefik_api_enabled: true

notifiarr_role_traefik_api_endpoint

# Type: string
notifiarr_role_traefik_api_endpoint: "PathPrefix(`/api`) || PathPrefix(`/plex`)"

Container

notifiarr_role_docker_container

# Type: string
notifiarr_role_docker_container: "{{ notifiarr_name }}"

Image

notifiarr_role_docker_image_pull

# Type: bool (true/false)
notifiarr_role_docker_image_pull: true

notifiarr_role_docker_image_tag

# Type: string
notifiarr_role_docker_image_tag: "latest"

notifiarr_role_docker_image_repo

# Type: string
notifiarr_role_docker_image_repo: "golift/notifiarr"

notifiarr_role_docker_image

# Type: string
notifiarr_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='notifiarr') }}:{{ lookup('role_var', '_docker_image_tag', role='notifiarr') }}"

Envs

notifiarr_role_docker_envs_default

# Type: dict
notifiarr_role_docker_envs_default:
  TZ: "{{ tz }}"

notifiarr_role_docker_envs_custom

# Type: dict
notifiarr_role_docker_envs_custom: {}

Volumes

notifiarr_role_docker_volumes_default

# Type: list
notifiarr_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='notifiarr') }}:/config"
  - "/var/run/utmp:/var/run/utmp"

notifiarr_role_docker_volumes_custom

# Type: list
notifiarr_role_docker_volumes_custom: []

Mounts

notifiarr_role_docker_mounts_default

# Type: list
notifiarr_role_docker_mounts_default:
  - target: /tmp
    type: tmpfs

notifiarr_role_docker_mounts_custom

# Type: list
notifiarr_role_docker_mounts_custom: []

Hostname

notifiarr_role_docker_hostname

# Type: string
notifiarr_role_docker_hostname: "{{ traefik_host }}"

Networks

notifiarr_role_docker_networks_alias

# Type: string
notifiarr_role_docker_networks_alias: "{{ notifiarr_name }}"

notifiarr_role_docker_networks_default

# Type: list
notifiarr_role_docker_networks_default: []

notifiarr_role_docker_networks_custom

# Type: list
notifiarr_role_docker_networks_custom: []

Restart Policy

notifiarr_role_docker_restart_policy

# Type: string
notifiarr_role_docker_restart_policy: unless-stopped

State

notifiarr_role_docker_state

# Type: string
notifiarr_role_docker_state: started

User

notifiarr_role_docker_user

# Type: string
notifiarr_role_docker_user: "{{ uid }}:{{ gid }}"

Privileged

notifiarr_role_docker_privileged

# Type: string
notifiarr_role_docker_privileged: "{{ lookup('role_var', '_privileged', role='notifiarr') | bool }}"

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

notifiarr_role_docker_blkio_weight

# Type: int
notifiarr_role_docker_blkio_weight:

notifiarr_role_docker_cpu_period

# Type: int
notifiarr_role_docker_cpu_period:

notifiarr_role_docker_cpu_quota

# Type: int
notifiarr_role_docker_cpu_quota:

notifiarr_role_docker_cpu_shares

# Type: int
notifiarr_role_docker_cpu_shares:

notifiarr_role_docker_cpus

# Type: string
notifiarr_role_docker_cpus:

notifiarr_role_docker_cpuset_cpus

# Type: string
notifiarr_role_docker_cpuset_cpus:

notifiarr_role_docker_cpuset_mems

# Type: string
notifiarr_role_docker_cpuset_mems:

notifiarr_role_docker_kernel_memory

# Type: string
notifiarr_role_docker_kernel_memory:

notifiarr_role_docker_memory

# Type: string
notifiarr_role_docker_memory:

notifiarr_role_docker_memory_reservation

# Type: string
notifiarr_role_docker_memory_reservation:

notifiarr_role_docker_memory_swap

# Type: string
notifiarr_role_docker_memory_swap:

notifiarr_role_docker_memory_swappiness

# Type: int
notifiarr_role_docker_memory_swappiness:

notifiarr_role_docker_shm_size

# Type: string
notifiarr_role_docker_shm_size:

Security & Devices

notifiarr_role_docker_cap_drop

# Type: list
notifiarr_role_docker_cap_drop:

notifiarr_role_docker_cgroupns_mode

# Type: string
notifiarr_role_docker_cgroupns_mode:

notifiarr_role_docker_device_cgroup_rules

# Type: list
notifiarr_role_docker_device_cgroup_rules:

notifiarr_role_docker_device_read_bps

# Type: list
notifiarr_role_docker_device_read_bps:

notifiarr_role_docker_device_read_iops

# Type: list
notifiarr_role_docker_device_read_iops:

notifiarr_role_docker_device_requests

# Type: list
notifiarr_role_docker_device_requests:

notifiarr_role_docker_device_write_bps

# Type: list
notifiarr_role_docker_device_write_bps:

notifiarr_role_docker_device_write_iops

# Type: list
notifiarr_role_docker_device_write_iops:

notifiarr_role_docker_devices

# Type: list
notifiarr_role_docker_devices:

notifiarr_role_docker_devices_default

# Type: string
notifiarr_role_docker_devices_default:

notifiarr_role_docker_groups

# Type: list
notifiarr_role_docker_groups:

notifiarr_role_docker_security_opts

# Type: list
notifiarr_role_docker_security_opts:

notifiarr_role_docker_userns_mode

# Type: string
notifiarr_role_docker_userns_mode:

Networking

notifiarr_role_docker_dns_opts

# Type: list
notifiarr_role_docker_dns_opts:

notifiarr_role_docker_dns_search_domains

# Type: list
notifiarr_role_docker_dns_search_domains:

notifiarr_role_docker_dns_servers

# Type: list
notifiarr_role_docker_dns_servers:

notifiarr_role_docker_domainname

# Type: string
notifiarr_role_docker_domainname:

notifiarr_role_docker_exposed_ports

# Type: list
notifiarr_role_docker_exposed_ports:

notifiarr_role_docker_hosts

# Type: dict
notifiarr_role_docker_hosts:

notifiarr_role_docker_hosts_use_common

# Type: bool (true/false)
notifiarr_role_docker_hosts_use_common:

notifiarr_role_docker_ipc_mode

# Type: string
notifiarr_role_docker_ipc_mode:

notifiarr_role_docker_links

# Type: list
notifiarr_role_docker_links:

notifiarr_role_docker_network_mode

# Type: string
notifiarr_role_docker_network_mode:

notifiarr_role_docker_pid_mode

# Type: string
notifiarr_role_docker_pid_mode:

notifiarr_role_docker_ports

# Type: list
notifiarr_role_docker_ports:

notifiarr_role_docker_uts

# Type: string
notifiarr_role_docker_uts:

Storage

notifiarr_role_docker_keep_volumes

# Type: bool (true/false)
notifiarr_role_docker_keep_volumes:

notifiarr_role_docker_storage_opts

# Type: dict
notifiarr_role_docker_storage_opts:

notifiarr_role_docker_tmpfs

# Type: list
notifiarr_role_docker_tmpfs:

notifiarr_role_docker_volume_driver

# Type: string
notifiarr_role_docker_volume_driver:

notifiarr_role_docker_volumes_from

# Type: list
notifiarr_role_docker_volumes_from:

notifiarr_role_docker_volumes_global

# Type: bool (true/false)
notifiarr_role_docker_volumes_global:

notifiarr_role_docker_working_dir

# Type: string
notifiarr_role_docker_working_dir:

Monitoring & Lifecycle

notifiarr_role_docker_auto_remove

# Type: bool (true/false)
notifiarr_role_docker_auto_remove:

notifiarr_role_docker_cleanup

# Type: bool (true/false)
notifiarr_role_docker_cleanup:

notifiarr_role_docker_force_kill

# Type: string
notifiarr_role_docker_force_kill:

notifiarr_role_docker_healthcheck

# Type: dict
notifiarr_role_docker_healthcheck:

notifiarr_role_docker_healthy_wait_timeout

# Type: int
notifiarr_role_docker_healthy_wait_timeout:

notifiarr_role_docker_init

# Type: bool (true/false)
notifiarr_role_docker_init:

notifiarr_role_docker_kill_signal

# Type: string
notifiarr_role_docker_kill_signal:

notifiarr_role_docker_log_driver

# Type: string
notifiarr_role_docker_log_driver:

notifiarr_role_docker_log_options

# Type: dict
notifiarr_role_docker_log_options:

notifiarr_role_docker_oom_killer

# Type: bool (true/false)
notifiarr_role_docker_oom_killer:

notifiarr_role_docker_oom_score_adj

# Type: int
notifiarr_role_docker_oom_score_adj:

notifiarr_role_docker_output_logs

# Type: bool (true/false)
notifiarr_role_docker_output_logs:

notifiarr_role_docker_paused

# Type: bool (true/false)
notifiarr_role_docker_paused:

notifiarr_role_docker_recreate

# Type: bool (true/false)
notifiarr_role_docker_recreate:

notifiarr_role_docker_restart_retries

# Type: int
notifiarr_role_docker_restart_retries:

notifiarr_role_docker_stop_timeout

# Type: int
notifiarr_role_docker_stop_timeout:

Other Options

notifiarr_role_docker_capabilities

# Type: list
notifiarr_role_docker_capabilities:

notifiarr_role_docker_cgroup_parent

# Type: string
notifiarr_role_docker_cgroup_parent:

notifiarr_role_docker_commands

# Type: list
notifiarr_role_docker_commands:

notifiarr_role_docker_create_timeout

# Type: int
notifiarr_role_docker_create_timeout:

notifiarr_role_docker_entrypoint

# Type: string
notifiarr_role_docker_entrypoint:

notifiarr_role_docker_env_file

# Type: string
notifiarr_role_docker_env_file:

notifiarr_role_docker_labels

# Type: dict
notifiarr_role_docker_labels:

notifiarr_role_docker_labels_use_common

# Type: bool (true/false)
notifiarr_role_docker_labels_use_common:

notifiarr_role_docker_read_only

# Type: bool (true/false)
notifiarr_role_docker_read_only:

notifiarr_role_docker_runtime

# Type: string
notifiarr_role_docker_runtime:

notifiarr_role_docker_sysctls

# Type: list
notifiarr_role_docker_sysctls:

notifiarr_role_docker_ulimits

# Type: list
notifiarr_role_docker_ulimits:

notifiarr_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
notifiarr_role_autoheal_enabled: true

notifiarr_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
notifiarr_role_depends_on: ""

notifiarr_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
notifiarr_role_depends_on_delay: "0"

notifiarr_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
notifiarr_role_depends_on_healthchecks:

notifiarr_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
notifiarr_role_diun_enabled: true

notifiarr_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
notifiarr_role_dns_enabled: true

notifiarr_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
notifiarr_role_docker_controller: true

notifiarr_role_docker_image_repo

# Type: string
notifiarr_role_docker_image_repo:

notifiarr_role_docker_image_tag

# Type: string
notifiarr_role_docker_image_tag:

notifiarr_role_docker_volumes_download

# Type: bool (true/false)
notifiarr_role_docker_volumes_download:

notifiarr_role_paths_location

# Type: string
notifiarr_role_paths_location:

notifiarr_role_privileged

# Type: bool (true/false)
notifiarr_role_privileged:

notifiarr_role_themepark_addons

# Type: string
notifiarr_role_themepark_addons:

notifiarr_role_themepark_app

# Type: string
notifiarr_role_themepark_app:

notifiarr_role_themepark_theme

# Type: string
notifiarr_role_themepark_theme:

notifiarr_role_traefik_api_endpoint

# Type: dict/omit
notifiarr_role_traefik_api_endpoint:

notifiarr_role_traefik_api_middleware

# Type: string
notifiarr_role_traefik_api_middleware:

notifiarr_role_traefik_api_middleware_http

# Type: string
notifiarr_role_traefik_api_middleware_http:

notifiarr_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
notifiarr_role_traefik_autodetect_enabled: false

notifiarr_role_traefik_certresolver

# Type: string
notifiarr_role_traefik_certresolver:

notifiarr_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
notifiarr_role_traefik_crowdsec_enabled: false

notifiarr_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
notifiarr_role_traefik_error_pages_enabled: false

notifiarr_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
notifiarr_role_traefik_gzip_enabled: false

notifiarr_role_traefik_middleware_http

# Type: string
notifiarr_role_traefik_middleware_http:

notifiarr_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
notifiarr_role_traefik_middleware_http_api_insecure:

notifiarr_role_traefik_middleware_http_insecure

# Type: bool (true/false)
notifiarr_role_traefik_middleware_http_insecure:

notifiarr_role_traefik_priority

# Type: string
notifiarr_role_traefik_priority:

notifiarr_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
notifiarr_role_traefik_robot_enabled: true

notifiarr_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
notifiarr_role_traefik_tailscale_enabled: false

notifiarr_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
notifiarr_role_traefik_wildcard_enabled: true

notifiarr_role_web_domain

# Type: string
notifiarr_role_web_domain:

notifiarr_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
notifiarr_role_web_fqdn_override:

Example Override

notifiarr_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "notifiarr2.{{ user.domain }}"
  - "notifiarr.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

notifiarr_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
notifiarr_role_web_host_override:

Example Override

notifiarr_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'notifiarr2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

notifiarr_role_web_http_port

# Type: string (quoted number)
notifiarr_role_web_http_port:

notifiarr_role_web_http_scheme

# Type: string ("http"/"https")
notifiarr_role_web_http_scheme:

notifiarr_role_web_http_serverstransport

# Type: dict/omit
notifiarr_role_web_http_serverstransport:

notifiarr_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
notifiarr_role_web_scheme:

notifiarr_role_web_serverstransport

# Type: dict/omit
notifiarr_role_web_serverstransport:

notifiarr_role_web_subdomain

# Type: string
notifiarr_role_web_subdomain: