Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 325 lines (250 sloc) 10.742 kB
8a97ae0 new confkeys
sukria authored
1 # Backup Manager Configuration File
674201f release 0.5.8b
sukria authored
2 #
8a97ae0 new confkeys
sukria authored
3 # * This configuration file is divided into sections.
4 # The 'global' section is mandatory, every keys defined in
5 # this section are inherited in the other sections.
c89a6b2 2005-10-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
6 # * There is one section per "backup method", you have to
7 # fill the section of the chosen method.
674201f release 0.5.8b
sukria authored
8 #
9 ##############################################################
10
11 ##############################################################
e00ad0c yeah
sukria authored
12 # Repository - everything about where archives are
8a97ae0 new confkeys
sukria authored
13 #############################################################
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
14
8a97ae0 new confkeys
sukria authored
15 # Where to store the archives
16 export BM_REPOSITORY_ROOT="/var/archives"
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
17
8a97ae0 new confkeys
sukria authored
18 # For security reasons, the archive repository and the generated
19 # archives will be readable/writable by a given user/group.
026f318 Version 0.6.1
sukria authored
20 # This is recommended to set this to true.
21 export BM_REPOSITORY_SECURE="true"
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
22
8a97ae0 new confkeys
sukria authored
23 # The repository will be readable/writable only by a specific
026f318 Version 0.6.1
sukria authored
24 # user:group pair if BM_REPOSITORY_SECURE is set to true.
8a97ae0 new confkeys
sukria authored
25 export BM_REPOSITORY_USER="root"
26 export BM_REPOSITORY_GROUP="root"
7a80abf Now every backup methods are implemented in lib/backup-methods.sh
sukria authored
27
8a97ae0 new confkeys
sukria authored
28 ##############################################################
29 # Archives - let's focus on the precious tarballs...
30 ##############################################################
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
31
8a97ae0 new confkeys
sukria authored
32 # Number of days we have to keep an archive (Time To Live)
33 export BM_ARCHIVE_TTL="5"
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
34
674201f release 0.5.8b
sukria authored
35 # Do you want to replace duplicates by symlinks?
8a97ae0 new confkeys
sukria authored
36 # (archive-DAY is a duplicate of archive-(DAY - 1) if they
674201f release 0.5.8b
sukria authored
37 # are both the same size).
026f318 Version 0.6.1
sukria authored
38 export BM_ARCHIVE_PURGEDUPS="true"
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
39
1ce9cd9 Syncing the CVS repo with the very last source tree...
sukria authored
40 # Prefix of every archive on that box (default is HOSTNAME)
8a97ae0 new confkeys
sukria authored
41 export BM_ARCHIVE_PREFIX="$HOSTNAME"
42
43 # The backup method to use.
72f36d8 Added examples for the svn backup method.
sukria authored
44 # Available methods are:
45 # - tarball
f878234 2005-11-10 Alexis Sukrieh <sukria@sukria.net>
sukria authored
46 # - tarball-incremental
72f36d8 Added examples for the svn backup method.
sukria authored
47 # - mysql
48 # - svn
49 # - pipe
a0b9eb9 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
50 # - none
51 # If you don't want to use any backup method (you don't want to
52 # build archives) then choose "none"
8a97ae0 new confkeys
sukria authored
53 export BM_ARCHIVE_METHOD="tarball"
d29639d Initial revision
sukria authored
54
8a97ae0 new confkeys
sukria authored
55 ##############################################################
56 # Section "TARBALL"
57 # - Backup method: tarball
58 #############################################################
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
59
8a97ae0 new confkeys
sukria authored
60 # Archive filename format
61 # long : host-full-path-to-folder.tar.gz
62 # short : parentfolder.tar.gz
63 export BM_TARBALL_NAMEFORMAT="long"
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
64
8a97ae0 new confkeys
sukria authored
65 # Type of archives, available types are tar, tar.gz, tar.bz2, zip.
66 export BM_TARBALL_FILETYPE="tar.gz"
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
67
8a97ae0 new confkeys
sukria authored
68 # Do you want to dereference the files pointed by symlinks ?
026f318 Version 0.6.1
sukria authored
69 # enter true or false (true can lead to huge archives, be careful).
70 export BM_TARBALL_DUMPSYMLINKS="false"
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
71
8a97ae0 new confkeys
sukria authored
72 # Directories you want to backup as tarballs (separated by spaces)
73 export BM_TARBALL_DIRECTORIES="/etc /home"
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
74
1ce9cd9 Syncing the CVS repo with the very last source tree...
sukria authored
75 # Files to exclude when generating tarballs
8a97ae0 new confkeys
sukria authored
76 export BM_TARBALL_BLACKLIST=""
d29639d Initial revision
sukria authored
77
78 ##############################################################
f878234 2005-11-10 Alexis Sukrieh <sukria@sukria.net>
sukria authored
79 # The tarball-incremental method uses the same keys as the
80 # tarball method, plus two others.
81 #############################################################
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
82
f878234 2005-11-10 Alexis Sukrieh <sukria@sukria.net>
sukria authored
83 # Which frequency to use for the master tarball?
84 # possible values: weekly, monthly
85 export BM_TARBALLINC_MASTERDATETYPE="weekly"
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
86
f878234 2005-11-10 Alexis Sukrieh <sukria@sukria.net>
sukria authored
87 # Number of the day, in the BM_TARBALLINC_MASTERDATETYPE frequency
88 # when master tarballs should be made
89 export BM_TARBALLINC_MASTERDATEVALUE="1"
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
90
f878234 2005-11-10 Alexis Sukrieh <sukria@sukria.net>
sukria authored
91 # Examples: you want to make maser tarballs every friday:
92 # BM_TARBALLINC_MASTERDATETYPE="weekly"
93 # BM_TARBALLINC_MASTERDATEVALUE="5"
94 #
95 # Or every first day of the month:
96 # BM_TARBALLINC_MASTERDATETYPE="monthly"
97 # BM_TARBALLINC_MASTERDATEVALUE="1"
98
99 ##############################################################
e00ad0c yeah
sukria authored
100 # Backup method: MYSQl
8a97ae0 new confkeys
sukria authored
101 #############################################################
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
102
c89a6b2 2005-10-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
103 # This method is dedicated to MySQL databases.
104 # You should not use the tarball method for backing up database
e00ad0c yeah
sukria authored
105 # directories or you may have corrupted archives.
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
106 # Enter here the list of databases to backup.
107 # Wildcard: __ALL__ (will dump all the databases in one archive)
108 export BM_MYSQL_DATABASES="__ALL__"
109
110 # The best way to produce MySQL dump is done by using the "--opt" switch
111 # of mysqldump. This make the dump directly usable with mysql (add the drop table
112 # statements), lock the tables during the dump and other things.
113 # This is recommended for full-clean-safe backups, but needs a
114 # privileged user (for the lock permissions).
115 export BM_MYSQL_SAFEDUMPS="true"
116
e00ad0c yeah
sukria authored
117 # The user who is allowed to read every databases filled in BM_MYSQL_DATABASES
118 export BM_MYSQL_ADMINLOGIN="root"
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
119
e00ad0c yeah
sukria authored
120 # its password
121 export BM_MYSQL_ADMINPASS=""
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
122
c89a6b2 2005-10-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
123 # the host where the database is
e00ad0c yeah
sukria authored
124 export BM_MYSQL_HOST="localhost"
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
125
e00ad0c yeah
sukria authored
126 # the port where MySQL listen to on the host
127 export BM_MYSQL_PORT="3306"
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
128
e00ad0c yeah
sukria authored
129 # which compression format to use? (gzip or bzip2)
130 export BM_MYSQL_FILETYPE="bzip2"
131
8a97ae0 new confkeys
sukria authored
132 ##############################################################
72f36d8 Added examples for the svn backup method.
sukria authored
133 # Backup method: svn
134 #############################################################
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
135
72f36d8 Added examples for the svn backup method.
sukria authored
136 # Absolute paths to the svn repositories to archive
137 export BM_SVN_REPOSITORIES=""
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
138
72f36d8 Added examples for the svn backup method.
sukria authored
139 # You can compress the resulting XML files
140 # Supported compressor are: bzip2 and gzip
141 export BM_SVN_COMPRESSWITH="bzip2"
142
143 ##############################################################
8a97ae0 new confkeys
sukria authored
144 # Backup method: pipe
145 #############################################################
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
146
b29dd5c 2005-10-23 Alexis Sukrieh <sukria@sukria.net>
sukria authored
147 # The "pipe" method is a generic way of making archive.
148 # Its concept is simple, for every kind of archive you want
149 # to make, you give: a command which will send output on stdout,
150 # a name, a file type and optionnaly, a compressor.
151
152 # Be careful, this feature uses arrays!
153 declare -a BM_PIPE_COMMAND
154 declare -a BM_PIPE_NAME
155 declare -a BM_PIPE_FILETYPE
156 declare -a BM_PIPE_COMPRESS
157
158 # You can virtually implement whatever backup scenario you like
159 # with this method.
160 #
161 # The resulting archives will be named like this:
162 # $BM_ARCHIVE_PREFIX-$BM_PIPE_NAME.$DATE.$BM_PIPE_FILETYPE
163 # If you specified a BM_PIPE_COMPRESS option, the resulting filename
164 # will change as expected (eg, .gz if "gzip").
165 #
166 # Here are a couple of examples for using this method:
167
168 # Archive a remote MySQL database through SSH:
7febcad 2005-10-24 Alexis Sukrieh <sukria@sukria.net>
sukria authored
169 # BM_PIPE_COMMAND[0]="ssh host -c \"mysqldump -ufoo -pbar base\""
170 # BM_PIPE_NAME[0]="base"
171 # BM_PIPE_FILETYPE[0]="sql"
172 # BM_PIPE_COMPRESS[0]="gzip"
b29dd5c 2005-10-23 Alexis Sukrieh <sukria@sukria.net>
sukria authored
173 # This will make somthing like: localhost-base.20050421.sql.gz
174
175 # Archive a specific directory, on a remote server through SSH:
7febcad 2005-10-24 Alexis Sukrieh <sukria@sukria.net>
sukria authored
176 # BM_PIPE_COMMAND[0]="ssh host -c \"tar -c -z /home/user\""
177 # BM_PIPE_NAME[0]="host.home.user"
178 # BM_PIPE_FILETYPE[0]="tar.gz"
179 # BM_PIPE_COMPRESS[0]=""
b29dd5c 2005-10-23 Alexis Sukrieh <sukria@sukria.net>
sukria authored
180 # This will make somthing like: localhost-host.home.user.20050421.tar.gz
e00ad0c yeah
sukria authored
181
7febcad 2005-10-24 Alexis Sukrieh <sukria@sukria.net>
sukria authored
182 export BM_PIPE_COMMAND
183 export BM_PIPE_NAME
184 export BM_PIPE_FILETYPE
185 export BM_PIPE_COMPRESS
e00ad0c yeah
sukria authored
186
8a97ae0 new confkeys
sukria authored
187 ##############################################################
188 # Section "UPLOAD"
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
189 # You can upload archives to remote hosts with different
190 # methods.
d29639d Initial revision
sukria authored
191 #############################################################
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
192
a0b9eb9 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
193 # Which method to use for uploading archives, you can put
194 # multiple methods here.
195 # Available methods:
196 # - scp
197 # - ftp
198 # - rsync
199 # - none
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
200
a0b9eb9 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
201 # If you don't want to use any upload method (you don't want to
202 # upload files to remote hosts) then choose "none"
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
203 export BM_UPLOAD_METHOD=""
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
204
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
205 # where to upload (global to all methods)
8a97ae0 new confkeys
sukria authored
206 export BM_UPLOAD_HOSTS=""
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
207
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
208 # Where to put archives on the remote hosts (global)
209 export BM_UPLOAD_DESTINATION=""
d29639d Initial revision
sukria authored
210
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
211 ##############################################################
212 # The SSH method
213 #############################################################
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
214
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
215 # the user to use for the SSH connections/transfers
216 export BM_UPLOAD_SSH_USER=""
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
217
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
218 # The private key to use for opening the connection
219 export BM_UPLOAD_SSH_KEY=""
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
220
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
221 # specific ssh hosts
222 export BM_UPLOAD_SSH_HOSTS=""
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
223
376ff5b 2005-12-19 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
224 # port to use for SSH connections (leave blank for default one)
225 export BM_UPLOAD_SSH_PORT=""
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
226
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
227 # destination for ssh uploads (overrides BM_UPLOAD_DESTINATION)
228 export BM_UPLOAD_SSH_DESTINATION=""
1ce9cd9 Syncing the CVS repo with the very last source tree...
sukria authored
229
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
230 ##############################################################
231 # The FTP method
232 #############################################################
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
233
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
234 # the user to use for the FTP connections/transfers
235 export BM_UPLOAD_FTP_USER=""
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
236
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
237 # the FTP user's password
238 export BM_UPLOAD_FTP_PASSWORD=""
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
239
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
240 # FTP specific rmeote hosts
241 export BM_UPLOAD_FTP_HOSTS=""
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
242
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
243 # purge archives on remote hosts before uploading?
026f318 Version 0.6.1
sukria authored
244 export BM_UPLOAD_FTP_PURGE="false"
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
245
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
246 # destination for FTP uploads (overrides BM_UPLOAD_DESTINATION)
247 export BM_UPLOAD_FTP_DESTINATION=""
d29639d Initial revision
sukria authored
248
249
0950922 - Changed configuration keys according to bug #10
jimmy authored
250 ##############################################################
00dfa77 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
251 # The RSYNC method
0950922 - Changed configuration keys according to bug #10
jimmy authored
252 #############################################################
253
254 # Which directories should be backuped with rsync
b340bce 2005-12-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
255 export BM_UPLOAD_RSYNC_DIRECTORIES=""
0950922 - Changed configuration keys according to bug #10
jimmy authored
256
47614ef rsync is now an upload method.
jimmy authored
257 # Destination for rsync uploads (overrides BM_UPLOAD_DESTINATION)
258 export BM_UPLOAD_RSYNC_DESTINATION=""
259
0950922 - Changed configuration keys according to bug #10
jimmy authored
260 # The list of remote hosts, if you want to enable the upload
261 # system, just put some remote hosts here (fqdn or IPs)
47614ef rsync is now an upload method.
jimmy authored
262 # Leave it empty if you want to use the hosts that are defined in
263 # BM_UPLOAD_HOSTS
264 export BM_UPLOAD_RSYNC_HOSTS=""
265
266 # Do you want to dereference the files pointed by symlinks?
026f318 Version 0.6.1
sukria authored
267 # enter true or false (true can lead to huge archives, be careful).
268 export BM_UPLOAD_RSYNC_DUMPSYMLINKS="false"
0950922 - Changed configuration keys according to bug #10
jimmy authored
269
d29639d Initial revision
sukria authored
270 ##############################################################
8a97ae0 new confkeys
sukria authored
271 # Section "BURNING"
083cb8b 2005-12-09 Alexis Sukrieh,,, <set EMAIL_ADDRESS environment variable>
sukria authored
272 # - Automatic CDR/CDRW/DVDR burning
d29639d Initial revision
sukria authored
273 #############################################################
274
083cb8b 2005-12-09 Alexis Sukrieh,,, <set EMAIL_ADDRESS environment variable>
sukria authored
275 # the method of burning archives from the list :
276 # - DVD : burn archives on a DVD media.
277 #
278 # - CDRW : blank the CDRW and burn the whole
279 # ARCHIVES_REPOSITORY or only
280 # the generated archives.
281 #
282 # - CDR : burn the whole ARCHIVES_REPOSITORY or
283 # only the generated archives.
284 # - none : disable the burning system
285
286 export BM_BURNING_METHOD="none"
d29639d Initial revision
sukria authored
287
674201f release 0.5.8b
sukria authored
288 # When the CD is burnt, it is possible to check every file's
289 # MD5 checksum to see if the CD is not corrupted.
026f318 Version 0.6.1
sukria authored
290 export BM_BURNING_CHKMD5="true"
d29639d Initial revision
sukria authored
291
674201f release 0.5.8b
sukria authored
292 # The device to use for mounting the cdrom
d29639d Initial revision
sukria authored
293 export BM_BURNING_DEVICE="/dev/cdrom"
294
674201f release 0.5.8b
sukria authored
295 # You can force cdrecord to use a specific device
296 # Fill in the full path to the device to use or even
297 # e.g. BM_BURNING_DEVFORCED="/dev/cdrom"
298 # If none specified, the default cdrecord device will be used.
299 export BM_BURNING_DEVFORCED=""
e90e822 2006-01-05 Alexis Sukrieh <sukria@backup-manager.org>
sukria authored
300
79c645c 2005-11-08 Alexis Sukrieh <sukria@sukria.net>
sukria authored
301 # enter here the max size of your media
302 # (usal sizes are 4200 for DVD media and 700 or 800 for CDR media)
d29639d Initial revision
sukria authored
303 export BM_BURNING_MAXSIZE="700"
304
305
306 ##############################################################
307 # Advanced settings, use this with care.
308 #############################################################
309
7a80abf Now every backup methods are implemented in lib/backup-methods.sh
sukria authored
310 # Every output made can be sent to syslog
026f318 Version 0.6.1
sukria authored
311 # set this to "true" or "false"
312 export BM_LOGGER="true"
7a80abf Now every backup methods are implemented in lib/backup-methods.sh
sukria authored
313
314 # You can choose which facility to use
315 export BM_LOGGER_FACILITY="user"
316
d29639d Initial revision
sukria authored
317 # Enter here some shell script.
318 # It will be executed before the first action of backup-manager.
319 export BM_PRE_BACKUP_COMMAND=""
320
321 # Enter here some shell script.
322 # It will be executed after the last action of backup-manager.
323 export BM_POST_BACKUP_COMMAND=""
324
Something went wrong with that request. Please try again.