archive/crazy-max_diun
0
0
Fork 0
mirror of https://github.com/crazy-max/diun.git synced 2025-04-28 20:52:25 +00:00
Code Issues Projects Releases Wiki Activity

docs: Fix markdown tables syntax

Browse source
This commit is contained in:
CrazyMax 2022-12-29 07:52:05 +01:00
parent d7909f0156
commit f5ec2d535b
No known key found for this signature in database
GPG key ID: 3248E46B6BB8C7F7
21 changed files with 194 additions and 194 deletions

14
docs/install/docker.md
View file

@ -4,10 +4,10 @@
Diun provides automatically updated Docker :whale: images within several registries: Diun provides automatically updated Docker :whale: images within several registries:
| Registry | Image | | Registry | Image |
|--------------------------------------------------------------------------------------------------|---------------------------------| |-------------------------------------------------------------------------------------------------|--------------------------|
| [Docker Hub](https://hub.docker.com/r/crazymax/diun/) | `crazymax/diun` | | [Docker Hub](https://hub.docker.com/r/crazymax/diun/) | `crazymax/diun` |
| [GitHub Container Registry](https://github.com/users/crazy-max/packages/container/package/diun) | `ghcr.io/crazy-max/diun` | | [GitHub Container Registry](https://github.com/users/crazy-max/packages/container/package/diun) | `ghcr.io/crazy-max/diun` |
It is possible to always use the latest stable tag or to use another service that handles updating Docker images. It is possible to always use the latest stable tag or to use another service that handles updating Docker images.
@ -28,9 +28,9 @@ Image: crazymax/diun:latest
## Volumes ## Volumes
| Path | Description | | Path | Description |
|--------------------|---------------| |---------|---------------------------------------------------------------|
| `/data` | Contains bbolt database which retains Docker images manifests | | `/data` | Contains bbolt database which retains Docker images manifests |
## Usage ## Usage

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 queue: queue
``` ```
| Name | Default | Description | | Name | Default | Description |
|--------------------|---------------|---------------| |----------------|-------------|-----------------------------------------------------------------------|
| `host`[^1] | `localhost` | AMQP server host | | `host`[^1] | `localhost` | AMQP server host |
| `port`[^1] | `5672` | AMQP server port | | `port`[^1] | `5672` | AMQP server port |
| `username` | | AMQP username | | `username` | | AMQP username |
| `usernameFile` | | Use content of secret file as AMQP username if `username` not defined | | `usernameFile` | | Use content of secret file as AMQP username if `username` not defined |
| `password` | | AMQP password | | `password` | | AMQP password |
| `passwordFile` | | Use content of secret file as AMQP password if `password` not defined | | `passwordFile` | | Use content of secret file as AMQP password if `password` not defined |
| `exchange` | | Name of the exchange the message will be sent to | | `exchange` | | Name of the exchange the message will be sent to |
| `queue`[^1] | | Name of the queue the message will be sent to | | `queue`[^1] | | Name of the queue the message will be sent to |
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_AMQP_HOST` * `DIUN_NOTIF_AMQP_HOST`

14
docs/notif/discord.md
View file

@ -21,13 +21,13 @@ Allow sending notifications to your Discord channel.
Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released. Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
``` ```
| Name | Default | Description | | Name | Default | Description |
|---------------------|---------------------------------------|---------------| |--------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------|
| `webhookURL`[^1] | | Discord [incoming webhook URL](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) | | `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 | | `mentions` | | List of users or roles to notify |
| `renderFields` | `true` | Render [field objects](https://discordjs.guide/popular-topics/embeds.html) | | `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 | | `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 | | `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_DISCORD_WEBHOOKURL` * `DIUN_NOTIF_DISCORD_WEBHOOKURL`

18
docs/notif/gotify.md
View file

@ -17,15 +17,15 @@ 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. Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
``` ```
| Name | Default | Description | | Name | Default | Description |
|---------------------|---------------------------------------|---------------| |---------------------|-------------------------------------|----------------------------------------------------------------------------|
| `endpoint`[^1] | | Gotify base URL | | `endpoint`[^1] | | Gotify base URL |
| `token` | | Application token | | `token` | | Application token |
| `tokenFile` | | Use content of secret file as application token if `token` not defined | | `tokenFile` | | Use content of secret file as application token if `token` not defined |
| `priority` | `1` | The priority of the message | | `priority` | `1` | The priority of the message |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made | | `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 | | `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 | | `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_GOTIFY_ENDPOINT` * `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. Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
``` ```
| Name | Default | Description | | Name | Default | Description |
|-----------------------|--------------------------------------------|---------------| |----------------------|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| `host`[^1] | `localhost` | SMTP server host | | `host`[^1] | `localhost` | SMTP server host |
| `port`[^1] | `25` | SMTP server port | | `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 | | `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 | | `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 | | `localName` | `localhost` | Hostname sent to the SMTP server with the HELO command |
| `username` | | SMTP username | | `username` | | SMTP username |
| `usernameFile` | | Use content of secret file as SMTP username if `username` not defined | | `usernameFile` | | Use content of secret file as SMTP username if `username` not defined |
| `password` | | SMTP password | | `password` | | SMTP password |
| `passwordFile` | | Use content of secret file as SMTP password if `password` not defined | | `passwordFile` | | Use content of secret file as SMTP password if `password` not defined |
| `from`[^1] | | Sender email address | | `from`[^1] | | Sender email address |
| `to`[^1] | | List of recipients email addresses | | `to`[^1] | | List of recipients email addresses |
| `templateTitle`[^1] | See [below](#default-templatetitle) | [Notification template](../faq.md#notification-template) for message title | | `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 | | `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_MAIL_HOST` * `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. Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
``` ```
| Name | Default | Description | | Name | Default | Description |
|-----------------------|--------------------------------------------|-------------------| |--------------------|------------------------------------|---------------------------------------------------------------------------------|
| `homeserverURL` | `https://matrix.org` | Matrix server URL | | `homeserverURL` | `https://matrix.org` | Matrix server URL |
| `user` | | Username for authentication | | `user` | | Username for authentication |
| `userFile` | | Use content of secret file as username authentication if `username` not defined | | `userFile` | | Use content of secret file as username authentication if `username` not defined |
| `password` | | Password for authentication | | `password` | | Password for authentication |
| `passwordFile` | | Use content of secret file as password authentication if `password` not defined | | `passwordFile` | | Use content of secret file as password authentication if `password` not defined |
| `roomID` | | Room ID to send messages | | `roomID` | | Room ID to send messages |
| `msgType` | `notice` | Type of message being sent. Can be `notice` or `text` | | `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 | | `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_MATRIX_HOMESERVERURL` * `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 qos: 0
``` ```
| Name | Default | Description | | Name | Default | Description |
|--------------------|---------------|---------------| |----------------|-------------|------------------------------------------------------------------------|
| `scheme`[^1] | `mqtt` | MQTT server scheme (`mqtt`, `mqtts`, `ws` or `wss`) | | `scheme`[^1] | `mqtt` | MQTT server scheme (`mqtt`, `mqtts`, `ws` or `wss`) |
| `host`[^1] | `localhost` | MQTT server host | | `host`[^1] | `localhost` | MQTT server host |
| `port`[^1] | `1883` | MQTT server port | | `port`[^1] | `1883` | MQTT server port |
| `username` | | MQTT username | | `username` | | MQTT username |
| `usernameFile` | | Use content of secret file as MQTT username if `username` not defined | | `usernameFile` | | Use content of secret file as MQTT username if `username` not defined |
| `password` | | MQTT password | | `password` | | MQTT password |
| `passwordFile` | | Use content of secret file as MQTT password if `password` not defined | | `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 | | `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 | | `topic`[^1] | | Topic the message will be sent to |
| `qos` | `0` | Ensured message delivery at specified Quality of Service (QoS) | | `qos` | `0` | Ensured message delivery at specified Quality of Service (QoS) |
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_MQTT_SCHEME` * `DIUN_NOTIF_MQTT_SCHEME`

16
docs/notif/pushover.md
View file

@ -15,14 +15,14 @@ You can send notifications using [Pushover](https://pushover.net/).
Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released. Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
``` ```
| Name | Default | Description | | Name | Default | Description |
|---------------------|--------------------------------------------|---------------| |---------------------|-------------------------------------|-------------------------------------------------------------------------------------|
| `token` | | Pushover [application/API token](https://pushover.net/api#registration) | | `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 | | `tokenFile` | | Use content of secret file as Pushover application/API token if `token` not defined |
| `recipient` | | User key to send notification to | | `recipient` | | User key to send notification to |
| `recipientFile` | | Use content of secret file as User key if `recipient` not defined | | `recipientFile` | | Use content of secret file as User key if `recipient` not defined |
| `templateTitle`[^1] | See [below](#default-templatetitle) | [Notification template](../faq.md#notification-template) for message title | | `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 | | `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_PUSHOVER_TOKEN` * `DIUN_NOTIF_PUSHOVER_TOKEN`

22
docs/notif/rocketchat.md
View file

@ -19,17 +19,17 @@ Allow sending notifications to your Rocket.Chat channel.
Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released. Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
``` ```
| Name | Default | Description | | Name | Default | Description |
|---------------------|--------------------------------------------|---------------| |---------------------|-------------------------------------|----------------------------------------------------------------------------------------------------|
| `endpoint`[^1] | | Rocket.Chat base URL | | `endpoint`[^1] | | Rocket.Chat base URL |
| `channel`[^1] | | Channel name with the prefix in front of it | | `channel`[^1] | | Channel name with the prefix in front of it |
| `userID`[^1] | | User ID | | `userID`[^1] | | User ID |
| `token` | | Authentication token | | `token` | | Authentication token |
| `tokenFile` | | Use content of secret file as authentication token if `token` not defined | | `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) | | `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 | | `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 | | `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 | | `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! warning !!! warning
You must first create a _Personal Access Token_ through your account settings on your Rocket.Chat instance. You must first create a _Personal Access Token_ through your account settings on your Rocket.Chat instance.

10
docs/notif/script.md
View file

@ -27,11 +27,11 @@ DIUN_ENTRY_PLATFORM=linux/amd64
- "another" - "another"
``` ```
| Name | Default | Description | | Name | Default | Description |
|-----------------------|---------------|---------------| |-----------|---------|------------------------------------------------|
| `cmd`[^1] | | Command or script to execute | | `cmd`[^1] | | Command or script to execute |
| `args` | | List of args to pass to `cmd` | | `args` | | List of args to pass to `cmd` |
| `dir` | | Specifies the working directory of the command | | `dir` | | Specifies the working directory of the command |
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_SCRIPT_CMD` * `DIUN_NOTIF_SCRIPT_CMD`

10
docs/notif/slack.md
View file

@ -17,11 +17,11 @@ 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. Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
``` ```
| Name | Default | Description | | Name | Default | Description |
|--------------------|--------------------------------------------|---------------| |--------------------|------------------------------------|-------------------------------------------------------------------------------------------|
| `webhookURL`[^1] | | Slack [incoming webhook URL](https://api.slack.com/messaging/webhooks) | | `webhookURL`[^1] | | Slack [incoming webhook URL](https://api.slack.com/messaging/webhooks) |
| `renderFields` | `true` | Render [field objects](https://api.slack.com/messaging/composing/layouts#stack_of_blocks) | | `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 | | `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_SLACK_WEBHOOKURL` * `DIUN_NOTIF_SLACK_WEBHOOKURL`

10
docs/notif/teams.md
View file

@ -14,11 +14,11 @@ You can send notifications to your Teams team-channel using an [incoming webhook
Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released. Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
``` ```
| Name | Default | Description | | Name | Default | Description |
|--------------------|--------------------------------------------|---------------| |--------------------|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| `webhookURL`[^1] | | Teams [incoming webhook URL](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/what-are-webhooks-and-connectors) | | `webhookURL`[^1] | | Teams [incoming webhook URL](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/what-are-webhooks-and-connectors) |
| `renderFacts` | `true` | Render fact objects | | `renderFacts` | `true` | Render fact objects |
| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body | | `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_TEAMS_WEBHOOKURL` * `DIUN_NOTIF_TEAMS_WEBHOOKURL`

14
docs/notif/telegram.md
View file

@ -21,13 +21,13 @@ 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. Docker tag {{ .Entry.Image }} which you subscribed to through {{ .Entry.Provider }} provider has been released.
``` ```
| Name | Default | Description | | Name | Default | Description |
|--------------------|--------------------------------------------|---------------| |--------------------|------------------------------------|---------------------------------------------------------------------------|
| `token` | | Telegram bot token | | `token` | | Telegram bot token |
| `tokenFile` | | Use content of secret file as Telegram bot token if `token` not defined | | `tokenFile` | | Use content of secret file as Telegram bot token if `token` not defined |
| `chatIDs` | | List of chat IDs to send notifications to | | `chatIDs` | | List of chat IDs to send notifications to |
| `chatIDsFile` | | Use content of secret file as chat IDs if `chatIDs` not defined | | `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 | | `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body |
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_TELEGRAM_TOKEN` * `DIUN_NOTIF_TELEGRAM_TOKEN`

12
docs/notif/webhook.md
View file

@ -16,12 +16,12 @@ You can send webhook notifications with the following settings.
timeout: 10s timeout: 10s
``` ```
| Name | Default | Description | | Name | Default | Description |
|--------------------|---------------|---------------| |----------------|---------|----------------------------------------------------------------|
| `endpoint`[^1] | | URL of the HTTP request | | `endpoint`[^1] | | URL of the HTTP request |
| `method`[^1] | `GET` | HTTP method | | `method`[^1] | `GET` | HTTP method |
| `headers` | | Map of additional headers to be sent (key is case insensitive) | | `headers` | | Map of additional headers to be sent (key is case insensitive) |
| `timeout` | `10s` | Timeout specifies a time limit for the request to be made | | `timeout` | `10s` | Timeout specifies a time limit for the request to be made |
!!! abstract "Environment variables" !!! abstract "Environment variables"
* `DIUN_NOTIF_WEBHOOK_ENDPOINT` * `DIUN_NOTIF_WEBHOOK_ENDPOINT`

22
docs/providers/docker.md
View file

@ -173,15 +173,15 @@ Include created and exited containers too (default `false`).
You can configure more finely the way to analyze the image of your container through Docker labels: You can configure more finely the way to analyze the image of your container through Docker labels:
| Name | Default | Description | | Name | Default | Description |
|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| `diun.enable` | | Set to true to enable image analysis of this container | | `diun.enable` | | Set to true to enable image analysis of this container |
| `diun.regopt` | | [Registry options](../config/regopts.md) name to use | | `diun.regopt` | | [Registry options](../config/regopts.md) name to use |
| `diun.watch_repo` | `false` | Watch all tags of this container image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) | | `diun.watch_repo` | `false` | Watch all tags of this container image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) |
| `diun.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update` | | `diun.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update` |
| `diun.sort_tags` | `reverse` | [Sort tags method](../faq.md#tags-sorting-when-using-watch_repo) if `diun.watch_repo` enabled. One of `default`, `reverse`, `semver`, `lexicographical` | | `diun.sort_tags` | `reverse` | [Sort tags method](../faq.md#tags-sorting-when-using-watch_repo) if `diun.watch_repo` enabled. One of `default`, `reverse`, `semver`, `lexicographical` |
| `diun.max_tags` | `0` | Maximum number of tags to watch if `diun.watch_repo` enabled. `0` means all of them | | `diun.max_tags` | `0` | Maximum number of tags to watch if `diun.watch_repo` enabled. `0` means all of them |
| `diun.include_tags` | | Semicolon separated list of regular expressions to include tags. Can be useful if you enable `diun.watch_repo` | | `diun.include_tags` | | Semicolon separated list of regular expressions to include tags. Can be useful if you enable `diun.watch_repo` |
| `diun.exclude_tags` | | Semicolon separated list of regular expressions to exclude tags. Can be useful if you enable `diun.watch_repo` | | `diun.exclude_tags` | | Semicolon separated list of regular expressions to exclude tags. Can be useful if you enable `diun.watch_repo` |
| `diun.hub_link` | _automatic_ | Set registry hub link for this image | | `diun.hub_link` | _automatic_ | Set registry hub link for this image |
| `diun.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | | `diun.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) |

20
docs/providers/dockerfile.md
View file

@ -106,14 +106,14 @@ List of path patterns with [matching and globbing supporting patterns](https://g
The following annotations can be added as comments before the target instruction to customize the image analysis: The following annotations can be added as comments before the target instruction to customize the image analysis:
| Name | Default | Description | | Name | Default | Description |
|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| `diun.regopt` | | [Registry options](../config/regopts.md) name to use | | `diun.regopt` | | [Registry options](../config/regopts.md) name to use |
| `diun.watch_repo` | `false` | Watch all tags of this image | | `diun.watch_repo` | `false` | Watch all tags of this image |
| `diun.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update` | | `diun.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update` |
| `diun.sort_tags` | `reverse` | [Sort tags method](../faq.md#tags-sorting-when-using-watch_repo) if `diun.watch_repo` enabled. One of `default`, `reverse`, `semver`, `lexicographical` | | `diun.sort_tags` | `reverse` | [Sort tags method](../faq.md#tags-sorting-when-using-watch_repo) if `diun.watch_repo` enabled. One of `default`, `reverse`, `semver`, `lexicographical` |
| `diun.max_tags` | `0` | Maximum number of tags to watch if `watch_repo` enabled. `0` means all of them | | `diun.max_tags` | `0` | Maximum number of tags to watch if `watch_repo` enabled. `0` means all of them |
| `diun.include_tags` | | Semicolon separated list of regular expressions to include tags. Can be useful if you enable `diun.watch_repo` | | `diun.include_tags` | | Semicolon separated list of regular expressions to include tags. Can be useful if you enable `diun.watch_repo` |
| `diun.exclude_tags` | | Semicolon separated list of regular expressions to exclude tags. Can be useful if you enable `diun.watch_repo` | | `diun.exclude_tags` | | Semicolon separated list of regular expressions to exclude tags. Can be useful if you enable `diun.watch_repo` |
| `diun.hub_link` | _automatic_ | Set registry hub link for this image | | `diun.hub_link` | _automatic_ | Set registry hub link for this image |
| `diun.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | | `diun.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) |

26
docs/providers/file.md
View file

@ -172,17 +172,17 @@ Defines the path to the directory that contains the [configuration files](#yaml-
The configuration file(s) defines a slice of images to analyze with the following fields: The configuration file(s) defines a slice of images to analyze with the following fields:
| Name | Default | Description | | Name | Default | Description |
|--------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| |--------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| `name` | `latest` | Docker image name to watch using `registry/path:tag` format. If registry omitted, `docker.io` will be used and if tag omitted, `latest` will be used | | `name` | `latest` | Docker image name to watch using `registry/path:tag` format. If registry omitted, `docker.io` will be used and if tag omitted, `latest` will be used |
| `regopt` | | [Registry options](../config/regopts.md) name to use | | `regopt` | | [Registry options](../config/regopts.md) name to use |
| `watch_repo` | `false` | Watch all tags of this image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) | | `watch_repo` | `false` | Watch all tags of this image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) |
| `notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update` | | `notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update` |
| `sort_tags` | `reverse` | [Sort tags method](../faq.md#tags-sorting-when-using-watch_repo) if `diun.watch_repo` enabled. One of `default`, `reverse`, `semver`, `lexicographical` | | `sort_tags` | `reverse` | [Sort tags method](../faq.md#tags-sorting-when-using-watch_repo) if `diun.watch_repo` enabled. One of `default`, `reverse`, `semver`, `lexicographical` |
| `max_tags` | `0` | Maximum number of tags to watch if `watch_repo` enabled. `0` means all of them | | `max_tags` | `0` | Maximum number of tags to watch if `watch_repo` enabled. `0` means all of them |
| `include_tags` | | List of regular expressions to include tags. Can be useful if you enable `watch_repo` | | `include_tags` | | List of regular expressions to include tags. Can be useful if you enable `watch_repo` |
| `exclude_tags` | | List of regular expressions to exclude tags. Can be useful if you enable `watch_repo` | | `exclude_tags` | | List of regular expressions to exclude tags. Can be useful if you enable `watch_repo` |
| `hub_link` | _automatic_ | Set registry hub link for this image | | `hub_link` | _automatic_ | Set registry hub link for this image |
| `platform.os` | _automatic_ | Operating system to use as custom platform | | `platform.os` | _automatic_ | Operating system to use as custom platform |
| `platform.arch` | _automatic_ | CPU architecture to use as custom platform | | `platform.arch` | _automatic_ | CPU architecture to use as custom platform |
| `platform.variant` | _automatic_ | Variant of the CPU to use as custom platform | | `platform.variant` | _automatic_ | Variant of the CPU to use as custom platform |

22
docs/providers/kubernetes.md
View file

@ -282,15 +282,15 @@ Enable watch by default. If false, pods that don't have `diun.enable: "true"` an
You can configure more finely the way to analyze the image of your pods through Kubernetes annotations: You can configure more finely the way to analyze the image of your pods through Kubernetes annotations:
| Name | Default | Description | | Name | Default | Description |
|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| `diun.enable` | | Set to true to enable image analysis of this pod | | `diun.enable` | | Set to true to enable image analysis of this pod |
| `diun.regopt` | | [Registry options](../config/regopts.md) name to use | | `diun.regopt` | | [Registry options](../config/regopts.md) name to use |
| `diun.watch_repo` | `false` | Watch all tags of this pod image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) | | `diun.watch_repo` | `false` | Watch all tags of this pod image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) |
| `diun.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update`. | | `diun.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update`. |
| `diun.sort_tags` | `reverse` | [Sort tags method](../faq.md#tags-sorting-when-using-watch_repo) if `diun.watch_repo` enabled. One of `default`, `reverse`, `semver`, `lexicographical` | | `diun.sort_tags` | `reverse` | [Sort tags method](../faq.md#tags-sorting-when-using-watch_repo) if `diun.watch_repo` enabled. One of `default`, `reverse`, `semver`, `lexicographical` |
| `diun.max_tags` | `0` | Maximum number of tags to watch if `diun.watch_repo` enabled. `0` means all of them | | `diun.max_tags` | `0` | Maximum number of tags to watch if `diun.watch_repo` enabled. `0` means all of them |
| `diun.include_tags` | | Semicolon separated list of regular expressions to include tags. Can be useful if you enable `diun.watch_repo` | | `diun.include_tags` | | Semicolon separated list of regular expressions to include tags. Can be useful if you enable `diun.watch_repo` |
| `diun.exclude_tags` | | Semicolon separated list of regular expressions to exclude tags. Can be useful if you enable `diun.watch_repo` | | `diun.exclude_tags` | | Semicolon separated list of regular expressions to exclude tags. Can be useful if you enable `diun.watch_repo` |
| `diun.hub_link` | _automatic_ | Set registry hub link for this image | | `diun.hub_link` | _automatic_ | Set registry hub link for this image |
| `diun.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | | `diun.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) |

22
docs/providers/nomad.md
View file

@ -197,15 +197,15 @@ Enable watch by default. If false, tasks that don't have `diun.enable = true` in
You can configure more finely the way to analyze the image of your tasks through Nomad meta attributes or service tags: You can configure more finely the way to analyze the image of your tasks through Nomad meta attributes or service tags:
| Name | Default | Description | | Name | Default | Description |
|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| `diun.enable` | | Set to true to enable image analysis of this task | | `diun.enable` | | Set to true to enable image analysis of this task |
| `diun.regopt` | | [Registry options](../config/regopts.md) name to use | | `diun.regopt` | | [Registry options](../config/regopts.md) name to use |
| `diun.watch_repo` | `false` | Watch all tags of this task image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) | | `diun.watch_repo` | `false` | Watch all tags of this task image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) |
| `diun.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update`. | | `diun.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update`. |
| `diun.sort_tags` | `reverse` | [Sort tags method](../faq.md#tags-sorting-when-using-watch_repo) if `diun.watch_repo` enabled. One of `default`, `reverse`, `semver`, `lexicographical` | | `diun.sort_tags` | `reverse` | [Sort tags method](../faq.md#tags-sorting-when-using-watch_repo) if `diun.watch_repo` enabled. One of `default`, `reverse`, `semver`, `lexicographical` |
| `diun.max_tags` | `0` | Maximum number of tags to watch if `diun.watch_repo` enabled. `0` means all of them | | `diun.max_tags` | `0` | Maximum number of tags to watch if `diun.watch_repo` enabled. `0` means all of them |
| `diun.include_tags` | | Semicolon separated list of regular expressions to include tags. Can be useful if you enable `diun.watch_repo` | | `diun.include_tags` | | Semicolon separated list of regular expressions to include tags. Can be useful if you enable `diun.watch_repo` |
| `diun.exclude_tags` | | Semicolon separated list of regular expressions to exclude tags. Can be useful if you enable `diun.watch_repo` | | `diun.exclude_tags` | | Semicolon separated list of regular expressions to exclude tags. Can be useful if you enable `diun.watch_repo` |
| `diun.hub_link` | _automatic_ | Set registry hub link for this image | | `diun.hub_link` | _automatic_ | Set registry hub link for this image |
| `diun.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | | `diun.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) |

22
docs/providers/swarm.md
View file

@ -175,15 +175,15 @@ Enable watch by default. If false, services that don't have `diun.enable=true` l
You can configure more finely the way to analyze the image of your service through Docker labels: You can configure more finely the way to analyze the image of your service through Docker labels:
| Name | Default | Description | | Name | Default | Description |
|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| |---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| `diun.enable` | | Set to true to enable image analysis of this service | | `diun.enable` | | Set to true to enable image analysis of this service |
| `diun.regopt` | | [Registry options](../config/regopts.md) name to use | | `diun.regopt` | | [Registry options](../config/regopts.md) name to use |
| `diun.watch_repo` | `false` | Watch all tags of this service image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) | | `diun.watch_repo` | `false` | Watch all tags of this service image ([be careful](../faq.md#docker-hub-rate-limits) with this setting) |
| `diun.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update`. | | `diun.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update`. |
| `diun.sort_tags` | `reverse` | [Sort tags method](../faq.md#tags-sorting-when-using-watch_repo) if `diun.watch_repo` enabled. One of `default`, `reverse`, `semver`, `lexicographical` | | `diun.sort_tags` | `reverse` | [Sort tags method](../faq.md#tags-sorting-when-using-watch_repo) if `diun.watch_repo` enabled. One of `default`, `reverse`, `semver`, `lexicographical` |
| `diun.max_tags` | `0` | Maximum number of tags to watch if `diun.watch_repo` enabled. `0` means all of them | | `diun.max_tags` | `0` | Maximum number of tags to watch if `diun.watch_repo` enabled. `0` means all of them |
| `diun.include_tags` | | Semicolon separated list of regular expressions to include tags. Can be useful if you enable `diun.watch_repo` | | `diun.include_tags` | | Semicolon separated list of regular expressions to include tags. Can be useful if you enable `diun.watch_repo` |
| `diun.exclude_tags` | | Semicolon separated list of regular expressions to exclude tags. Can be useful if you enable `diun.watch_repo` | | `diun.exclude_tags` | | Semicolon separated list of regular expressions to exclude tags. Can be useful if you enable `diun.watch_repo` |
| `diun.hub_link` | _automatic_ | Set registry hub link for this image | | `diun.hub_link` | _automatic_ | Set registry hub link for this image |
| `diun.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | | `diun.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) |

20
docs/usage/command-line.md
View file

@ -36,16 +36,16 @@ diun serve --config diun.yml --log-level debug
Following environment variables can also be used in place: Following environment variables can also be used in place:
| Name | Default | Description | | Name | Default | Description |
|--------------------|---------------|---------------| |------------------|----------|----------------------------------------------------------------------|
| `CONFIG` | | Diun configuration file | | `CONFIG` | | Diun configuration file |
| `PROFILER_PATH` | | Base path where profiling files are written | | `PROFILER_PATH` | | Base path where profiling files are written |
| `PROFILER` | | [Profiler](../faq.md#profiling) to use | | `PROFILER` | | [Profiler](../faq.md#profiling) to use |
| `LOG_LEVEL` | `info` | One of `panic`, `fatal`, `error`, `warn`, `info`, `debug` or `trace` | | `LOG_LEVEL` | `info` | One of `panic`, `fatal`, `error`, `warn`, `info`, `debug` or `trace` |
| `LOG_JSON` | `false` | Enable JSON logging output | | `LOG_JSON` | `false` | Enable JSON logging output |
| `LOG_CALLER` | `false` | Enable to add `file:line` of the caller | | `LOG_CALLER` | `false` | Enable to add `file:line` of the caller |
| `LOG_NOCOLOR` | `false` | Disables the colorized output | | `LOG_NOCOLOR` | `false` | Disables the colorized output |
| `GRPC_AUTHORITY` | `:42286` | Address used to expose the gRPC server | | `GRPC_AUTHORITY` | `:42286` | Address used to expose the gRPC server |
### `image list` ### `image list`