From d49be4572df44ef152f6bcd52bc8b551fde519dc Mon Sep 17 00:00:00 2001
From: "Hahn Axel (hahn)" <axel.hahn@unibe.ch>
Date: Fri, 2 Feb 2024 13:38:54 +0100
Subject: [PATCH] update docs
---
docs/30_Scripts.md | 29 ++++++++++++++++++++++++++---
rest_pruner.sh | 2 +-
2 files changed, 27 insertions(+), 4 deletions(-)
diff --git a/docs/30_Scripts.md b/docs/30_Scripts.md
index 52ca90b..1468370 100644
--- a/docs/30_Scripts.md
+++ b/docs/30_Scripts.md
@@ -162,9 +162,9 @@ ls -l rest_pruner.cfg
## Syntax
```txt
-
-========== RESTIC REST PRUNER v0.1 ==========
-
+------------------------------------------------------------------------------
+ --------========###| RESTIC REST PRUNER :: v0.2 |###=======--------
+------------------------------------------------------------------------------
Pruner for restic rest server with append only option.
This script prunes all repositories on server side.
@@ -172,11 +172,21 @@ This script prunes all repositories on server side.
The config file [rest_pruner.cfg] contains <USER>:<RESTIC_PASSWORD>
If a directory matches /netshare/restic-backup/<USER> then it will be pruned.
+Institute for Medical Education * University of Bern
+GNU GPL 3.0
+
+
SYNTAX:
rest_pruner.sh [OPTIONS] [FILTER]
+
OPTIONS:
-h, --help show help and exit.
+ -a, --all process all repositories, default: rest only + archives
+ -d, --debug show more infos
+ -f, --force force pruning; do not wait 7 days
+ -s, --status show pruning status with last prunes
+
PARAMETERS:
FILTER regex to filter directory list in
@@ -185,10 +195,23 @@ PARAMETERS:
EXAMPLES:
rest_pruner.sh
Start pruning of all matching repositories
+
rest_pruner.sh mail
Prune servers that match "mail",
eg. my-mailhub.example.com
+ rest_pruner.sh --force mail
+ Prune servers that match "mail",
+ eg. my-mailhub.example.com
+
+ rest_pruner.sh --status
+ Show statistics with last prunes, if it is archive or
+ running or on error.
+ It shows repositories with passwords and archives.
+ Other repositories are not visible until you
+ specify --all.
+
+
```
## How does it work
diff --git a/rest_pruner.sh b/rest_pruner.sh
index 095490b..3762e93 100755
--- a/rest_pruner.sh
+++ b/rest_pruner.sh
@@ -93,7 +93,7 @@ EXAMPLES:
running or on error.
It shows repositories with passwords and archives.
Other repositories are not visible until you
- specify -d.
+ specify --all.
EOH
}
--
GitLab