Skip to content

Matrix notifications

Allow sending notifications to your Matrix server.

Configuration

File

notif:
  matrix:
    homeserverURL: https://matrix.org
    user: "@foo:matrix.org"
    password: bar
    roomID: "!abcdefGHIjklmno:matrix.org"
    msgType: notice
    templateBody: |
      Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
Name Default Description
homeserverURL https://matrix.org Matrix server URL
user Username for authentication
userFile Use content of secret file as username authentication if username not defined
password Password for authentication
passwordFile Use content of secret file as password authentication if password not defined
roomID Room ID to send messages
msgType notice Type of message being sent. Can be notice or text
templateBody[^1] See below Notification template for message body

Environment variables

  • DIUN_NOTIF_MATRIX_HOMESERVERURL
  • DIUN_NOTIF_MATRIX_USER
  • DIUN_NOTIF_MATRIX_USERFILE
  • DIUN_NOTIF_MATRIX_PASSWORD
  • DIUN_NOTIF_MATRIX_PASSWORDFILE
  • DIUN_NOTIF_MATRIX_ROOMID
  • DIUN_NOTIF_MATRIX_MSGTYPE
  • DIUN_NOTIF_MATRIX_TEMPLATEBODY

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).

Sample


Last update: 2021-09-05 00:51:08
Created: 2020-07-29 19:29:13