diff --git a/docs/install/docker.md b/docs/install/docker.md index 2cad9264..6e97b81c 100644 --- a/docs/install/docker.md +++ b/docs/install/docker.md @@ -4,10 +4,10 @@ Diun provides automatically updated Docker :whale: images within several registries: -| Registry | Image | -|--------------------------------------------------------------------------------------------------|---------------------------------| -| [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` | +| Registry | Image | +|-------------------------------------------------------------------------------------------------|--------------------------| +| [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` | 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 -| Path | Description | -|--------------------|---------------| -| `/data` | Contains bbolt database which retains Docker images manifests | +| Path | Description | +|---------|---------------------------------------------------------------| +| `/data` | Contains bbolt database which retains Docker images manifests | ## Usage diff --git a/docs/notif/amqp.md b/docs/notif/amqp.md index e8b7fda0..0578e270 100644 --- a/docs/notif/amqp.md +++ b/docs/notif/amqp.md @@ -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 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 | !!! abstract "Environment variables" * `DIUN_NOTIF_AMQP_HOST` diff --git a/docs/notif/discord.md b/docs/notif/discord.md index 530a2533..17ee5da2 100644 --- a/docs/notif/discord.md +++ b/docs/notif/discord.md @@ -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. ``` -| 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 | +| 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` diff --git a/docs/notif/gotify.md b/docs/notif/gotify.md index fc3d2a10..31cc1e88 100644 --- a/docs/notif/gotify.md +++ b/docs/notif/gotify.md @@ -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. ``` -| 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 | -| `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 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 | +| `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` diff --git a/docs/notif/mail.md b/docs/notif/mail.md index 4e4732e4..50471f9d 100644 --- a/docs/notif/mail.md +++ b/docs/notif/mail.md @@ -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 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 | !!! abstract "Environment variables" * `DIUN_NOTIF_MAIL_HOST` diff --git a/docs/notif/matrix.md b/docs/notif/matrix.md index b8df0475..4d78b186 100644 --- a/docs/notif/matrix.md +++ b/docs/notif/matrix.md @@ -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 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 | !!! abstract "Environment variables" * `DIUN_NOTIF_MATRIX_HOMESERVERURL` diff --git a/docs/notif/mqtt.md b/docs/notif/mqtt.md index 8f082d5e..c1260a2b 100644 --- a/docs/notif/mqtt.md +++ b/docs/notif/mqtt.md @@ -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 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) | !!! abstract "Environment variables" * `DIUN_NOTIF_MQTT_SCHEME` diff --git a/docs/notif/pushover.md b/docs/notif/pushover.md index 13067e87..6cf61d1f 100644 --- a/docs/notif/pushover.md +++ b/docs/notif/pushover.md @@ -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. ``` -| 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 | -| `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 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 | +| `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` diff --git a/docs/notif/rocketchat.md b/docs/notif/rocketchat.md index 85e91d96..5d129d7b 100644 --- a/docs/notif/rocketchat.md +++ b/docs/notif/rocketchat.md @@ -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. ``` -| 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 | -| `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 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 | +| `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. diff --git a/docs/notif/script.md b/docs/notif/script.md index 83c6327d..1f9c93b6 100644 --- a/docs/notif/script.md +++ b/docs/notif/script.md @@ -27,11 +27,11 @@ DIUN_ENTRY_PLATFORM=linux/amd64 - "another" ``` -| Name | Default | Description | -|-----------------------|---------------|---------------| -| `cmd`[^1] | | Command or script to execute | -| `args` | | List of args to pass to `cmd` | -| `dir` | | Specifies the working directory of the command | +| Name | Default | Description | +|-----------|---------|------------------------------------------------| +| `cmd`[^1] | | Command or script to execute | +| `args` | | List of args to pass to `cmd` | +| `dir` | | Specifies the working directory of the command | !!! abstract "Environment variables" * `DIUN_NOTIF_SCRIPT_CMD` diff --git a/docs/notif/slack.md b/docs/notif/slack.md index 9dd2fffe..ed8f9fc3 100644 --- a/docs/notif/slack.md +++ b/docs/notif/slack.md @@ -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. ``` -| Name | Default | Description | -|--------------------|--------------------------------------------|---------------| -| `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) | -| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body | +| Name | Default | Description | +|--------------------|------------------------------------|-------------------------------------------------------------------------------------------| +| `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) | +| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body | !!! abstract "Environment variables" * `DIUN_NOTIF_SLACK_WEBHOOKURL` diff --git a/docs/notif/teams.md b/docs/notif/teams.md index 44df390e..0a48217d 100644 --- a/docs/notif/teams.md +++ b/docs/notif/teams.md @@ -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. ``` -| 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) | -| `renderFacts` | `true` | Render fact objects | -| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body | +| 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) | +| `renderFacts` | `true` | Render fact objects | +| `templateBody`[^1] | See [below](#default-templatebody) | [Notification template](../faq.md#notification-template) for message body | !!! abstract "Environment variables" * `DIUN_NOTIF_TEAMS_WEBHOOKURL` diff --git a/docs/notif/telegram.md b/docs/notif/telegram.md index 29a1086d..b638458b 100644 --- a/docs/notif/telegram.md +++ b/docs/notif/telegram.md @@ -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. ``` -| 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 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 | +| 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 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 | !!! abstract "Environment variables" * `DIUN_NOTIF_TELEGRAM_TOKEN` diff --git a/docs/notif/webhook.md b/docs/notif/webhook.md index 9f06c1a9..97920a9b 100644 --- a/docs/notif/webhook.md +++ b/docs/notif/webhook.md @@ -16,12 +16,12 @@ You can send webhook notifications with the following settings. timeout: 10s ``` -| Name | Default | Description | -|--------------------|---------------|---------------| -| `endpoint`[^1] | | URL of the HTTP request | -| `method`[^1] | `GET` | HTTP method | -| `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 | +| Name | Default | Description | +|----------------|---------|----------------------------------------------------------------| +| `endpoint`[^1] | | URL of the HTTP request | +| `method`[^1] | `GET` | HTTP method | +| `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 | !!! abstract "Environment variables" * `DIUN_NOTIF_WEBHOOK_ENDPOINT` diff --git a/docs/providers/docker.md b/docs/providers/docker.md index 91460b4c..a614f8b5 100644 --- a/docs/providers/docker.md +++ b/docs/providers/docker.md @@ -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: -| Name | Default | Description | -|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `diun.enable` | | Set to true to enable image analysis of this container | -| `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.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update` | +| Name | Default | Description | +|---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| `diun.enable` | | Set to true to enable image analysis of this container | +| `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.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.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.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.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | +| `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.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.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | diff --git a/docs/providers/dockerfile.md b/docs/providers/dockerfile.md index bae7e792..e82164cd 100644 --- a/docs/providers/dockerfile.md +++ b/docs/providers/dockerfile.md @@ -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: -| Name | Default | Description | -|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `diun.regopt` | | [Registry options](../config/regopts.md) name to use | -| `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` | +| Name | Default | Description | +|---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| `diun.regopt` | | [Registry options](../config/regopts.md) name to use | +| `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.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.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.hub_link` | _automatic_ | Set registry hub link for this image | -| `diun.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | +| `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.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.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | diff --git a/docs/providers/file.md b/docs/providers/file.md index 9a49c0f5..2d9e29f1 100644 --- a/docs/providers/file.md +++ b/docs/providers/file.md @@ -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: -| 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 | -| `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) | -| `notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update` | +| 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 | +| `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) | +| `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` | -| `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` | -| `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 | -| `platform.os` | _automatic_ | Operating system 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 | +| `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` | +| `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 | +| `platform.os` | _automatic_ | Operating system 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 | diff --git a/docs/providers/kubernetes.md b/docs/providers/kubernetes.md index 5ca1a31c..df5a951e 100644 --- a/docs/providers/kubernetes.md +++ b/docs/providers/kubernetes.md @@ -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: -| Name | Default | Description | -|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `diun.enable` | | Set to true to enable image analysis of this pod | -| `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.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update`. | +| Name | Default | Description | +|---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| `diun.enable` | | Set to true to enable image analysis of this pod | +| `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.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.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.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.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | +| `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.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.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | diff --git a/docs/providers/nomad.md b/docs/providers/nomad.md index 43ea1d59..53de4495 100644 --- a/docs/providers/nomad.md +++ b/docs/providers/nomad.md @@ -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: -| Name | Default | Description | -|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `diun.enable` | | Set to true to enable image analysis of this task | -| `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.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update`. | +| Name | Default | Description | +|---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| `diun.enable` | | Set to true to enable image analysis of this task | +| `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.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.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.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.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | +| `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.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.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | diff --git a/docs/providers/swarm.md b/docs/providers/swarm.md index fb62e128..e945e3d8 100644 --- a/docs/providers/swarm.md +++ b/docs/providers/swarm.md @@ -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: -| Name | Default | Description | -|---------------------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `diun.enable` | | Set to true to enable image analysis of this service | -| `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.notify_on` | `new;update` | Semicolon separated list of status to be notified: `new`, `update`. | +| Name | Default | Description | +|---------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| `diun.enable` | | Set to true to enable image analysis of this service | +| `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.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.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.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.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | +| `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.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.platform` | _automatic_ | Platform to use (e.g. `linux/amd64`) | diff --git a/docs/usage/command-line.md b/docs/usage/command-line.md index a07c5de4..ce1cbf15 100644 --- a/docs/usage/command-line.md +++ b/docs/usage/command-line.md @@ -36,16 +36,16 @@ diun serve --config diun.yml --log-level debug Following environment variables can also be used in place: -| Name | Default | Description | -|--------------------|---------------|---------------| -| `CONFIG` | | Diun configuration file | -| `PROFILER_PATH` | | Base path where profiling files are written | -| `PROFILER` | | [Profiler](../faq.md#profiling) to use | -| `LOG_LEVEL` | `info` | One of `panic`, `fatal`, `error`, `warn`, `info`, `debug` or `trace` | -| `LOG_JSON` | `false` | Enable JSON logging output | -| `LOG_CALLER` | `false` | Enable to add `file:line` of the caller | -| `LOG_NOCOLOR` | `false` | Disables the colorized output | -| `GRPC_AUTHORITY` | `:42286` | Address used to expose the gRPC server | +| Name | Default | Description | +|------------------|----------|----------------------------------------------------------------------| +| `CONFIG` | | Diun configuration file | +| `PROFILER_PATH` | | Base path where profiling files are written | +| `PROFILER` | | [Profiler](../faq.md#profiling) to use | +| `LOG_LEVEL` | `info` | One of `panic`, `fatal`, `error`, `warn`, `info`, `debug` or `trace` | +| `LOG_JSON` | `false` | Enable JSON logging output | +| `LOG_CALLER` | `false` | Enable to add `file:line` of the caller | +| `LOG_NOCOLOR` | `false` | Disables the colorized output | +| `GRPC_AUTHORITY` | `:42286` | Address used to expose the gRPC server | ### `image list`