Andreas/dockcheck
1
0
Fork 0
mirror of https://github.com/mag37/dockcheck.git synced 2026-02-19 01:38:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix ALLOWEMPTY logic, undefined snippet case, and README formatting.

Browse source
This commit is contained in:
Matthew Oleksowicz 2025-08-24 23:48:47 -04:00
parent 8bbc73482e
commit 51c9987d45
2 changed files with 21 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -26,12 +26,12 @@ ___
- Added support for multiple notifications using the same template
- Added support for notification output format
- Added support for file output
- Added optional configuration variables per channel to (replace <channel> with any channel name):
- <channel>\_TEMPLATE : Specify a template
- <channel>\_SKIPSNOOZE : Skip snooze
- <channel>\_CONTAINERSONLY : Only notify for docker container related updates
- <channel>\_ALLOWEMPTY : Always send notifications, even when empty
- <channel>\_OUTPUT : Define output format
- Added optional configuration variables per channel to (replace &lt;channel&gt; with any channel name):
- &lt;channel&gt;\_TEMPLATE : Specify a template
- &lt;channel&gt;\_SKIPSNOOZE : Skip snooze
- &lt;channel&gt;\_CONTAINERSONLY : Only notify for docker container related updates
- &lt;channel&gt;\_ALLOWEMPTY : Always send notifications, even when empty
- &lt;channel&gt;\_OUTPUT : Define output format
- **v0.7.0**:
- Bugfix: snooze dockcheck.sh-self-notification and some config clarification.
- Added authentication support to Ntfy.sh.
@ -209,15 +209,15 @@ Further additions are welcome - suggestions or PRs!
#### Notification channel configuration:
All required environment variables for each channel type are provided in the default.config file as comments and must be uncommented and modified for your requirements.
For advanced users, additional functionality is available via custom configurations and environment variables.
Use cases (in all cases, replace <channel> with the name of the channel specified in the NOTIFY_CHANNELS environment variable):
- To bypass the snooze feature, even when enabled, add the variable `<channel>\_SKIPSNOOZE` to `dockcheck.config` and set it equal to `true`.
- To configure the channel to only send Docker container update notifications, add the variable `<channel>\_CONTAINERSONLY` to `dockcheck.config` and set it equal to `true`.
- To send notifications even when there are no updates available, add the variable `<channel>\_ALLOWEMPTY` to `dockcheck.config` and set it equal to `true`.
- To use another notification output format, add the variable `<channel>\_OUTPUT` to `dockcheck.config` and set it equal to `csv`, `json`, or `text`. If unset or set to an invalid value, defaults to `text`.
Use cases (in all cases, replace &lt;channel&gt; with the name of the channel specified in the NOTIFY_CHANNELS environment variable):
- To bypass the snooze feature, even when enabled, add the variable `<channel>_SKIPSNOOZE` to `dockcheck.config` and set it equal to `true`.
- To configure the channel to only send Docker container update notifications, add the variable `<channel>_CONTAINERSONLY` to `dockcheck.config` and set it equal to `true`.
- To send notifications even when there are no updates available, add the variable `<channel>_ALLOWEMPTY` to `dockcheck.config` and set it equal to `true`.
- To use another notification output format, add the variable `<channel>_OUTPUT` to `dockcheck.config` and set it equal to `csv`, `json`, or `text`. If unset or set to an invalid value, defaults to `text`.
- To send multiple notifications using the same notification template:
- Strings in the `NOTIFY_CHANNELS` list are now treated as unique names and do not necessarily refer to the notification template that will be called, though they do by default.
- Add another notification channel to `NOTIFY_CHANNELS` in `dockcheck.config`. It can have any name as long as it is unique and contains no spaces or special characters.
- Add the variable `<channel>\_TEMPLATE` to `dockcheck.config` where `<channel>` is the name of the channel added above and set the value to an available notification template script (`slack`, `apprise`, `gotify`, etc.)
- Add the variable `<channel>_TEMPLATE` to `dockcheck.config` where `<channel>` is the name of the channel added above and set the value to an available notification template script (`slack`, `apprise`, `gotify`, etc.)
- Add all other environment variables required for the chosen template to function with `<channel>` in upper case as the prefix rather than the template name.
- For example, if `<channel>` is `mynotification` and the template configured is `slack`, you would need to set `MYNOTIFICATION_CHANNEL_ID` and `MYNOTIFICATION_ACCESS_TOKEN`.