mirror of
https://github.com/crazy-max/diun.git
synced 2025-12-24 14:31:47 +01:00
44 lines
2.0 KiB
Markdown
44 lines
2.0 KiB
Markdown
# Slack notifications
|
|
|
|
You can send notifications to your Slack channel using an [incoming webhook URL](https://api.slack.com/messaging/webhooks).
|
|
|
|
!!! hint
|
|
Mattermost webhooks are compatible with Slack notification without any special configuration (if Webhooks are enabled).
|
|
|
|
## Configuration
|
|
|
|
!!! example "File"
|
|
```yaml
|
|
notif:
|
|
slack:
|
|
webhookURL: https://hooks.slack.com/services/ABCD12EFG/HIJK34LMN/01234567890abcdefghij
|
|
renderFields: true
|
|
templateBody: |
|
|
Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
|
|
```
|
|
|
|
| Name | Default | Description |
|
|
|--------------------|------------------------------------|-------------------------------------------------------------------------------------------|
|
|
| `webhookURL` | | Slack [incoming webhook URL](https://api.slack.com/messaging/webhooks) |
|
|
| `webhookURLFile` | | Use content of secret file as webhook URL if `webhookURL` is not defined |
|
|
| `renderFields` | `true` | Render [field objects](https://api.slack.com/messaging/composing/layouts#stack_of_blocks) |
|
|
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
|
|
|
|
!!! abstract "Environment variables"
|
|
* `DIUN_NOTIF_SLACK_WEBHOOKURL`
|
|
* `DIUN_NOTIF_SLACK_WEBHOOKURLFILE`
|
|
* `DIUN_NOTIF_SLACK_RENDERFIELDS`
|
|
* `DIUN_NOTIF_SLACK_TEMPLATEBODY`
|
|
|
|
### Default `templateBody`
|
|
|
|
```
|
|
<!channel> Docker tag {{ if .Entry.Image.HubLink }}<{{ .Entry.Image.HubLink }}|`{{ .Entry.Image }}`>{{ else }}`{{ .Entry.Image }}`{{ end }} {{ if (eq .Entry.Status "new") }}available{{ else }}updated{{ end }}.
|
|
```
|
|
|
|
## Sample
|
|
|
|
|
|
|
|
[^1]: Value required
|