Skip to content
Snippets Groups Projects
Commit d49be457 authored by Hahn Axel (hahn)'s avatar Hahn Axel (hahn)
Browse files

update docs

parent 13cfbee3
Branches
No related tags found
1 merge request!5update docs
...@@ -162,9 +162,9 @@ ls -l rest_pruner.cfg ...@@ -162,9 +162,9 @@ ls -l rest_pruner.cfg
## Syntax ## Syntax
```txt ```txt
------------------------------------------------------------------------------
========== RESTIC REST PRUNER v0.1 ========== --------========###| RESTIC REST PRUNER :: v0.2 |###=======--------
------------------------------------------------------------------------------
Pruner for restic rest server with append only option. Pruner for restic rest server with append only option.
This script prunes all repositories on server side. This script prunes all repositories on server side.
...@@ -172,11 +172,21 @@ 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> The config file [rest_pruner.cfg] contains <USER>:<RESTIC_PASSWORD>
If a directory matches /netshare/restic-backup/<USER> then it will be pruned. 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: SYNTAX:
rest_pruner.sh [OPTIONS] [FILTER] rest_pruner.sh [OPTIONS] [FILTER]
OPTIONS: OPTIONS:
-h, --help show help and exit. -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: PARAMETERS:
FILTER regex to filter directory list in FILTER regex to filter directory list in
...@@ -185,10 +195,23 @@ PARAMETERS: ...@@ -185,10 +195,23 @@ PARAMETERS:
EXAMPLES: EXAMPLES:
rest_pruner.sh rest_pruner.sh
Start pruning of all matching repositories Start pruning of all matching repositories
rest_pruner.sh mail rest_pruner.sh mail
Prune servers that match "mail", Prune servers that match "mail",
eg. my-mailhub.example.com 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 ## How does it work
......
...@@ -93,7 +93,7 @@ EXAMPLES: ...@@ -93,7 +93,7 @@ EXAMPLES:
running or on error. running or on error.
It shows repositories with passwords and archives. It shows repositories with passwords and archives.
Other repositories are not visible until you Other repositories are not visible until you
specify -d. specify --all.
EOH EOH
} }
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment