archive/crazy-max_diun
0
0
Fork 0
mirror of https://github.com/crazy-max/diun.git synced 2024-11-24 16:06:46 +00:00
Code Issues Projects Releases Wiki Activity
master
crazy-max_diun/docs/notif/matrix.md
CrazyMax f5ec2d535b
docs: Fix markdown tables syntax
2022-12-29 07:52:05 +01:00

2.3 KiB
Raw Permalink Blame History

Matrix notifications

Allow sending notifications to your Matrix server.

Configuration

!!! example "File" yaml 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
templateBody1 See below Notification template for message body

!!! abstract "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

[[ config.extra.template.notif.defaultBody ]]

Sample

  1. Value required ↩︎