From a79de24bcc517932e4f8b8d7d571c03e7d37b32a Mon Sep 17 00:00:00 2001 From: mag37 Date: Wed, 18 Sep 2024 16:44:32 +0200 Subject: [PATCH] Cleanups + info to readme --- README.md | 20 ++++++++----------- .../notify_DSM.sh | 0 .../notify_apprise.sh | 0 .../notify_generic.sh | 0 .../notify_gotify.sh | 0 .../notify_matrix.sh | 0 .../notify_ntfy-sh.sh | 0 .../notify_pushbullet.sh | 0 .../notify_pushover.sh | 0 .../notify_smtp.sh | 0 .../notify_telegram.sh | 0 11 files changed, 8 insertions(+), 12 deletions(-) rename notify_DSM.sh => notify_templates/notify_DSM.sh (100%) rename notify_apprise.sh => notify_templates/notify_apprise.sh (100%) rename notify_generic.sh => notify_templates/notify_generic.sh (100%) rename notify_gotify.sh => notify_templates/notify_gotify.sh (100%) rename notify_matrix.sh => notify_templates/notify_matrix.sh (100%) rename notify_ntfy-sh.sh => notify_templates/notify_ntfy-sh.sh (100%) rename notify_pushbullet.sh => notify_templates/notify_pushbullet.sh (100%) rename notify_pushover.sh => notify_templates/notify_pushover.sh (100%) rename notify_smtp.sh => notify_templates/notify_smtp.sh (100%) rename notify_telegram.sh => notify_templates/notify_telegram.sh (100%) diff --git a/README.md b/README.md index 93eaac2..e5973de 100644 --- a/README.md +++ b/README.md @@ -22,12 +22,6 @@ ___ - **v0.4.6**: Compatibility changes to timeout, due to busybox. - **v0.4.5**: Bugfixes, compatibility changes to timeout and arrays. - **v0.4.3**: Added timeout option to skip container if registry check takes too long (10s default). -- **v0.4.1**: Syntax and logic cleanups, bugfixes on multi compose and env-files. -- **v0.4.0**: Reworked selfupdate (auto git/curl/wget), general syntax cleanup, added -v for version. -- **v0.3.8**: Fixed `--env-file` logic to work with multiple env-files. -- **v0.3.7**: Added support for [labels](#bookmark-labels), added the `-f` option (force restart stack). -- **v0.3.6**: Added pushbullet template. -- **v0.3.5**: Added a simple progress bar for the registry checkup. ___ @@ -103,7 +97,7 @@ Add preferred `notify.sh`-template to the same directory - this will not be touc Trigger with the `-i` flag. Run it scheduled with `-ni` to only get notified when there's updates available! -Use a `notify_X.sh` template file, copy it to `notify.sh`, modify it to your needs! (notify.sh is added to .gitignore) +Use a `notify_X.sh` template file from the **notify_templates** directory, copy it to `notify.sh` alongside the script, modify it to your needs! (notify.sh is added to .gitignore) **Current 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)) @@ -115,6 +109,7 @@ Use a `notify_X.sh` template file, copy it to `notify.sh`, modify it to your nee - [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. +- [Pushover](https://pushover.net/) - Simple Notifications (to your phone, wearables, desktops) Further additions are welcome - suggestions or PR! Initiated and first contributed by [yoyoma2](https://github.com/yoyoma2). @@ -161,13 +156,18 @@ function dchk { ## :hammer: Known issues - No detailed error feedback (just skip + list what's skipped). - Not respecting `--profile` options when re-creating the container. -- Not working well with containers created by Portainer. +- Not working well with containers created by **Portainer**. +- **Watchtower** might cause issues due to retagging images when checking for updates (and thereby pulling new images). ## :warning: `-r flag` disclaimer and warning **Wont auto-update the containers, only their images. (compose is recommended)** `docker run` dont support using new images just by restarting a container. Containers need to be manually stopped, removed and created again to run on the new image. +## :wrench: Debugging +If you hit issues, you could check the output of the `extras/errorCheck.sh` script for clues. +Another option is to run the main script with debugging in a subshell `bash -x dockcheck.sh` - if there's a particular container/image that's causing issues you can filter for just that through `bash -x dockcheck.sh nginx`. + ## :scroll: License dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html) license. @@ -175,7 +175,3 @@ dockcheck is created and released under the [GNU GPL v3.0](https://www.gnu.org/l ___ - -## Special Thanks -- :bison: [t0rnis](https://github.com/t0rnis) -- :leopard: [Palleri](https://github.com/Palleri) diff --git a/notify_DSM.sh b/notify_templates/notify_DSM.sh similarity index 100% rename from notify_DSM.sh rename to notify_templates/notify_DSM.sh diff --git a/notify_apprise.sh b/notify_templates/notify_apprise.sh similarity index 100% rename from notify_apprise.sh rename to notify_templates/notify_apprise.sh diff --git a/notify_generic.sh b/notify_templates/notify_generic.sh similarity index 100% rename from notify_generic.sh rename to notify_templates/notify_generic.sh diff --git a/notify_gotify.sh b/notify_templates/notify_gotify.sh similarity index 100% rename from notify_gotify.sh rename to notify_templates/notify_gotify.sh diff --git a/notify_matrix.sh b/notify_templates/notify_matrix.sh similarity index 100% rename from notify_matrix.sh rename to notify_templates/notify_matrix.sh diff --git a/notify_ntfy-sh.sh b/notify_templates/notify_ntfy-sh.sh similarity index 100% rename from notify_ntfy-sh.sh rename to notify_templates/notify_ntfy-sh.sh diff --git a/notify_pushbullet.sh b/notify_templates/notify_pushbullet.sh similarity index 100% rename from notify_pushbullet.sh rename to notify_templates/notify_pushbullet.sh diff --git a/notify_pushover.sh b/notify_templates/notify_pushover.sh similarity index 100% rename from notify_pushover.sh rename to notify_templates/notify_pushover.sh diff --git a/notify_smtp.sh b/notify_templates/notify_smtp.sh similarity index 100% rename from notify_smtp.sh rename to notify_templates/notify_smtp.sh diff --git a/notify_telegram.sh b/notify_templates/notify_telegram.sh similarity index 100% rename from notify_telegram.sh rename to notify_templates/notify_telegram.sh