From 5cdfbba7330a20e49b61a13c5e5bc01f3bbde2ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Grie=C3=9Fhaber?= Date: Sat, 5 Oct 2024 10:19:56 +0200 Subject: [PATCH] docs: better documentation for blackout window feature --- docs/configuration.md | 4 ++++ docs/index.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index d74ffa8..fba997c 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -154,6 +154,10 @@ dolce: DOLCE_BLACKOUT_WINDOWS: 02:00-04:00,22:00-23:59 ``` +If the blackout window ends, the status of all containers is compared to the last known state and notifications are sent +if any container is in a different state than before. This enables you to schedule automatic container updates in a +specified window and still get notified if something goes wrong during the update process. + ## Run Directory If you plan on using multiple instances of Dolce (e.g. to enable multiple configurations) make sure that if this is diff --git a/docs/index.md b/docs/index.md index 6cf31a4..05ae401 100644 --- a/docs/index.md +++ b/docs/index.md @@ -36,7 +36,7 @@ Dolce comes with sensible defaults so you can use it out of the box but also let easy fashion if you so desire:
-- [:material-cog: **Configurable** via Environment Variables](./configuration.md) +- [:material-eye-off: **Blackout Windows** so you can schedule automatic updates](./configuration.md#blackout-times) - [:material-database-clock: **Notification Backoff** so you don't get spammed.](./advanced/notification-backoff.md) - [:material-database-lock: **Graceful Error Handling** No events are lost, even if the service gets shut down](./configuration.md) - [:material-email-edit: **Custom Templates** for your notifications with your design](./advanced/custom-templates.md)