mirrors/diun
1
0
Fork 0
mirror of https://github.com/crazy-max/diun.git synced 2026-01-04 03:55:00 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1581 from crazy-max/secrets-docs

Browse Source 
docs: secrets loaded from files and trailing newlines
This commit is contained in:
CrazyMax
2025-12-23 13:38:15 +01:00
committed by GitHub
parent ef44f2b996 0d022bc65b
commit faa4353ce4
15 changed files with 169 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/faq.md
View File

@@ -383,3 +383,29 @@ You can still pin an image to a specific digest and analyze the image if the
tag is specified using the `image:tag@digest` format. Taking the previous
example if we specify `crazymax/diun:4.24.0@sha256:fa80af32a7c61128ffda667344547805b3c5e7721ecbbafd70e35bb7bb7c989f`,
then `crazymax/diun:4.24.0` will be analyzed.
## Secrets loaded from files and trailing newlines
When Diun reads a secret from a file (e.g. Docker or Kubernetes secrets), the
file content is used exactly as-is, including any trailing newline characters.
This is intentional.
A secret file is treated as an opaque value, not as a line of text.
Automatically trimming or normalizing file content would silently modify the
secret and could cause authentication or integration issues. Diun therefore
does not attempt to guess whether a trailing newline was added intentionally or
by tooling.
This behavior aligns with common secret-management systems (such as Kubernetes
and Vault), which model secrets as arbitrary data rather than text strings.
If a trailing newline is not desired, ensure the file is created without one,
for example:
```shell
printf '%s' 'mysecret' > secret.txt
```
Any future trimming or text-normalization behavior would be introduced
explicitly and opt-in.

20
docs/notif/amqp.md
View File

