Apprise API¶

Description / name	Input element
Your domain name

Overview¶

Apprise API is an open-source, lightweight REST framework that provides a unified interface to send notifications to over 100 services—such as email, SMS, Slack, Telegram, and Discord—via a single API.

Manual

Releases

Community

Note

Saltbox has a built-in Apprise client that can be used to send notifications. This container is not only used to provide a web UI for configuring and managing notifications, but it also exposes an API. This API allows for programmatic interaction, enabling other applications or scripts to send notifications through the Apprise service. For more information, see the Apprise Client Docs.

Deployment¶

sb install sandbox-apprise

Usage¶

Visit https://apprise.iYOUR_DOMAIN_NAMEi.

Basics¶

The instance runs on the Docker network accessible to other saltbox network containers at http://apprise:8000

The configured username/password are taken from your Saltbox accounts.yml file located in /srv/git/saltbox/accounts.yml

A typical apprise URL would look like this:

https://apprise.iYOUR_DOMAIN_NAMEi/notify?service=discord&title=Hello&body=World

Role Defaults¶

Use the Inventory to customize variables. (1)

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

When overriding variables that end in _default (like apprise_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 apprise_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsWebDNSTraefikDockerDocker+Global Override Options

apprise_name

# Type: string
apprise_name: apprise

apprise_role_web_subdomain

# Type: string
apprise_role_web_subdomain: "{{ apprise_name }}"

apprise_role_web_domain

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

apprise_role_web_port

# Type: string
apprise_role_web_port: "8000"

apprise_role_web_url

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

apprise_role_dns_record

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

apprise_role_dns_zone

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

apprise_role_dns_proxy

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

apprise_role_traefik_sso_middleware

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

apprise_role_traefik_middleware_default

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

apprise_role_traefik_middleware_custom

# Type: string
apprise_role_traefik_middleware_custom: ""

apprise_role_traefik_certresolver

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

apprise_role_traefik_enabled

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

Container

apprise_role_docker_container

# Type: string
apprise_role_docker_container: "{{ apprise_name }}"

Image

apprise_role_docker_image_pull

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

apprise_role_docker_image_repo

# Type: string
apprise_role_docker_image_repo: "lscr.io/linuxserver/apprise-api"

apprise_role_docker_image_tag

# Type: string
apprise_role_docker_image_tag: "latest"

apprise_role_docker_image

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

Envs

apprise_role_docker_envs_default

# Type: dict
apprise_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"

apprise_role_docker_envs_custom

# Type: dict
apprise_role_docker_envs_custom: {}

Volumes

apprise_role_docker_volumes_default

# Type: list
apprise_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='apprise') }}:/config"

apprise_role_docker_volumes_custom

# Type: list
apprise_role_docker_volumes_custom: []

Hostname

apprise_role_docker_hostname

# Type: string
apprise_role_docker_hostname: "{{ apprise_name }}"

Networks

apprise_role_docker_networks_alias

# Type: string
apprise_role_docker_networks_alias: "{{ apprise_name }}"

apprise_role_docker_networks_default

# Type: list
apprise_role_docker_networks_default: []

apprise_role_docker_networks_custom

# Type: list
apprise_role_docker_networks_custom: []

Restart Policy

apprise_role_docker_restart_policy

# Type: string
apprise_role_docker_restart_policy: unless-stopped

State

apprise_role_docker_state

# Type: string
apprise_role_docker_state: started

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

Resource Limits

apprise_role_docker_blkio_weight

# Type: int
apprise_role_docker_blkio_weight:

apprise_role_docker_cpu_period

# Type: int
apprise_role_docker_cpu_period:

apprise_role_docker_cpu_quota

# Type: int
apprise_role_docker_cpu_quota:

apprise_role_docker_cpu_shares

# Type: int
apprise_role_docker_cpu_shares:

apprise_role_docker_cpus

# Type: string
apprise_role_docker_cpus:

apprise_role_docker_cpuset_cpus

# Type: string
apprise_role_docker_cpuset_cpus:

apprise_role_docker_cpuset_mems

# Type: string
apprise_role_docker_cpuset_mems:

apprise_role_docker_kernel_memory

# Type: string
apprise_role_docker_kernel_memory:

apprise_role_docker_memory

# Type: string
apprise_role_docker_memory:

apprise_role_docker_memory_reservation

# Type: string
apprise_role_docker_memory_reservation:

apprise_role_docker_memory_swap

# Type: string
apprise_role_docker_memory_swap:

apprise_role_docker_memory_swappiness

