mirror of
https://github.com/mag37/dockcheck.git
synced 2026-02-14 23:38:15 +01:00
c63e2441fa
* Refactor notifications and add helper functions * Add helper functions to simplify sourcing files and executing functions if they exist * Create notify_v2.sh wrapper script * Simplify and consolidate notification logic within notify_v2.sh * Support notification management via environment variables * Move secrets to dockcheck.config * Fix NOTIFY_CHANNELS default value when not set * Feedback changes * Remove leading spaces from MessageBody * Check for valid notify v2 variables * Warn on missing configuration and bypass notifications * Update readme * Additional feedback fixes * More comments in default.config with different # depth for comments and settings * Rename NOTIFY_TOPIC_NAME variable to NTFY_TOPIC_NAME for consistency * Add TELEGRAM_TOPIC_ID * Fix AppriseURL variable * Add an ending newline to all MessageBody statements for consistency * Remove troubleshooting echo statement * Prevent attempting to trigger notifications for notification templates if versions are the same --------- Co-authored-by: Matthew Oleksowicz <matt@everyoneneeds.it>
84 lines
3.3 KiB
Bash
84 lines
3.3 KiB
Bash
NOTIFY_V2_VERSION="v0.1"
|
|
#
|
|
# If migrating from an older notify template, remove your existing notify.sh file.
|
|
# Enable and configure all required notification variables in your dockcheck.config file, e.g.:
|
|
# NOTIFY_CHANNELS=apprise gotify slack
|
|
# SLACK_TOKEN=xoxb-some-token-value
|
|
# GOTIFY_TOKEN=some.token
|
|
|
|
enabled_notify_channels=( ${NOTIFY_CHANNELS:-} )
|
|
|
|
FromHost=$(hostname)
|
|
|
|
remove_channel() {
|
|
local temp_array=()
|
|
for channel in "${enabled_notify_channels[@]}"; do
|
|
[[ "${channel}" != "$1" ]] && temp_array+=("${channel}")
|
|
done
|
|
enabled_notify_channels=( "${temp_array[@]}" )
|
|
}
|
|
|
|
for channel in "${enabled_notify_channels[@]}"; do
|
|
source_if_exists "${ScriptWorkDir}/notify_templates/notify_${channel}.sh"
|
|
done
|
|
|
|
send_notification() {
|
|
[[ -s "$ScriptWorkDir"/urls.list ]] && releasenotes || Updates=("$@")
|
|
UpdToString=$( printf '%s\\n' "${Updates[@]}" )
|
|
|
|
for channel in "${enabled_notify_channels[@]}"; do
|
|
printf "\nSending ${channel} notification\n"
|
|
|
|
MessageTitle="$FromHost - updates available."
|
|
# Setting the MessageBody variable here.
|
|
printf -v MessageBody "🐋 Containers on $FromHost with updates available:\n$UpdToString\n"
|
|
|
|
exec_if_exists trigger_${channel}_notification "$@"
|
|
done
|
|
}
|
|
|
|
### Set DISABLE_DOCKCHECK_NOTIFICATION=false in dockcheck.config
|
|
### to not send notifications when dockcheck itself has updates.
|
|
dockcheck_notification() {
|
|
if [[ ! "${DISABLE_DOCKCHECK_NOTIFICATION:-}" = "true" ]]; then
|
|
MessageTitle="$FromHost - New version of dockcheck available."
|
|
# Setting the MessageBody variable here.
|
|
printf -v MessageBody "Installed version: $1\nLatest version: $2\n\nChangenotes: $3\n"
|
|
|
|
if [[ ${#enabled_notify_channels[@]} -gt 0 ]]; then printf "\n"; fi
|
|
for channel in "${enabled_notify_channels[@]}"; do
|
|
printf "Sending dockcheck update notification - ${channel}\n"
|
|
exec_if_exists trigger_${channel}_notification
|
|
done
|
|
fi
|
|
}
|
|
|
|
### Set DISABLE_NOTIFY_UPDATE_NOTIFICATION=false in dockcheck.config
|
|
### to not send notifications when notify scripts themselves have updates.
|
|
notify_update_notification() {
|
|
if [[ ! "${DISABLE_NOTIFY_UPDATE_NOTIFICATION:-}" = "true" ]]; then
|
|
update_channels=( "${enabled_notify_channels[@]}" "v2" )
|
|
|
|
for notify_script in "${update_channels[@]}"; do
|
|
upper_channel=$(tr '[:lower:]' '[:upper:]' <<< "$notify_script")
|
|
VersionVar="NOTIFY_${upper_channel}_VERSION"
|
|
if [[ -n "${!VersionVar}" ]]; then
|
|
RawNotifyUrl="https://raw.githubusercontent.com/mag37/dockcheck/main/notify_templates/notify_${notify_script}.sh"
|
|
LatestNotifyRelease="$(curl -s -r 0-150 $RawNotifyUrl | sed -n "/NOTIFY_${upper_channel}_VERSION/s/NOTIFY_${upper_channel}_VERSION=//p" | tr -d '"')"
|
|
LatestNotifyRelease=${LatestNotifyRelease:-undefined}
|
|
if [[ ! "${LatestNotifyRelease}" = "undefined" ]]; then
|
|
if [[ "${!VersionVar}" != "$LatestNotifyRelease" ]] ; then
|
|
MessageTitle="$FromHost - New version of notify_${notify_script}.sh available."
|
|
|
|
printf -v MessageBody "notify_${notify_script}.sh update available:\n ${!VersionVar} -> $LatestNotifyRelease\n"
|
|
|
|
for channel in "${enabled_notify_channels[@]}"; do
|
|
printf "Sending notify_${notify_script}.sh update notification - ${channel}\n"
|
|
exec_if_exists trigger_${channel}_notification
|
|
done
|
|
fi
|
|
fi
|
|
fi
|
|
done
|
|
fi
|
|
}
|