Apprise

The apprise trigger lets you send container update notifications via the Apprise API.

logo

The apprise trigger lets you send container update notifications via the Apprise API.

Variables

Env var	Required	Description	Supported values
`DD_TRIGGER_APPRISE_{trigger_name}_URL`	🔴	The Base URL of the Apprise API
`DD_TRIGGER_APPRISE_{trigger_name}_URLS`	⚪	The comma separated list of Apprise service urls	See the list of the supported Apprise notification URLs
`DD_TRIGGER_APPRISE_{trigger_name}_CONFIG`	⚪	The name of an Apprise yaml configuration	See Apprise persistent configuration documentation
`DD_TRIGGER_APPRISE_{trigger_name}_TAG`	⚪	The optional tags(s) to expand when using an Apprise yaml configuration	See Apprise persistent configuration documentation

Either URLS or CONFIG must be set, but not both. These options are mutually exclusive.

This trigger also supports the common configuration variables.

Examples

Send a Mail & an SMS

services:
  drydock:
    image: codeswhat/drydock
    ...
    environment:
      - DD_TRIGGER_APPRISE_LOCAL_URL=http://apprise:8000
      - DD_TRIGGER_APPRISE_LOCAL_URLS=mailto://john.doe:secret@gmail.com,sns://AHIAJGNT76XIMXDBIJYA/bu1dHSdO22pfaaVy/wmNsdljF4C07D3bndi9PQJ9/us-east-2/+1(800)555-1223

Use a persistent YAML configuration

Declare a YAML Apprise configuration (see here) ; let's call it dd.yml for example.

# dd.yml example
urls:
  - tgram://{bot_token}/{chat_id}:
    - tag: devops

services:
  drydock:
    image: codeswhat/drydock
    ...
    environment:
      - DD_TRIGGER_APPRISE_LOCAL_URL=http://apprise:8000
      - DD_TRIGGER_APPRISE_LOCAL_CONFIG=drydock # the name of the yaml config file
      - DD_TRIGGER_APPRISE_LOCAL_TAG=devops # the tags to use with the config (optional)

How to run the Apprise API?

Just run the official Apprise Docker image.

For more information, check out the official Apprise API documentation.

services:
  apprise:
    image: caronc/apprise
    container_name: apprise