@@ -15,16 +15,16 @@ You can send notifications to any amqp compatible server with the following sett
queue: queue
```
| Name | Default | Description |
|----------------|-------------|-----------------------------------------------------------------------|
| `host`[^1] | `localhost` | AMQP server host |
| `port`[^1] | `5672` | AMQP server port |
| `username` | | AMQP username |
| `usernameFile` | | Use content of secret file as AMQP username if `username` not defined |
| `password` | | AMQP password |
| `passwordFile` | | Use content of secret file as AMQP password if `password` not defined |
| `exchange` | | Name of the exchange the message will be sent to |
| `queue`[^1] | | Name of the queue the message will be sent to |
| Name | Default | Description |
|----------------|-------------|------------------------------------------------------------------------------------------------------------------------------------|
| `host`[^1] | `localhost` | AMQP server host |
| `port`[^1] | `5672` | AMQP server port |
| `username` | | AMQP username |
| `usernameFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as AMQP username if `username` not defined |
| `password` | | AMQP password |
| `passwordFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as AMQP password if `password` not defined |
| `exchange` | | Name of the exchange the message will be sent to |
| `queue`[^1] | | Name of the queue the message will be sent to |
!!! abstract "Environment variables"
* `DIUN_NOTIF_AMQP_HOST`

24
docs/notif/apprise.md
View File

@@ -18,18 +18,18 @@ Notifications can be sent using an apprise api instance.
Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
```
| Name | Default | Description |
|------------------|-------------------------------------|----------------------------------------------------------------------------|
| `endpoint`[^1] | | Hostname and port of your apprise api instance |
| `token`[^2] | | token representing your config file (Config Key) |
| `tokenFile` | | Use content of secret file as application token if `token` not defined |
| `tags` | | List of Tags in your config file you want to notify |
| `urls`[^2] | | List of [URLs](https://github.com/caronc/apprise/wiki/URLBasics) to notify |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
| `tlsSkipVerify` | `false` | Skip TLS certificate verification |
| `tlsCaCertFiles` | | List of paths to custom CA certificate files to use for TLS verification |
| `templateTitle` | See [below](#default-templatetitle) | [Notification template](../faq.md#notification-template) for message title |
| `templateBody` | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
| Name | Default | Description |
|------------------|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| `endpoint`[^1] | | Hostname and port of your apprise api instance |
| `token`[^2] | | token representing your config file (Config Key) |
| `tokenFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as application token if `token` not defined |
| `tags` | | List of Tags in your config file you want to notify |
| `urls`[^2] | | List of [URLs](https://github.com/caronc/apprise/wiki/URLBasics) to notify |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
| `tlsSkipVerify` | `false` | Skip TLS certificate verification |
| `tlsCaCertFiles` | | List of paths to custom CA certificate files to use for TLS verification |
| `templateTitle` | See [below](#default-templatetitle) | [Notification template](../faq.md#notification-template) for message title |
| `templateBody` | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables"
* `DIUN_NOTIF_APPRISE_ENDPOINT`

18
docs/notif/discord.md
View File

@@ -22,15 +22,15 @@ Allow sending notifications to your Discord channel.
Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
```
| Name | Default | Description |
|--------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------|
| `webhookURL` | | Discord [incoming webhook URL](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) |
| `webhookURLFile` | | Use content of secret file as webhook URL if `webhookURL` is not defined |
| `mentions` | | List of users or roles to notify |
| `renderEmbeds` | `true` | Render [message embeds](https://discordjs.guide/legacy/popular-topics/embeds) |
| `renderFields` | `true` | Render [field objects](https://discordjs.guide/legacy/popular-topics/embeds) in message embeds |
| `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 |
| Name | Default | Description |
|--------------------|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| `webhookURL` | | Discord [incoming webhook URL](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) |
| `webhookURLFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as webhook URL if `webhookURL` is not defined |
| `mentions` | | List of users or roles to notify |
| `renderEmbeds` | `true` | Render [message embeds](https://discordjs.guide/legacy/popular-topics/embeds) |
| `renderFields` | `true` | Render [field objects](https://discordjs.guide/legacy/popular-topics/embeds) in message embeds |
| `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`

24
docs/notif/elasticsearch.md
View File

@@ -16,18 +16,18 @@ Send notifications to your Elasticsearch cluster as structured documents.
timeout: 10s
```
| Name | Default | Description |
|------------------|-------------------------|--------------------------------------------------------------------------|
| `address`[^1] | `http://localhost:9200` | Elasticsearch base URL |
| `username` | | Elasticsearch username for authentication |
| `usernameFile` | | Use content of secret file as username if `username` is not defined |
| `password` | | Elasticsearch password for authentication |
| `passwordFile` | | Use content of secret file as password if `password` is not defined |
| `client`[^1] | `diun` | Client name to identify the source of notifications |
| `index`[^1] | `diun-notifications` | Elasticsearch index name where notifications will be stored |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
| `tlsSkipVerify` | `false` | Skip TLS certificate verification |
| `tlsCaCertFiles` | | List of paths to custom CA certificate files to use for TLS verification |
| Name | Default | Description |
|------------------|-------------------------|----------------------------------------------------------------------------------------------------------------------------------|
| `address`[^1] | `http://localhost:9200` | Elasticsearch base URL |
| `username` | | Elasticsearch username for authentication |
| `usernameFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as username if `username` is not defined |
| `password` | | Elasticsearch password for authentication |
| `passwordFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as password if `password` is not defined |
| `client`[^1] | `diun` | Client name to identify the source of notifications |
| `index`[^1] | `diun-notifications` | Elasticsearch index name where notifications will be stored |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
| `tlsSkipVerify` | `false` | Skip TLS certificate verification |
| `tlsCaCertFiles` | | List of paths to custom CA certificate files to use for TLS verification |
!!! abstract "Environment variables"
* `DIUN_NOTIF_ELASTICSEARCH_ADDRESS`

22
docs/notif/gotify.md
View File

@@ -17,17 +17,17 @@ Notifications can be sent using a [Gotify](https://gotify.net/) instance.
Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
```
| Name | Default | Description |
|---------------------|-------------------------------------|----------------------------------------------------------------------------|
| `endpoint`[^1] | | Gotify base URL |
| `token` | | Application token |
| `tokenFile` | | Use content of secret file as application token if `token` not defined |
| `priority` | `1` | The priority of the message |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
| `tlsSkipVerify` | `false` | Skip TLS certificate verification |
| `tlsCaCertFiles` | | List of paths to custom CA certificate files to use for TLS verification |
| `templateTitle`[^1] | See [below](#default-templatetitle) | [Notification template](../faq.md#notification-template) for message title |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
| Name | Default | Description |
|---------------------|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| `endpoint`[^1] | | Gotify base URL |
| `token` | | Application token |
| `tokenFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as application token if `token` not defined |
| `priority` | `1` | The priority of the message |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
| `tlsSkipVerify` | `false` | Skip TLS certificate verification |
| `tlsCaCertFiles` | | List of paths to custom CA certificate files to use for TLS verification |
| `templateTitle`[^1] | See [below](#default-templatetitle) | [Notification template](../faq.md#notification-template) for message title |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables"
* `DIUN_NOTIF_GOTIFY_ENDPOINT`

30
docs/notif/mail.md
View File

@@ -21,21 +21,21 @@ Notifications can be sent through SMTP.
Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
```
| Name | Default | Description |
|----------------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| `host`[^1] | `localhost` | SMTP server host |
| `port`[^1] | `25` | SMTP server port |
| `ssl` | `false` | SSL defines whether an SSL connection is used. Should be false in most cases since the auth mechanism should use STARTTLS |
| `insecureSkipVerify` | `false` | Controls whether a client verifies the server's certificate chain and hostname |
| `localName` | `localhost` | Hostname sent to the SMTP server with the HELO command |
| `username` | | SMTP username |
| `usernameFile` | | Use content of secret file as SMTP username if `username` not defined |
| `password` | | SMTP password |
| `passwordFile` | | Use content of secret file as SMTP password if `password` not defined |
| `from`[^1] | | Sender email address |
| `to`[^1] | | List of recipients email addresses |
| `templateTitle`[^1] | See [below](#default-templatetitle) | [Notification template](../faq.md#notification-template) for message title |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
| Name | Default | Description |
|----------------------|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| `host`[^1] | `localhost` | SMTP server host |
| `port`[^1] | `25` | SMTP server port |
| `ssl` | `false` | SSL defines whether an SSL connection is used. Should be false in most cases since the auth mechanism should use STARTTLS |
| `insecureSkipVerify` | `false` | Controls whether a client verifies the server's certificate chain and hostname |
| `localName` | `localhost` | Hostname sent to the SMTP server with the HELO command |
| `username` | | SMTP username |
| `usernameFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as SMTP username if `username` not defined |
| `password` | | SMTP password |
| `passwordFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as SMTP password if `password` not defined |
| `from`[^1] | | Sender email address |
| `to`[^1] | | List of recipients email addresses |
| `templateTitle`[^1] | See [below](#default-templatetitle) | [Notification template](../faq.md#notification-template) for message title |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables"
* `DIUN_NOTIF_MAIL_HOST`

20
docs/notif/matrix.md
View File

@@ -17,16 +17,16 @@ Allow sending notifications to your Matrix server.
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](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
| Name | Default | Description |
|--------------------|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
| `homeserverURL` | `https://matrix.org` | Matrix server URL |
| `user` | | Username for authentication |
| `userFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as username authentication if `username` not defined |
| `password` | | Password for authentication |
| `passwordFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) 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](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables"
* `DIUN_NOTIF_MATRIX_HOMESERVERURL`

24
docs/notif/mqtt.md
View File

@@ -18,18 +18,18 @@ You can send notifications to any MQTT compatible server with the following sett
qos: 0
```
| Name | Default | Description |
|----------------|-------------|------------------------------------------------------------------------|
| `scheme`[^1] | `mqtt` | MQTT server scheme (`mqtt`, `mqtts`, `ws` or `wss`) |
| `host`[^1] | `localhost` | MQTT server host |
| `port`[^1] | `1883` | MQTT server port |
| `username` | | MQTT username |
| `usernameFile` | | Use content of secret file as MQTT username if `username` not defined |
| `password` | | MQTT password |
| `passwordFile` | | Use content of secret file as MQTT password if `password` not defined |
| `client`[^1] | | Client id to be used by this client when connecting to the MQTT broker |
| `topic`[^1] | | Topic the message will be sent to |
| `qos` | `0` | Ensured message delivery at specified Quality of Service (QoS) |
| Name | Default | Description |
|----------------|-------------|------------------------------------------------------------------------------------------------------------------------------------|
| `scheme`[^1] | `mqtt` | MQTT server scheme (`mqtt`, `mqtts`, `ws` or `wss`) |
| `host`[^1] | `localhost` | MQTT server host |
| `port`[^1] | `1883` | MQTT server port |
| `username` | | MQTT username |
| `usernameFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as MQTT username if `username` not defined |
| `password` | | MQTT password |
| `passwordFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as MQTT password if `password` not defined |
| `client`[^1] | | Client id to be used by this client when connecting to the MQTT broker |
| `topic`[^1] | | Topic the message will be sent to |
| `qos` | `0` | Ensured message delivery at specified Quality of Service (QoS) |
!!! abstract "Environment variables"
* `DIUN_NOTIF_MQTT_SCHEME`

26
docs/notif/ntfy.md
View File

@@ -19,19 +19,19 @@ Notifications can be sent using a [ntfy](https://ntfy.sh/) instance.
Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
```
| Name | Default | Description |
|---------------------|-------------------------------------|----------------------------------------------------------------------------|
| `endpoint`[^1] | `https://ntfy.sh` | Ntfy base URL |
| `token` | | [Access token](https://docs.ntfy.sh/publish/#access-tokens) |
| `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 |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
| `tlsSkipVerify` | `false` | Skip TLS certificate verification |
| `tlsCaCertFiles` | | List of paths to custom CA certificate files to use for TLS verification |
| `templateTitle`[^1] | See [below](#default-templatetitle) | [Notification template](../faq.md#notification-template) for message title |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
| Name | Default | Description |
|---------------------|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
| `endpoint`[^1] | `https://ntfy.sh` | Ntfy base URL |
| `token` | | [Access token](https://docs.ntfy.sh/publish/#access-tokens) |
| `tokenFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) 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 |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
| `tlsSkipVerify` | `false` | Skip TLS certificate verification |
| `tlsCaCertFiles` | | List of paths to custom CA certificate files to use for TLS verification |
| `templateTitle`[^1] | See [below](#default-templatetitle) | [Notification template](../faq.md#notification-template) for message title |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables"
* `DIUN_NOTIF_NTFY_ENDPOINT`

22
docs/notif/pushover.md
View File

@@ -18,17 +18,17 @@ You can send notifications using [Pushover](https://pushover.net/).
Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
```
| Name | Default | Description |
|---------------------|-------------------------------------|-------------------------------------------------------------------------------------|
| `token` | | Pushover [application/API token](https://pushover.net/api#registration) |
| `tokenFile` | | Use content of secret file as Pushover application/API token if `token` not defined |
| `recipient` | | User key to send notification to |
| `recipientFile` | | Use content of secret file as User key if `recipient` not defined |
| `priority` | | Priority of the notification |
| `sound` | | Notification sound to be used |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
| `templateTitle`[^1] | See [below](#default-templatetitle) | [Notification template](../faq.md#notification-template) for message title |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
| Name | Default | Description |
|---------------------|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| `token` | | Pushover [application/API token](https://pushover.net/api#registration) |
| `tokenFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as Pushover application/API token if `token` not defined |
| `recipient` | | User key to send notification to |
| `recipientFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as User key if `recipient` not defined |
| `priority` | | Priority of the notification |
| `sound` | | Notification sound to be used |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
| `templateTitle`[^1] | See [below](#default-templatetitle) | [Notification template](../faq.md#notification-template) for message title |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables"
* `DIUN_NOTIF_PUSHOVER_TOKEN`

26
docs/notif/rocketchat.md
View File

@@ -19,19 +19,19 @@ Allow sending notifications to your Rocket.Chat channel.
Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
```
| Name | Default | Description |
|---------------------|-------------------------------------|----------------------------------------------------------------------------------------------------|
| `endpoint`[^1] | | Rocket.Chat base URL |
| `channel`[^1] | | Channel name with the prefix in front of it |
| `userID`[^1] | | User ID |
| `token` | | Authentication token |
| `tokenFile` | | Use content of secret file as authentication token if `token` not defined |
| `renderAttachment` | `true` | Render [attachment object](https://docs.rocket.chat/guides/user-guides/messaging#send-attachments) |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
| `tlsSkipVerify` | `false` | Skip TLS certificate verification |
| `tlsCaCertFiles` | | List of paths to custom CA certificate files to use for TLS verification |
| `templateTitle`[^1] | See [below](#default-templatetitle) | [Notification template](../faq.md#notification-template) for message title |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
| Name | Default | Description |
|---------------------|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
| `endpoint`[^1] | | Rocket.Chat base URL |
| `channel`[^1] | | Channel name with the prefix in front of it |
| `userID`[^1] | | User ID |
| `token` | | Authentication token |
| `tokenFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as authentication token if `token` not defined |
| `renderAttachment` | `true` | Render [attachment object](https://docs.rocket.chat/guides/user-guides/messaging#send-attachments) |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
| `tlsSkipVerify` | `false` | Skip TLS certificate verification |
| `tlsCaCertFiles` | | List of paths to custom CA certificate files to use for TLS verification |
| `templateTitle`[^1] | See [below](#default-templatetitle) | [Notification template](../faq.md#notification-template) for message title |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! warning
You must first create a _Personal Access Token_ through your account settings on your Rocket.Chat instance.

12
docs/notif/slack.md
View File

@@ -17,12 +17,12 @@ You can send notifications to your Slack channel using an [incoming webhook URL]
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 |
| Name | Default | Description |
|--------------------|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| `webhookURL` | | Slack [incoming webhook URL](https://api.slack.com/messaging/webhooks) |
| `webhookURLFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) 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`

2
docs/notif/teams.md
View File

@@ -17,7 +17,7 @@ You can send notifications to your Teams team-channel using an [incoming webhook
| Name | Default | Description |
|--------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| `webhookURL` | | Teams [incoming webhook URL](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/what-are-webhooks-and-connectors) |
| `webhookURLFile` | | Use content of secret file as webhook URL if `webhookURL` is not defined |
| `webhookURLFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as webhook URL if `webhookURL` is not defined |
| `renderFacts` | `true` | Render fact objects |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
| `tlsSkipVerify` | `false` | Skip TLS certificate verification |

16
docs/notif/telegram.md
View File

@@ -23,14 +23,14 @@ Multiple chat IDs can be provided in order to deliver notifications to multiple
Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
```
| Name | Default | Description |
|-----------------------|------------------------------------|---------------------------------------------------------------------------|
| `token` | | Telegram bot token |
| `tokenFile` | | Use content of secret file as Telegram bot token if `token` not defined |
| `chatIDs` | | List of [chat IDs](#chatids-format) to send notifications to |
| `chatIDsFile` | | Use content of secret file as chat IDs if `chatIDs` not defined |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
| `disableNotification` | `false` | Send silent message with no sound |
| Name | Default | Description |
|-----------------------|------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| `token` | | Telegram bot token |
| `tokenFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as Telegram bot token if `token` not defined |
| `chatIDs` | | List of [chat IDs](#chatids-format) to send notifications to |
| `chatIDsFile` | | Use content of [secret file](../faq.md#secrets-loaded-from-files-and-trailing-newlines) as chat IDs if `chatIDs` not defined |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
| `disableNotification` | `false` | Send silent message with no sound |
!!! abstract "Environment variables"
* `DIUN_NOTIF_TELEGRAM_TOKEN`