mirror of
https://github.com/crazy-max/diun.git
synced 2024-11-24 16:06:46 +00:00
52 lines
2.1 KiB
Markdown
52 lines
2.1 KiB
Markdown
# Discord notifications
|
|
|
|
Allow sending notifications to your Discord channel.
|
|
|
|
## Configuration
|
|
|
|
!!! example "File"
|
|
```yaml
|
|
notif:
|
|
discord:
|
|
webhookURL: https://discordapp.com/api/webhooks/1234567890/Abcd-eFgh-iJklmNo_pqr
|
|
mentions:
|
|
- "@here"
|
|
- "@everyone"
|
|
- "<@124>"
|
|
- "<@125>"
|
|
- "<@&200>"
|
|
renderFields: true
|
|
timeout: 10s
|
|
templateBody: |
|
|
Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
|
|
```
|
|
|
|
| Name | Default | Description |
|
|
|--------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------|
|
|
| `webhookURL`[^1] | | Discord [incoming webhook URL](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) |
|
|
| `mentions` | | List of users or roles to notify |
|
|
| `renderFields` | `true` | Render [field objects](https://discordjs.guide/popular-topics/embeds.html) |
|
|
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
|
|
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
|
|
|
|
!!! abstract "Environment variables"
|
|
* `DIUN_NOTIF_DISCORD_WEBHOOKURL`
|
|
* `DIUN_NOTIF_DISCORD_MENTIONS` (comma separated)
|
|
* `DIUN_NOTIF_DISCORD_RENDERFIELDS`
|
|
* `DIUN_NOTIF_DISCORD_TIMEOUT`
|
|
* `DIUN_NOTIF_DISCORD_TEMPLATEBODY`
|
|
|
|
### Default `templateBody`
|
|
|
|
```
|
|
[[ config.extra.template.notif.defaultBody ]]
|
|
```
|
|
|
|
## Sample
|
|
|
|
|
|
|
|
|
|
|
|
[^1]: Value required
|