1BACKUPNINJA.CONF(5) backupninja package BACKUPNINJA.CONF(5)
2
3
4
6 BACKUPNINJA.CONF - Configuration file(s) for backupninja (1).
7
8
10 /etc/backupninja.conf
11
13 backupninja.conf is the general configuration file. In this file you
14 can set the log level and change the default directory locations. You
15 can force a different general configuration file with "backupninja -f
16 /path/to/conf".
17
18
20 loglevel
21 How verbose to make the logs.
22 5 = Debugging messages
23 4 = Informational messages
24 3 = Warnings
25 2 = Errors
26 1 = Fatal errors
27
28
29 reportprom
30 Produce prometheus metrics of backup status. Requires
31 `prometheus-node-exporter` to be installed.
32
33
34 reportemail
35 Send a summary of the backup status to this email address.
36
37
38 reportsuccess
39 If set to 'yes', a report email will be generated even if all
40 modules reported success.
41
42
43 reportinfo
44 If set to 'yes', info messages from handlers will be sent into
45 the email.
46
47
48 reportwarning
49 If set to 'yes', a report email will be generated even if there
50 was no error.
51
52
53 reportspace
54 If set to 'yes', disk space usage will be included in the backup
55 email report.
56
57
58 reporthost
59 Where to rsync the backupninja.log to be aggregated in a nin‐
60 jareport.
61
62
63 reportuser
64 What user to connect to reporthost to sync the backupninja.log
65
66
67 reportdirectory
68 Where on the reporthost should the report go.
69
70
71 reportwrap
72 Number of columns the email report body should wrap to.
73
74
75 logfile
76 The path of the logfile.
77
78
79 configdirectory
80 The directory where all the backup action configuration files
81 live.
82
83
84 admingroup
85 Administration user group that is allowed to read/write configu‐
86 ration files in configdirectory.
87
88
89 scriptdirectory
90 Where backupninja handler scripts are found.
91
92
93 usecolors
94 If set to 'yes', use colors in the log file and debug output.
95
96
97 when When to process each configuration file. The value used here
98 will be applied for each configuration file. It is possible to
99 override this "when" in each configuration file, see also sec‐
100 tion "Scheduling" in backup.d(5).
101
102 For example:
103
104 when = sundays at 02:00
105 when = 30th at 22
106 when = 30 at 22:00
107 when = everyday at 01 <-- the default
108 when = Tuesday at 05:00
109
110 These values for 'when' are equivalent:
111
112 when = tuesday at 05:30
113 when = TUESDAYS at 05
114
115 These values for 'when' are invalid:
116
117 when = tuesday at 2am
118 when = tuesday at 2
119 when = tues at 02
120
121
122
123 DEFAULTS
124
125 loglevel = 4
126 reportemail = root
127 reportsuccess = yes
128 reportinfo = no
129 reportspace = no
130 reporthost =
131 reportuser = ninja
132 reportdirectory = /var/lib/backupninja/reports
133 reportwrap = 1000
134 logfile = /var/log/backupninja.log
135 configdirectory = /etc/backup.d
136 admingroup = root
137 scriptdirectory = /usr/share/backupninja
138 usecolors = yes
139 when = everyday at 01:00
140
141
143 backupninja(1), ninjahelper(1), backup.d(5),
144
146 BACKUPNINJA was written by the riseup.net collective.
147
148
149
150riseup November 19, 2005 BACKUPNINJA.CONF(5)