| blob | 11717d6b792d2785761da1313f034523e7010327 |
1 '\" t
2 .\" Title: barman\&.conf
3 .\" Author: [see the "AUTHORS" section]
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5 .\" Date: 08/13/2014
6 .\" Manual: \ \&
7 .\" Source: \ \&
8 .\" Language: English
9 .\"
10 .TH "BARMAN.CONF" "4" "08/13/2014" "\ \&" "\ \&"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 barman\&.conf \- configuration file for Barman (backup and recovery manager for PostgreSQL)
32 .SH "CONFIGURATION FILE LOCATIONS"
33 .sp
34 The system\-level Barman configuration file is located at
35 .sp
36 .if n \{\
37 .RS 4
38 .\}
39 .nf
40 /etc/barman\&.conf
41 .fi
42 .if n \{\
43 .RE
44 .\}
45 .sp
46 or
47 .sp
48 .if n \{\
49 .RS 4
50 .\}
51 .nf
52 /etc/barman/barman\&.conf
53 .fi
54 .if n \{\
55 .RE
56 .\}
57 .sp
58 and is overridden on a per\-user level by
59 .sp
60 .if n \{\
61 .RS 4
62 .\}
63 .nf
64 $HOME/\&.barman\&.conf
65 .fi
66 .if n \{\
67 .RE
68 .\}
69 .SH "CONFIGURATION FILE SYNTAX"
70 .sp
71 The Barman configuration file is a plain ini file\&. There is a general section called [barman] and a section [servername] for each server you want to backup\&. Rows starting with ; are comments\&.
72 .SH "CONFIGURATION FILE DIRECTORY"
73 .sp
74 Barman supports the inclusion of multiple configuration files, through the configuration_files_directory option\&. Included files must contain only server specifications, not global configurations\&. If the value of configuration_files_directory is a directory, Barman reads all files with \&.conf extension that exist in that folder\&. For example, if you set it to /etc/barman\&.d, you can specify your PostgreSQL servers placing each section in a separate \&.conf file inside the /etc/barman\&.d folder\&.
75 .SH "OPTIONS"
76 .PP
77 \fBactive\fR
78 .RS 4
79 Ignored\&. Server\&.
80 .RE
81 .PP
82 \fBdescription\fR
83 .RS 4
84 A human readable description of a server\&. Server\&.
85 .RE
86 .PP
87 \fBssh_command\fR
88 .RS 4
89 Command used by Barman to login to the Postgres server via ssh\&. Server\&.
90 .RE
91 .PP
92 \fBconninfo\fR
93 .RS 4
94 Connection string used by Barman to connect to the Postgres server\&. Server\&.
95 .RE
96 .PP
97 \fBbasebackups_directory\fR
98 .RS 4
99 Directory where base backups will be placed\&. Global/Server\&.
100 .RE
101 .PP
102 \fBwals_directory\fR
103 .RS 4
104 Directory which contains WAL files\&. Global/Server\&.
105 .RE
106 .PP
107 \fBincoming_wals_directory\fR
108 .RS 4
109 Directory where incoming WAL files are archived into\&. Global/Server\&.
110 .RE
111 .PP
112 \fBlock_file\fR
113 .RS 4
114 Lock file for a backup in progress\&. Global/Server\&.
115 .RE
116 .PP
117 \fBlog_file\fR
118 .RS 4
119 Location of Barman\(cqs log file\&. Global\&.
120 .RE
121 .PP
122 \fBlog_level\fR
123 .RS 4
124 Level of logging (DEBUG, INFO, WARNING, ERROR, CRITICAL)\&. Global\&.
125 .RE
126 .PP
127 \fBcustom_compression_filter\fR
128 .RS 4
129 Compression algorithm applied to WAL files\&. Global/Server\&.
130 .RE
131 .PP
132 \fBcustom_decompression_filter\fR
133 .RS 4
134 Decompression algorithm applied to compressed WAL files; this must match the compression algorithm\&. Global/Server\&.
135 .RE
136 .PP
137 \fBpre_backup_script\fR
138 .RS 4
139 Hook script launched before a base backup\&. Global/Server\&.
140 .RE
141 .PP
142 \fBpost_backup_script\fR
143 .RS 4
144 Hook script launched after a base backup\&. Global/Server\&.
145 .RE
146 .PP
147 \fBpre_archive_script\fR
148 .RS 4
149 Hook script launched before a base backup\&. Global/Server\&.
150 .RE
151 .PP
152 \fBpost_archive_script\fR
153 .RS 4
154 Hook script launched after a base backup\&. Global/Server\&.
155 .RE
156 .PP
157 \fBminimum_redundancy\fR
158 .RS 4
159 Minimum number of backups to be retained\&. Default 0\&. Global/Server\&.
160 .RE
161 .PP
162 \fBretention_policy\fR
163 .RS 4
164 Policy for retention of periodical backups and archive logs\&. If left empty, retention policies are not enforced\&. For redundancy based retention policy use "REDUNDANCY i" (where i is an integer > 0 and defines the number of backups to retain)\&. For recovery window retention policy use "RECOVERY WINDOW OF i DAYS" or "RECOVERY WINDOW OF i WEEKS" or "RECOVERY WINDOW OF i MONTHS" where i is a positive integer representing, specifically, the number of days, weeks or months to retain your backups\&. For more detailed information, refer to the official documentation\&. Default value is empty\&. Global/Server\&.
165 .RE
166 .PP
167 \fBwal_retention_policy\fR
168 .RS 4
169 Policy for retention of archive logs (WAL files)\&. Currently only "MAIN" is available\&. Global/Server\&.
170 .RE
171 .PP
172 \fBretention_policy_mode\fR
173 .RS 4
174 Currently only "auto" is implemented\&. Global/Server\&.
175 .RE
176 .PP
177 \fBbandwidth_limit\fR
178 .RS 4
179 This option allows you to specify a maximum transfer rate in kilobytes per second\&. A value of zero specifies no limit (default)\&. Global/Server\&.
180 .RE
181 .PP
182 \fBtablespace_bandwidth_limit\fR
183 .RS 4
184 This option allows you to specify a maximum transfer rate in kilobytes per second, by specifying a comma separated list of tablespaces (pairs TBNAME:BWLIMIT)\&. A value of zero specifies no limit (default)\&. Global/Server\&.
185 .RE
186 .PP
187 \fBimmediate_checkpoint\fR
188 .RS 4
189 This option allows you to control the way PostgreSQL handles checkpoint at the start of the backup\&. If set to
190 false
191 (default), Postgres will wait for a checkpoint to happen before allowing the start of the backup\&. If set to
192 true, an immediate checkpoint is requested\&. Global/Server\&.
193 .RE
194 .PP
195 \fBnetwork_compression\fR
196 .RS 4
197 This option allows you to enable data compression for network transfers\&. If set to
198 false
199 (default), no compression is used\&. If set to
200 true, compression is enabled, reducing network usage\&. Global/Server\&.
201 .RE
202 .PP
203 \fBbackup_options\fR
204 .RS 4
205 This option allows you to enable to control the way PostgreSQL handles backups: If set to
206 exclusive_backup
207 (default),
208 barman backup
209 executes backup operations using the standard exclusive backup approach (technically through pg_start_backup/pg_stop_backup)\&. If set to
210 concurrent_backup, Barman requires the
211 pgespresso
212 module to be installed on the PostgreSQL server (this allows to perform backup from a standby server)\&. Global/Server\&.
213 .RE
214 .PP
215 \fBlast_backup_maximum_age\fR
216 .RS 4
217 This option identifies a time frame that must contain the latest backup\&. If the latest backup is older than the time frame, barman check command will report an error to the user\&. If empty (default), latest backup is always considered valid\&. Syntax for this option is: "i (DAYS | WEEKS | MONTHS)" where i is a integer greater than zero, representing the number of days | weeks | months of the time frame\&. Global/Server\&.
218 .RE
219 .PP
220 \fBbasebackup_retry_times\fR
221 .RS 4
222 Number of retries of data copy during base backup after an error\&. Positive integer, default 0\&. Global/Server\&.
223 .RE
224 .PP
225 \fBbasebackup_retry_sleep\fR
226 .RS 4
227 Number of seconds of wait after a failed copy, before retrying Positive integer, default 30\&. Global/Server\&.
228 .RE
229 .SH "HOOK SCRIPTS"
230 .sp
231 The script definition is passed to a shell and can return any exit code\&.
232 .sp
233 The shell environment will contain the following variables:
234 .PP
235 BARMAN_CONFIGURATION
236 .RS 4
237 configuration file used by barman
238 .RE
239 .PP
240 BARMAN_ERROR
241 .RS 4
242 error message, if any (only for the
243 \fIpost\fR
244 phase)
245 .RE
246 .PP
247 BARMAN_PHASE
248 .RS 4
250 \fIpre\fR
251 or
252 \fIpost\fR
253 .RE
254 .PP
255 BARMAN_SERVER
256 .RS 4
257 name of the server
258 .RE
259 .sp
260 Backup scripts specific variables:
261 .PP
262 BARMAN_BACKUP_DIR
263 .RS 4
264 backup destination directory
265 .RE
266 .PP
267 BARMAN_BACKUP_ID
268 .RS 4
269 ID of the backup
270 .RE
271 .PP
272 BARMAN_PREVIOUS_ID
273 .RS 4
274 ID of the previous backup (if present)
275 .RE
276 .PP
277 BARMAN_STATUS
278 .RS 4
279 status of the backup
280 .RE
281 .PP
282 BARMAN_VERSION
283 .RS 4
284 version of Barman
285 .RE
286 .sp
287 Archive scripts specific variables:
288 .PP
289 BARMAN_SEGMENT
290 .RS 4
291 name of the WAL file
292 .RE
293 .PP
294 BARMAN_FILE
295 .RS 4
296 full path of the WAL file
297 .RE
298 .PP
299 BARMAN_SIZE
300 .RS 4
301 size of the WAL file
302 .RE
303 .PP
304 BARMAN_TIMESTAMP
305 .RS 4
306 WAL file timestamp
307 .RE
308 .PP
309 BARMAN_COMPRESSION
310 .RS 4
311 type of compression used for the WAL file
312 .RE
313 .sp
314 No check is performed on the exit code of the script\&. The result will be simply written in the log file\&.
315 .SH "EXAMPLE"
316 .sp
317 Example of the configuration file:
318 .sp
319 .if n \{\
320 .RS 4
321 .\}
322 .nf
323 [barman]
324 ; Main directory
325 barman_home = /var/lib/barman
327 ; System user
328 barman_user = barman
330 ; Log location
331 log_file = /var/log/barman/barman\&.log
333 ; Default compression level
334 ;compression = gzip
336 ; \*(Aqmain\*(Aq PostgreSQL Server configuration
337 [main]
338 ; Human readable description
339 description = "Main PostgreSQL Database"
341 ; SSH options
342 ssh_command = ssh postgres@pg
344 ; PostgreSQL connection string
345 conninfo = host=pg user=postgres
347 ; Minimum number of required backups (redundancy)
348 minimum_redundancy = 1
350 ; Retention policy (based on redundancy)
351 retention_policy = REDUNDANCY 2
352 .fi
353 .if n \{\
354 .RE
355 .\}
356 .SH "AUTHORS"
357 .sp
358 In alphabetical order:
359 .sp
360 .RS 4
361 .ie n \{\
362 \h'-04'\(bu\h'+03'\c
363 .\}
364 .el \{\
365 .sp -1
366 .IP \(bu 2.3
367 .\}
368 Gabriele Bartolini <gabriele\&.bartolini@2ndquadrant\&.it> (core team, project leader)
369 .RE
370 .sp
371 .RS 4
372 .ie n \{\
373 \h'-04'\(bu\h'+03'\c
374 .\}
375 .el \{\
376 .sp -1
377 .IP \(bu 2.3
378 .\}
379 Giuseppe Broccolo <giuseppe\&.broccolo@2ndquadrant\&.it> (core team, QA/testing)
380 .RE
381 .sp
382 .RS 4
383 .ie n \{\
384 \h'-04'\(bu\h'+03'\c
385 .\}
386 .el \{\
387 .sp -1
388 .IP \(bu 2.3
389 .\}
390 Giulio Calacoci <giulio\&.calacoci@2ndquadrant\&.it> (core team, developer)
391 .RE
392 .sp
393 .RS 4
394 .ie n \{\
395 \h'-04'\(bu\h'+03'\c
396 .\}
397 .el \{\
398 .sp -1
399 .IP \(bu 2.3
400 .\}
401 Francesco Canovai <francesco\&.canovai@2ndquadrant\&.it> (core team, QA/testing)
402 .RE
403 .sp
404 .RS 4
405 .ie n \{\
406 \h'-04'\(bu\h'+03'\c
407 .\}
408 .el \{\
409 .sp -1
410 .IP \(bu 2.3
411 .\}
412 Marco Nenciarini <marco\&.nenciarini@2ndquadrant\&.it> (core team, team leader)
413 .RE
414 .sp
415 Past contributors:
416 .sp
417 .RS 4
418 .ie n \{\
419 \h'-04'\(bu\h'+03'\c
420 .\}
421 .el \{\
422 .sp -1
423 .IP \(bu 2.3
424 .\}
425 Carlo Ascani
426 .RE
427 .SH "RESOURCES"
428 .sp
429 .RS 4
430 .ie n \{\
431 \h'-04'\(bu\h'+03'\c
432 .\}
433 .el \{\
434 .sp -1
435 .IP \(bu 2.3
436 .\}
437 Homepage:
438 http://www\&.pgbarman\&.org/
439 .RE
440 .sp
441 .RS 4
442 .ie n \{\
443 \h'-04'\(bu\h'+03'\c
444 .\}
445 .el \{\
446 .sp -1
447 .IP \(bu 2.3
448 .\}
449 Documentation:
450 http://docs\&.pgbarman\&.org/
451 .RE
452 .SH "COPYING"
453 .sp
454 Barman is the exclusive property of 2ndQuadrant Italia and its code is distributed under GNU General Public License v3\&.
455 .sp
456 Copyright \(co 2011\-2014 2ndQuadrant Italia (Devise\&.IT S\&.r\&.l\&.) \- http://www\&.2ndQuadrant\&.it/\&.