aboutsummaryrefslogtreecommitdiff
path: root/backup.conf
blob: 297024f9132c2fb3864948fd371908a7eeeba599 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# -*- shell-script -*-
# This is a sample config file for the backup system. Tailor it to your
# needs and remove the line below:
echo >&2 "$0: WARNING: using default configuration boilerplate"

# This file is essentially a shell script defining variables used by
# the backup scripts. For a detailed information about it see backup.conf(5)
# To debug the configuration, run "backup --dry-run" and "restore --dry-run".
# For a detailed descriptions of these commands, see backup(1).

# When set, the prologue hook is called right before starting backup or
# restore. Similarly, the epilogue_hook is called immediately after
# finishing all operations.
# Use these hooks to perform any preliminary and/or cleanup jobs that
# might be necessary in your setup.
# When set, these variables must point to shell functions taking no
# arguments. The best place to define such functions is perhaps in this
# configuration file as well.
#
# By default, both variables are empty, i.e. no hooks are executed.

prologue_hook=
epilogue_hook=

##########################################################################
# Tar setup.
# 
# Tar setup variables configure invocation of tar.
#
##########################################################################

# Any additional options to pass to tar. Do not place tar operation
# switches (as -c, -t, etc.) here! These will be added automatically
# by appropriate scripts, depending on the operation being performed.
#
# By default this variable is empty (no additional options).
#
# In this example it is used to request bzip2 compression:
backup_tar_options="-j"

# Suffix for archive files.
# Default is "tar"
#
backup_suffix="tar.bz2"

# Directory where archive files are to be located. It's OK to specify
# a remote directory here, e.g. 10.10.0.1:/export/backup
#
# This variable must be set. Whatever directory it points to must already
# exist, the backup script won't create it.
backup_archive_dir=/var/run

# Directory where to store snapshot files. The files will be named as
# their archive counterparts, with the suffix ".db".
#
# This variable must be set
backup_snapshot_dir=/var/run

# Set this variable to a non-empty value if you wish backup procedures to
# be verbose.
backup_verbose=

##########################################################################
# Backup items.
#
# Backup items are symbolic names that identify abstract objects that
# need to be backed up (or restored). These must be valid shell variable
# names. For each backup item <name>, this configuration file defines a
# set of variables which determine what files to backup and what methods
# to use for that. Each such variable is named <name>_<variable>, where
# <name> is the item name, and <variable> is the variable name. The set
# of variables needed depends on the type of each particular item.
#
##########################################################################

# The following are sample entries. Be sure to edit them

# Define the list of items to back up.
# This variable must be set.
backup_items="dbdump system"

# For each item in $backup_items, at least its type (variable <item>_type)
# must be declared. The item type determines the mechanism used to backup
# and restore it. Valid item types are:
#
#  fs               back up a file system
#  postgres         back up a postgres database
#
# You may define additional types, if you need. To do so, create an executable
# file named <type>.sh in the directory @LIBDIR@/backup. See backup_type(5),
# for a detailed description.
# 

# Dump Postgres database "mydb".
# The <item>_database is the only variable required by type "postgres".
dbdump_type=postgres
dbdump_database="mydb"

# Back up directories in the file system.
# The "fs" type requires at least to variables:
#
#  <item>_dir specifies the directory (usually, but not necessarily a mount
#  point), under which the directories and files to be backed up are located.
#
#  <item>_files specifies a list of directories and/or files in that directory.

system_type=fs
system_dir="/"
system_files="etc var/spool"



Return to:

Send suggestions and report system problems to the System administrator.