diff --git a/README.md b/README.md index 0f93af5..9810726 100644 --- a/README.md +++ b/README.md @@ -164,6 +164,7 @@ you wish to enable, but there is no harm in having all of them present. ├── notify_templates/ │ ├── notify_DSM.sh │ ├── notify_apprise.sh +│ ├── notify_bark.sh │ ├── notify_discord.sh │ ├── notify_generic.sh │ ├── notify_gotify.sh @@ -204,20 +205,21 @@ The actual snooze duration will be 60 seconds less than `SNOOZE_SECONDS` to acco #### Current notify templates -- Synology [DSM](https://www.synology.com/en-global/dsm) -- Email with [mSMTP](https://wiki.debian.org/msmtp) (or deprecated alternative [sSMTP](https://wiki.debian.org/sSMTP)) - Apprise (with it's [multitude](https://github.com/caronc/apprise#supported-notifications) of notifications) - both native [caronc/apprise](https://github.com/caronc/apprise) and the standalone [linuxserver/docker-apprise-api](https://github.com/linuxserver/docker-apprise-api) - Read the [QuickStart](extras/apprise_quickstart.md) -- [ntfy](https://ntfy.sh/) - HTTP-based pub-sub notifications. +- [Bark](https://bark.day.app/) - iOS Push notifications. +- [Discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) - Discord webhooks. +- [DSM](https://www.synology.com/en-global/dsm) - Synology. - [Gotify](https://gotify.net/) - a simple server for sending and receiving messages. - [Home Assistant](https://www.home-assistant.io/integrations/notify/) - Connection to the notify [integrations](https://www.home-assistant.io/integrations/#notifications). -- [Pushbullet](https://www.pushbullet.com/) - connecting different devices with cross-platform features. -- [Telegram](https://telegram.org/) - Telegram chat API. - [Matrix-Synapse](https://github.com/element-hq/synapse) - [Matrix](https://matrix.org/), open, secure, decentralised communication. +- [ntfy](https://ntfy.sh/) - HTTP-based pub-sub notifications. +- [Pushbullet](https://www.pushbullet.com/) - connecting different devices with cross-platform features. - [Pushover](https://pushover.net/) - Simple Notifications (to your phone, wearables, desktops) -- [Discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) - Discord webhooks. - [Slack](https://api.slack.com/tutorials/tracks/posting-messages-with-curl) - Slack curl api +- SMTP Email with [mSMTP](https://wiki.debian.org/msmtp) (or deprecated alternative [sSMTP](https://wiki.debian.org/sSMTP)) +- [Telegram](https://telegram.org/) - Telegram chat API. Further additions are welcome - suggestions or PRs! Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2). diff --git a/default.config b/default.config index 330d45f..f9076a2 100644 --- a/default.config +++ b/default.config @@ -1,4 +1,4 @@ -### Custom user variables +##### Custom user variables ##### ## Copy this file to "dockcheck.config" to make it active ## Can be placed in ~/.config/ or alongside dockcheck.sh ## @@ -30,11 +30,12 @@ #Stopped="-a" # Include stopped containers in the check. (Logic: docker ps -a). #Timeout=10 # Set a timeout (in seconds) per container for registry checkups. -### Notify settings +##### NOTIFY SETTINGS BELOW ##### +## ## All commented values are examples only. Modify as needed. ## ## Uncomment the line below and specify the notification channels you wish to enable in a space separated string -# NOTIFY_CHANNELS="apprise discord DSM file generic HA gotify matrix ntfy pushbullet pushover slack smtp telegram bark file" +# NOTIFY_CHANNELS="apprise bark discord DSM file generic gotify HA matrix ntfy pushbullet pushover slack smtp telegram" # ## Uncomment the line below and specify the number of seconds to delay notifications to enable snooze # SNOOZE_SECONDS=86400 @@ -51,11 +52,15 @@ # tgram://{bot_token}/{chat_id}/' # APPRISE_URL="http://apprise.mydomain.tld:1234/notify/apprise" # +# BARK_KEY="key-value" +# # DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/" # # DSM_SENDMAILTO="me@mydomain.com" # DSM_SUBJECTTAG="Email Subject Prefix" # +# FILE_PATH="${ScriptWorkDir}/updates_available.txt" +# # GOTIFY_DOMAIN="https://gotify.domain.tld" # GOTIFY_TOKEN="token-value" # @@ -70,7 +75,8 @@ ## https://ntfy.sh or your custom domain with https:// and no trailing / # NTFY_DOMAIN="https://ntfy.sh" # NTFY_TOPIC_NAME="YourUniqueTopicName" -# NTFY_AUTH="" # set to either format -> "user:password" OR ":tk_12345678". If using tokens, don't forget the ":" +## Auth method, set to either format -> "user:password" OR ":tk_12345678". If using tokens, don't forget the ":" +# NTFY_AUTH="" # # PUSHBULLET_URL="https://api.pushbullet.com/v2/pushes" # PUSHBULLET_TOKEN="token-value" @@ -89,7 +95,3 @@ # TELEGRAM_CHAT_ID="mychatid" # TELEGRAM_TOKEN="token-value" # TELEGRAM_TOPIC_ID="0" -# -# BARK_KEY="" -# -# FILE_PATH="${ScriptWorkDir}/updates_available.txt"