george/borg-manager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add error logging description

Browse Source
This commit is contained in:
George Lacey 2021-05-06 02:45:34 +01:00
parent 4b5b56d6eb
commit 4a3105438c
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -3,19 +3,23 @@ Summarises [borg](https://borgbackup.readthedocs.io/en/stable/#what-is-borgbacku
## Features: ## Features:
* Parses json output from 'borg create --json' * Parses json output from 'borg create --json'
* Stores Repo and archive information in sqlite database * Stores repo and archive information in sqlite database
* Print summary of repos * Logs errors
* Prints summary of repos and recent errors
### Planned: ### Planned:
* Output to Graphs/HTML * Output to Graphs/HTML
## How to use ## How to use
Pipe the output of 'borg create --json' to the script, for example: Pipe the output of 'borg create --json' to the script, for example:
> borg create --json /repo/path::name /important/data/ | python3 ./main.py -l [label]
> borg create --json /repo/path::name /important/data/ 2>&1 | python3 ./main.py -l [label]
>
> <sup>*(2>&1 redirects errors to borg-manager for logging)</sup>
### Arguments: ### Arguments:
* -o / --output -> specify database location * -o / --output -> specify database location
> -o /home/user/borg/logs > `-o /home/user/borg/logs`
* -l / --label -> specify label for borg repo * -l / --label -> specify label for borg repo
> -l "Server backups" > `-l 'Server backups'`
* -s / --summary -> print summary * -s / --summary -> print summary