borgreport - manual page for borgreport 0.3.0
borgreport [OPTIONS]
Summarize the status of multiple BorgBackup repositories in one report and export metrics
|
--env-dir <DIR> |
Directory to look for *.env files containing BORG_* env vars for a repository. Each file name represents a repository name in the report.
|
--env-inherit <REPOSITORY> |
Inherit BORG_* env vars for a single <REPOSITORY>. This allows to run ‘borgreport‘ after ‘borg‘ while reusing the environment.
|
--text-to <FILE> |
Write the text report to <FILE> instead of stdout.
|
--html-to <FILE> |
Write the HTML report to <FILE>.
|
--metrics-to <FILE> |
Write metrics to <FILE>.
|
--mail-to <ADDR> |
Send the report to <ADDR> using a ’sendmail’ compatible mail transfer agent.
|
--mail-from <ADDR> |
The mail sender <ADDR>. By default this is the current user@host
|
--no-progress |
Suppress all status updates during processing. By default this is auto-detected.
|
-h, --help |
Print help (see a summary with ’-h’)
|
-V, --version |
Print version
|
--glob-archives <GLOB> |
A list of space separated archive globs e.g. "etc-* srv-*" for archive names starting with etc- or srv-. (Default: "")
|
--check[=<true|false>] |
Enables the execution of ‘borg check‘. (Default: false)
|
--check-options <OPTS> |
A list of space separated raw borg options supplied to the ‘borg check‘ command
|
--borg-binary <FILE> |
Path to a local ’borg’ binary. (Default: borg)
|
--max-age-hours <HOURS> |
Threshold to warn, when the last backup is older than <HOURS>. (Default: 24)
Environment
variables are overwritten by the respective command line
option.
BORGREPORT_ENV_DIR <DIR>
Directory to look for *.env files containing BORG_* env vars for a repository. Each file name represents a repository name in the report.
BORGREPORT_ENV_INHERIT <REPOSITORY>
Inherit BORG_* env vars for a single <REPOSITORY>. This allows to run ‘borgreport‘ after ‘borg‘ while reusing the environment.
BORGREPORT_MAIL_TO <ADDR>
Send the report to <ADDR> using a ’sendmail’ compatible mail transfer agent.
BORGREPORT_MAIL_FROM <ADDR>
The mail sender <ADDR>. By default this is the current user@host
BORGREPORT_NO_PROGRESS <ADDR>
Suppress all status updates during processing. By default this is auto-detected.
BORGREPORT_TEXT_TO <FILE>
Write the text report to <FILE> instead of stdout.
BORGREPORT_HTML_TO <FORMAT>
Write the HTML report to <FILE>.
BORGREPORT_METRICS_TO <FILE>
Write metrics to <FILE>.
|
! |
You probably want to configure the following variables at repository level. Setting them globally will alter the default behavior for all repositories. |
BORGREPORT_GLOB_ARCHIVES <GLOB>
A list of space separated archive globs e.g. "etc-* srv-*" for archive names starting with etc- or srv-. (Default: "")
BORGREPORT_CHECK <true|false>
Enables the execution of ‘borg check‘. (Default: false)
BORGREPORT_CHECK_OPTIONS <OPTS>
A list of space separated raw borg options supplied to the ‘borg check‘ command
BORGREPORT_BORG_BINARY <FILE>
Path to a local ’borg’ binary. (Default: borg)
BORGREPORT_MAX_AGE_HOURS <HOURS>
Threshold to warn, when the last backup is older than <HOURS>. (Default: 24)
Written by Philipp Micheel <bbx0+borgreport@bitdevs.de>
Report bugs to <https://github.com/bbx0/borgreport/issues>.
Copyright ©
2024 Philipp Micheel License GPLv3+: GNU GPL version 3 or
later <http://gnu.org/licenses/gpl.html>
This is free software; you are free to change and
redistribute it. There is NO WARRANTY, to the extent
permitted by law.