From bce6afb86eae3dca99cf705ad082233407a4d438 Mon Sep 17 00:00:00 2001 From: zorruno Date: Mon, 20 Apr 2026 14:18:12 +1200 Subject: [PATCH] readme tidy --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a90159d..88661bb 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ It will recurse though the directories if they are listed in containers.txt . It will run docker-compose to take down the container, pull a new version if there is one, then bring the container back up. Then it will create a timestamped arcive of each container in the backup directory, under a directory with that container name. +``` Usage: ./docker-backup.sh [-f containers_list_file] [-s source_base_dir] [-t] [-v] [-h] Flags: @@ -36,12 +37,12 @@ Flags: -s DIR Base directory containing container/project folders Default: '$SOURCE_BASE_DIR' -h Show this help - +``` ## PRUNE and REMOTE BACKUP dockerbackup_prune.sh Set up the env file using the example. -cp .env.example .env +```cp .env.example .env``` You don't need to worry about the rclone info (backups to google drive) it you won't be using that. It will just backup up the file locally. Feel free to adjust for other remote backup systems. @@ -51,20 +52,20 @@ then finally uploades to google drive and deletes the large archive (if that's w Then it will prune the number of archive files for each **local archive only (no pruning)** -./dockerbackup_prune.sh +```./dockerbackup_prune.sh``` **local archive + real prune, keep new archive locally. Default prune is 5 archives)** -./dockerbackup_prune.sh --apply +```./dockerbackup_prune.sh --apply``` **local archive + upload + prune dry-run (no actual prune), keep new archive locally (default location is /tmp)** -./dockerbackup_prune.sh --rclone +```./dockerbackup_prune.sh --rclone``` **full remote archive, google drive upload + real prune (default 5) + delete new local archive** -./dockerbackup_prune.sh --rclone --apply +```./dockerbackup_prune.sh --rclone --apply``` **Full remote workflow with actual prune leaving 3 archives of each container and final full archive delete.** **Specify location of docker archives, final archive dir and remote google drive folder.** -./dockerbackup_prune.sh --root /mydockerarchives --/mybigbackupdolder --keep 3 --rclone /dockergooglebackup --apply +```./dockerbackup_prune.sh --root /mydockerarchives --/mybigbackupdolder --keep 3 --rclone /dockergooglebackup --apply Usage: $0 [--apply] [--quiet] [--dry-run] [--keep N] [--root PATH] [--source PATH] [--outdir PATH] [--remote PATH] @@ -78,3 +79,4 @@ Flags: --source PATH Folder to archive (default ${SOURCE_DIR}) --outdir PATH Where to write the .zst (default ${OUT_DIR}) --remote PATH rclone destination (default ${RCLONE_REMOTE}) +```