From f9be3482e6ecfe69c92ac35ad1ea54450c409df7 Mon Sep 17 00:00:00 2001 From: Pierre Maurice Schwang Date: Tue, 13 Sep 2022 23:27:20 +0200 Subject: [PATCH] chore/doc: update periodic backup documentation --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6ff5b40..5d3faa4 100644 --- a/README.md +++ b/README.md @@ -198,7 +198,7 @@ $ docker run --rm \ # Periodic Backups -The default cron setting for this container is: `0 0 4 * * *`. That's four o'clock in the morning UTC. You can set your own schedule with the environment variable `VOLUMERIZE_JOBBER_TIME`. +By default no periodic backup job is created. You can set your own schedule with the environment variable `VOLUMERIZE_JOBBER_TIME`. You can set the time zone with the environment variable `TZ`. @@ -221,6 +221,12 @@ $ docker run -d \ > Backups at three o'clock in the morning according to german local time. +If you would like to validate your job, you can list all active jobs using `docker exec volumerize jobber list` +~~~~ +NAME STATUS SEC/MIN/HR/MDAY/MTH/WDAY NEXT RUN TIME NOTIFY ON SUCCESS NOTIFY ON ERR NOTIFY ON FAIL ERR HANDLER +VolumerizeBackupJob Good 0 0 4 * * * Sep 14 04:00:00 +0200 CEST Continue +~~~~ + # Docker Container Restarts This image can stop and start Docker containers before and after backup. Docker containers are specified using the environment variable `VOLUMERIZE_CONTAINERS`. Just enter their names in a empty space separated list.