# Type: int
apprise_role_docker_memory_swappiness:

apprise_role_docker_shm_size

# Type: string
apprise_role_docker_shm_size:

Security & Devices

apprise_role_docker_cap_drop

# Type: list
apprise_role_docker_cap_drop:

apprise_role_docker_cgroupns_mode

# Type: string
apprise_role_docker_cgroupns_mode:

apprise_role_docker_device_cgroup_rules

# Type: list
apprise_role_docker_device_cgroup_rules:

apprise_role_docker_device_read_bps

# Type: list
apprise_role_docker_device_read_bps:

apprise_role_docker_device_read_iops

# Type: list
apprise_role_docker_device_read_iops:

apprise_role_docker_device_requests

# Type: list
apprise_role_docker_device_requests:

apprise_role_docker_device_write_bps

# Type: list
apprise_role_docker_device_write_bps:

apprise_role_docker_device_write_iops

# Type: list
apprise_role_docker_device_write_iops:

apprise_role_docker_devices

# Type: list
apprise_role_docker_devices:

apprise_role_docker_devices_default

# Type: string
apprise_role_docker_devices_default:

apprise_role_docker_groups

# Type: list
apprise_role_docker_groups:

apprise_role_docker_privileged

# Type: bool (true/false)
apprise_role_docker_privileged:

apprise_role_docker_security_opts

# Type: list
apprise_role_docker_security_opts:

apprise_role_docker_user

# Type: string
apprise_role_docker_user:

apprise_role_docker_userns_mode

# Type: string
apprise_role_docker_userns_mode:

Networking

apprise_role_docker_dns_opts

# Type: list
apprise_role_docker_dns_opts:

apprise_role_docker_dns_search_domains

# Type: list
apprise_role_docker_dns_search_domains:

apprise_role_docker_dns_servers

# Type: list
apprise_role_docker_dns_servers:

apprise_role_docker_domainname

# Type: string
apprise_role_docker_domainname:

apprise_role_docker_exposed_ports

# Type: list
apprise_role_docker_exposed_ports:

apprise_role_docker_hosts

# Type: dict
apprise_role_docker_hosts:

apprise_role_docker_hosts_use_common

# Type: bool (true/false)
apprise_role_docker_hosts_use_common:

apprise_role_docker_ipc_mode

# Type: string
apprise_role_docker_ipc_mode:

apprise_role_docker_links

# Type: list
apprise_role_docker_links:

apprise_role_docker_network_mode

# Type: string
apprise_role_docker_network_mode:

apprise_role_docker_pid_mode

# Type: string
apprise_role_docker_pid_mode:

apprise_role_docker_ports

# Type: list
apprise_role_docker_ports:

apprise_role_docker_uts

# Type: string
apprise_role_docker_uts:

Storage

apprise_role_docker_keep_volumes

# Type: bool (true/false)
apprise_role_docker_keep_volumes:

apprise_role_docker_mounts

# Type: list
apprise_role_docker_mounts:

apprise_role_docker_storage_opts

# Type: dict
apprise_role_docker_storage_opts:

apprise_role_docker_tmpfs

# Type: list
apprise_role_docker_tmpfs:

apprise_role_docker_volume_driver

# Type: string
apprise_role_docker_volume_driver:

apprise_role_docker_volumes_from

# Type: list
apprise_role_docker_volumes_from:

apprise_role_docker_volumes_global

# Type: bool (true/false)
apprise_role_docker_volumes_global:

apprise_role_docker_working_dir

# Type: string
apprise_role_docker_working_dir:

Monitoring & Lifecycle

apprise_role_docker_auto_remove

# Type: bool (true/false)
apprise_role_docker_auto_remove:

apprise_role_docker_cleanup

# Type: bool (true/false)
apprise_role_docker_cleanup:

apprise_role_docker_force_kill

# Type: string
apprise_role_docker_force_kill:

apprise_role_docker_healthcheck

# Type: dict
apprise_role_docker_healthcheck:

apprise_role_docker_healthy_wait_timeout

# Type: int
apprise_role_docker_healthy_wait_timeout:

apprise_role_docker_init

# Type: bool (true/false)
apprise_role_docker_init:

apprise_role_docker_kill_signal

# Type: string
apprise_role_docker_kill_signal:

apprise_role_docker_log_driver

# Type: string
apprise_role_docker_log_driver:

apprise_role_docker_log_options

# Type: dict
apprise_role_docker_log_options:

apprise_role_docker_oom_killer

# Type: bool (true/false)
apprise_role_docker_oom_killer:

