mirror of
https://0xacab.org/liberate/backupninja.git
synced 2024-09-18 19:32:24 +02:00
172 lines
3.7 KiB
Groff
172 lines
3.7 KiB
Groff
.\" Hey, EMACS: -*- nroff -*-
|
|
.\" First parameter, NAME, should be all caps
|
|
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
|
|
.\" other parameters are allowed: see man(7), man(1)
|
|
.TH BACKUPNINJA.CONF 5 "November 19, 2005" "riseup" "backupninja package"
|
|
.SH NAME
|
|
BACKUPNINJA.CONF \- Configuration file(s) for \fBbackupninja (1)\fP.
|
|
|
|
.\" Please adjust this date whenever revising the manpage.
|
|
.\"
|
|
.\" Some roff macros, for reference:
|
|
.\" .nh disable hyphenation
|
|
.\" .hy enable hyphenation
|
|
.\" .ad l left justify
|
|
.\" .ad b justify to both left and right margins
|
|
.\" .nf disable filling
|
|
.\" .fi enable filling
|
|
.\" .br insert line break
|
|
.\" .sp <n> insert n+1 empty lines
|
|
.\" for manpage-specific macros, see man(7)
|
|
.br
|
|
.SH SYNOPSIS
|
|
.B "/etc/backupninja.conf "
|
|
.br
|
|
.SH DESCRIPTION
|
|
.B backupninja.conf
|
|
is the general configuration file. In this file you can set the log level and change the default directory locations. You can force a different general configuration file with "backupninja \-f /path/to/conf".
|
|
|
|
.SH OPTIONS
|
|
|
|
.TP
|
|
.B loglevel
|
|
How verbose to make the logs.
|
|
.br
|
|
5 = Debugging messages
|
|
.br
|
|
4 = Informational messages
|
|
.br
|
|
3 = Warnings
|
|
.br
|
|
2 = Errors
|
|
.br
|
|
1 = Fatal errors
|
|
|
|
.TP
|
|
.B reportprom
|
|
Produce prometheus metrics of backup status. Requires `prometheus-node-exporter`
|
|
to be installed.
|
|
|
|
.TP
|
|
.B reportemail
|
|
Send a summary of the backup status to this email address.
|
|
|
|
.TP
|
|
.B reportsuccess
|
|
If set to 'yes', a report email will be generated even if all modules reported success.
|
|
|
|
.TP
|
|
.B reportinfo
|
|
If set to 'yes', info messages from handlers will be sent into the email.
|
|
|
|
.TP
|
|
.B reportwarning
|
|
If set to 'yes', a report email will be generated even if there was no error.
|
|
|
|
.TP
|
|
.B reportspace
|
|
If set to 'yes', disk space usage will be included in the backup email report.
|
|
|
|
.TP
|
|
.B reporthost
|
|
Where to rsync the backupninja.log to be aggregated in a ninjareport.
|
|
|
|
.TP
|
|
.B reportuser
|
|
What user to connect to reporthost to sync the backupninja.log
|
|
|
|
.TP
|
|
.B reportdirectory
|
|
Where on the reporthost should the report go.
|
|
|
|
.TP
|
|
.B reportwrap
|
|
Number of columns the email report body should wrap to.
|
|
|
|
.TP
|
|
.B logfile
|
|
The path of the logfile.
|
|
|
|
.TP
|
|
.B configdirectory
|
|
The directory where all the backup action configuration files live.
|
|
|
|
.TP
|
|
.B admingroup
|
|
Administration user group that is allowed to read/write configuration files in \fBconfigdirectory\fB.
|
|
|
|
.TP
|
|
.B scriptdirectory
|
|
Where backupninja handler scripts are found.
|
|
|
|
.TP
|
|
.B usecolors
|
|
If set to 'yes', use colors in the log file and debug output.
|
|
|
|
.TP
|
|
.B when
|
|
When to process each configuration file. The value used here will
|
|
be applied for each configuration file. It is possible to override
|
|
this "when" in each configuration file, see also section
|
|
"Scheduling" in backup.d(5).
|
|
|
|
For example:
|
|
|
|
when = sundays at 02:00
|
|
when = 30th at 22
|
|
when = 30 at 22:00
|
|
when = everyday at 01 <-- the default
|
|
when = Tuesday at 05:00
|
|
|
|
These values for 'when' are equivalent:
|
|
|
|
when = tuesday at 05:30
|
|
when = TUESDAYS at 05
|
|
|
|
These values for 'when' are invalid:
|
|
|
|
when = tuesday at 2am
|
|
when = tuesday at 2
|
|
when = tues at 02
|
|
|
|
.TP
|
|
.SH DEFAULTS
|
|
|
|
loglevel = 4
|
|
.br
|
|
reportemail = root
|
|
.br
|
|
reportsuccess = yes
|
|
.br
|
|
reportinfo = no
|
|
.br
|
|
reportspace = no
|
|
.br
|
|
reporthost =
|
|
.br
|
|
reportuser = ninja
|
|
.br
|
|
reportdirectory = /var/lib/backupninja/reports
|
|
.br
|
|
reportwrap = 1000
|
|
.br
|
|
logfile = /var/log/backupninja.log
|
|
.br
|
|
configdirectory = /etc/backup.d
|
|
.br
|
|
admingroup = root
|
|
.br
|
|
scriptdirectory = /usr/share/backupninja
|
|
.br
|
|
usecolors = yes
|
|
.br
|
|
when = everyday at 01:00
|
|
|
|
.SH SEE ALSO
|
|
.BR backupninja (1),
|
|
.BR ninjahelper (1),
|
|
.BR backup.d (5),
|
|
.br
|
|
.SH AUTHOR
|
|
BACKUPNINJA was written by the riseup.net collective.
|