Skip to content

Diun

Ntfy

Ntfy notifications¶

Notifications can be sent using a ntfy instance.

Configuration¶

File

    notif:
      ntfy:
        endpoint: https://ntfy.sh
        topic: diun-acce65a0-b777-46f9-9a11-58c67d1579c4
        priority: 3
        tags:
          - whale
        icon: https://raw.githubusercontent.com/crazy-max/diun/master/.res/diun.png
        click: "https://dock.example.com/compose/{{ .Entry.Metadata.stack }}"
        timeout: 10s
        templateTitle: "{{ .Entry.Image }} released"
        templateBody: |
          Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.

Name	Default	Description
`endpoint`¹	`https://ntfy.sh`	Ntfy base URL
`token`		Access token
`tokenFile`		Use content of secret file as acess token if `token` not defined
`topic`		Ntfy topic
`priority`	3	The priority of the message
`tags`	`["package"]`	Emoji to go in your notiication
`icon`	Diun logo	URL to use as notification icon
`click`		URL to open when the notification is clicked. Supports notification templates
`timeout`	`10s`	Timeout specifies a time limit for the request to be made
`proxy`		HTTP proxy URL to use for requests
`tlsSkipVerify`	`false`	Skip TLS certificate verification
`tlsCaCertFiles`		List of paths to custom CA certificate files to use for TLS verification
`templateTitle`¹	See below	Notification template for message title
`templateBody`¹	See below	Notification template for message body

Environment variables

DIUN_NOTIF_NTFY_ENDPOINT
DIUN_NOTIF_NTFY_TOKEN
DIUN_NOTIF_NTFY_TOKENFILE
DIUN_NOTIF_NTFY_TOPIC
DIUN_NOTIF_NTFY_PRIORITY
DIUN_NOTIF_NTFY_TAGS
DIUN_NOTIF_NTFY_ICON
DIUN_NOTIF_NTFY_CLICK
DIUN_NOTIF_NTFY_TIMEOUT
DIUN_NOTIF_NTFY_PROXY
DIUN_NOTIF_NTFY_TLSSKIPVERIFY
DIUN_NOTIF_NTFY_TLSCACERTFILES
DIUN_NOTIF_NTFY_TEMPLATETITLE
DIUN_NOTIF_NTFY_TEMPLATEBODY

Default `templateTitle`¶

{{ .Entry.Image }} {{ if (eq .Entry.Status "new") }}is available{{ else }}has been updated{{ end }}

Default `templateBody`¶

Docker tag {{ if .Entry.Image.HubLink }}[**{{ .Entry.Image }}**]({{ .Entry.Image.HubLink }}){{ else }}**{{ .Entry.Image }}**{{ end }} which you subscribed to through {{ .Entry.Provider }} provider {{ if (eq .Entry.Status "new") }}is available{{ else }}has been updated{{ end }} on {{ .Entry.Image.Domain }} registry (triggered by {{ .Meta.Hostname }} host).

Value required ↩↩↩