apprise_role_docker_oom_score_adj

# Type: int
apprise_role_docker_oom_score_adj:

apprise_role_docker_output_logs

# Type: bool (true/false)
apprise_role_docker_output_logs:

apprise_role_docker_paused

# Type: bool (true/false)
apprise_role_docker_paused:

apprise_role_docker_recreate

# Type: bool (true/false)
apprise_role_docker_recreate:

apprise_role_docker_restart_retries

# Type: int
apprise_role_docker_restart_retries:

apprise_role_docker_stop_timeout

# Type: int
apprise_role_docker_stop_timeout:

Other Options

apprise_role_docker_capabilities

# Type: list
apprise_role_docker_capabilities:

apprise_role_docker_cgroup_parent

# Type: string
apprise_role_docker_cgroup_parent:

apprise_role_docker_commands

# Type: list
apprise_role_docker_commands:

apprise_role_docker_create_timeout

# Type: int
apprise_role_docker_create_timeout:

apprise_role_docker_entrypoint

# Type: string
apprise_role_docker_entrypoint:

apprise_role_docker_env_file

# Type: string
apprise_role_docker_env_file:

apprise_role_docker_labels

# Type: dict
apprise_role_docker_labels:

apprise_role_docker_labels_use_common

# Type: bool (true/false)
apprise_role_docker_labels_use_common:

apprise_role_docker_read_only

# Type: bool (true/false)
apprise_role_docker_read_only:

apprise_role_docker_runtime

# Type: string
apprise_role_docker_runtime:

apprise_role_docker_sysctls

# Type: list
apprise_role_docker_sysctls:

apprise_role_docker_ulimits

# Type: list
apprise_role_docker_ulimits:

apprise_role_autoheal_enabled

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

apprise_role_depends_on

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

apprise_role_depends_on_delay

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

apprise_role_depends_on_healthchecks

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

apprise_role_diun_enabled

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

apprise_role_dns_enabled

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

apprise_role_docker_controller

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

apprise_role_docker_image_repo

# Type: string
apprise_role_docker_image_repo:

apprise_role_docker_image_tag

# Type: string
apprise_role_docker_image_tag:

apprise_role_docker_volumes_download

# Type: bool (true/false)
apprise_role_docker_volumes_download:

apprise_role_paths_location

# Type: string
apprise_role_paths_location:

apprise_role_themepark_addons

# Type: string
apprise_role_themepark_addons:

apprise_role_themepark_app

# Type: string
apprise_role_themepark_app:

apprise_role_themepark_theme

# Type: string
apprise_role_themepark_theme:

apprise_role_traefik_api_endpoint

# Type: dict/omit
apprise_role_traefik_api_endpoint:

apprise_role_traefik_api_middleware

# Type: string
apprise_role_traefik_api_middleware:

apprise_role_traefik_api_middleware_http

# Type: string
apprise_role_traefik_api_middleware_http:

apprise_role_traefik_autodetect_enabled

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

apprise_role_traefik_certresolver

# Type: string
apprise_role_traefik_certresolver:

apprise_role_traefik_crowdsec_enabled

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

apprise_role_traefik_error_pages_enabled

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

apprise_role_traefik_gzip_enabled

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

apprise_role_traefik_middleware_http

# Type: string
apprise_role_traefik_middleware_http:

apprise_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
apprise_role_traefik_middleware_http_api_insecure:

apprise_role_traefik_middleware_http_insecure

# Type: bool (true/false)
apprise_role_traefik_middleware_http_insecure:

apprise_role_traefik_priority

# Type: string
apprise_role_traefik_priority:

apprise_role_traefik_robot_enabled

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

apprise_role_traefik_tailscale_enabled

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

apprise_role_traefik_wildcard_enabled

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

apprise_role_web_domain

# Type: string
apprise_role_web_domain:

apprise_role_web_fqdn_override

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

Example Override

apprise_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "apprise2.{{ user.domain }}"
  - "apprise.otherdomain.tld"

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

apprise_role_web_host_override

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

Example Override

apprise_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'apprise2.' + user.domain }}`)"

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

apprise_role_web_http_port

# Type: string (quoted number)
apprise_role_web_http_port:

apprise_role_web_http_scheme

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

apprise_role_web_http_serverstransport

# Type: dict/omit
apprise_role_web_http_serverstransport:

apprise_role_web_scheme

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

apprise_role_web_serverstransport

# Type: dict/omit
apprise_role_web_serverstransport:

apprise_role_web_subdomain

# Type: string
apprise_role_web_subdomain: