Various changes, including changes in 2.1.1 and 2.1.2 releases.
[BackupPC.git] / conf / config.pl
1 #============================================================= -*-perl-*-
2 #
3 # Configuration file for BackupPC.
4 #
5 # DESCRIPTION
6 #
7 #   This is the main configuration file for BackupPC.
8 #
9 #   This file must be valid perl source, so make sure the punctuation,
10 #   quotes, and other syntax are valid.
11 #
12 #   This file is read by BackupPC at startup, when a HUP (-1) signal
13 #   is sent to BackupPC and also at each wakeup time whenever the
14 #   modification time of this file changes.
15 #
16 #   The configuration parameters are divided into four general groups.
17 #   The first group (general server configuration) provides general
18 #   configuration for BackupPC.  The next two groups describe what
19 #   to backup, when to do it, and how long to keep it.  The fourth
20 #   group are settings for the CGI http interface.
21 #
22 #   Configuration settings can also be specified on a per-PC basis.
23 #   Simply put the relevant settings in a config.pl file in the
24 #   PC's backup directory (ie: in __TOPDIR__/pc/hostName).
25 #   All configuration settings in the second, third and fourth
26 #   groups can be overridden by the per-PC config.pl file.
27 #
28 # AUTHOR
29 #   Craig Barratt  <cbarratt@users.sourceforge.net>
30 #
31 # COPYRIGHT
32 #   Copyright (C) 2001-2003  Craig Barratt
33 #
34 #   See http://backuppc.sourceforge.net.
35 #
36 #========================================================================
37
38 ###########################################################################
39 # General server configuration
40 ###########################################################################
41 #
42 # Host name on which the BackupPC server is running.
43 #
44 $Conf{ServerHost} = '';
45
46 #
47 # TCP port number on which the BackupPC server listens for and accepts
48 # connections.  Normally this should be disabled (set to -1).  The TCP
49 # port is only needed if apache runs on a different machine from BackupPC.
50 # In that case, set this to any spare port number over 1024 (eg: 2359).
51 # If you enable the TCP port, make sure you set $Conf{ServerMesgSecret}
52 # too!
53 #
54 $Conf{ServerPort} = -1;
55
56 #
57 # Shared secret to make the TCP port secure.  Set this to a hard to guess
58 # string if you enable the TCP port (ie: $Conf{ServerPort} > 0).
59 #
60 # To avoid possible attacks via the TCP socket interface, every client
61 # message is protected by an MD5 digest. The MD5 digest includes four
62 # items:
63 #   - a seed that is sent to the client when the connection opens
64 #   - a sequence number that increments for each message
65 #   - a shared secret that is stored in $Conf{ServerMesgSecret}
66 #   - the message itself.
67 #
68 # The message is sent in plain text preceded by the MD5 digest.  A
69 # snooper can see the plain-text seed sent by BackupPC and plain-text
70 # message from the client, but cannot construct a valid MD5 digest since
71 # the secret $Conf{ServerMesgSecret} is unknown.  A replay attack is
72 # not possible since the seed changes on a per-connection and
73 # per-message basis.
74 #
75 $Conf{ServerMesgSecret} = '';
76
77 #
78 # PATH setting for BackupPC.  An explicit value is necessary
79 # for taint mode.  Value shouldn't matter too much since
80 # all execs use explicit paths.  However, taint mode in perl
81 # will complain if this directory is world writable.
82 #
83 $Conf{MyPath} = '/bin';
84
85 #
86 # Permission mask for directories and files created by BackupPC.
87 # Default value prevents any access from group other, and prevents
88 # group write.
89 #
90 $Conf{UmaskMode} = 027;
91
92 #
93 # Times at which we wake up, check all the PCs, and schedule necessary
94 # backups.  Times are measured in hours since midnight.  Can be
95 # fractional if necessary (eg: 4.25 means 4:15am).
96 #
97 # If the hosts you are backing up are always connected to the network
98 # you might have only one or two wakeups each night.  This will keep
99 # the backup activity after hours.  On the other hand, if you are backing
100 # up laptops that are only intermittently connected to the network you
101 # will want to have frequent wakeups (eg: hourly) to maximized the chance
102 # that each laptop is backed up.
103 #
104 # Examples:
105 #     $Conf{WakeupSchedule} = [22.5];         # once per day at 10:30 pm.
106 #     $Conf{WakeupSchedule} = [1..23];        # every hour except midnight
107 #     $Conf{WakeupSchedule} = [2,4,6,8,10,12,14,16,18,20,22];  # every 2 hours
108 #
109 # The default value is every hour except midnight.
110 #
111 # The first entry of $Conf{WakeupSchedule} is when BackupPC_nightly
112 # is run.  No other backups can run while BackupPC_nightly is
113 # running.  You might want to re-arrange the entries in
114 # $Conf{WakeupSchedule} (they don't have to be ascending) so that
115 # the first entry is when you want BackupPC_nightly to run
116 # (eg: when you don't expect a lot of regular backups to run).
117 #
118 $Conf{WakeupSchedule} = [1..23];
119
120 #
121 # Maximum number of simultaneous backups to run.  If there
122 # are no user backup requests then this is the maximum number
123 # of simultaneous backups.
124 #
125 $Conf{MaxBackups} = 4;
126
127 #
128 # Additional number of simultaneous backups that users can run.
129 # As many as $Conf{MaxBackups} + $Conf{MaxUserBackups} requests can
130 # run at the same time.
131 #
132 $Conf{MaxUserBackups} = 4;
133
134 #
135 # Maximum number of pending link commands. New backups will only be
136 # started if there are no more than $Conf{MaxPendingCmds} plus
137 # $Conf{MaxBackups} number of pending link commands, plus running jobs.
138 # This limit is to make sure BackupPC doesn't fall too far behind in
139 # running BackupPC_link commands.
140 #
141 $Conf{MaxPendingCmds} = 10;
142
143 #
144 # How many BackupPC_nightly processes to run in parallel.
145 #
146 # Each night, at the first wakeup listed in $Conf{WakeupSchedule},
147 # BackupPC_nightly is run.  Its job is to remove unneeded files
148 # in the pool, ie: files that only have one link.  To avoid race
149 # conditions, BackupPC_nightly runs only when there are no backups
150 # running, and no backups will start while it runs.
151 #
152 # So to reduce the elapsed time, you might want to increase this
153 # setting to run several BackupPC_nightly processes in parallel
154 # (eg: 4, or even 8).
155 #
156 $Conf{MaxBackupPCNightlyJobs} = 2;
157
158 #
159 # How many days (runs) it takes BackupPC_nightly to traverse the
160 # entire pool.  Normally this is 1, which means every night it runs,
161 # it does traverse the entire pool removing unused pool files.
162 #
163 # Other valid values are 2, 4, 8, 16.  This causes BackupPC_nightly to
164 # traverse 1/2, 1/4, 1/8 or 1/16th of the pool each night, meaning it
165 # takes 2, 4, 8 or 16 days to completely traverse the pool.  The
166 # advantage is that each night the running time of BackupPC_nightly
167 # is reduced roughly in proportion, since the total job is split
168 # over multiple days.  The disadvantage is that unused pool files
169 # take longer to get deleted, which will slightly increase disk
170 # usage.
171 #
172 # Note that even when $Conf{BackupPCNightlyPeriod} > 1, BackupPC_nightly
173 # still runs every night.  It just does less work each time it runs.
174 #
175 # Examples:
176 #
177 #    $Conf{BackupPCNightlyPeriod} = 1;   # entire pool is checked every night
178 #
179 #    $Conf{BackupPCNightlyPeriod} = 2;   # two days to complete pool check
180 #                                        # (different half each night)
181 #
182 #    $Conf{BackupPCNightlyPeriod} = 4;   # four days to complete pool check
183 #                                        # (different quarter each night)
184 #
185 $Conf{BackupPCNightlyPeriod} = 1;
186
187 #
188 # Maximum number of log files we keep around in log directory.
189 # These files are aged nightly.  A setting of 14 means the log
190 # directory will contain about 2 weeks of old log files, in
191 # particular at most the files LOG, LOG.0, LOG.1, ... LOG.13
192 # (except today's LOG, these files will have a .z extension if
193 # compression is on).
194 #
195 # If you decrease this number after BackupPC has been running for a
196 # while you will have to manually remove the older log files.
197 #
198 $Conf{MaxOldLogFiles} = 14;
199
200 #
201 # Full path to the df command.  Security caution: normal users
202 # should not allowed to write to this file or directory.
203 #
204 $Conf{DfPath} = '/bin/df';
205
206 #
207 # Command to run df.  The following variables are substituted at run-time:
208 #
209 #   $dfPath      path to df ($Conf{DfPath})
210 #   $topDir      top-level BackupPC data directory
211 #
212 $Conf{DfCmd} = '$dfPath $topDir';
213
214 #
215 # Full path to various commands for archiving
216 #
217
218 $Conf{SplitPath} = '/usr/bin/split';
219 $Conf{ParPath}   = '/usr/bin/par2';
220 $Conf{CatPath}   = '/bin/cat';
221 $Conf{GzipPath}  = '/bin/gzip';
222 $Conf{Bzip2Path} = '/usr/bin/bzip2';
223
224 #
225 # Maximum threshold for disk utilization on the __TOPDIR__ filesystem.
226 # If the output from $Conf{DfPath} reports a percentage larger than
227 # this number then no new regularly scheduled backups will be run.
228 # However, user requested backups (which are usually incremental and
229 # tend to be small) are still performed, independent of disk usage.
230 # Also, currently running backups will not be terminated when the disk
231 # usage exceeds this number.
232 #
233 $Conf{DfMaxUsagePct} = 95;
234
235 #
236 # How long BackupPC_trashClean sleeps in seconds between each check
237 # of the trash directory.  Once every 5 minutes should be reasonable.
238 #
239 $Conf{TrashCleanSleepSec} = 300;
240
241 #
242 # List of DHCP address ranges we search looking for PCs to backup.
243 # This is an array of hashes for each class C address range.
244 # This is only needed if hosts in the conf/hosts file have the
245 # dhcp flag set.
246 #
247 # Examples:
248 #    # to specify 192.10.10.20 to 192.10.10.250 as the DHCP address pool
249 #    $Conf{DHCPAddressRanges} = [
250 #        {
251 #            ipAddrBase => '192.10.10',
252 #            first => 20,
253 #            last  => 250,
254 #        },
255 #    ];
256 #    # to specify two pools (192.10.10.20-250 and 192.10.11.10-50)
257 #    $Conf{DHCPAddressRanges} = [
258 #        {
259 #            ipAddrBase => '192.10.10',
260 #            first => 20,
261 #            last  => 250,
262 #        },
263 #        {
264 #            ipAddrBase => '192.10.11',
265 #            first => 10,
266 #            last  => 50,
267 #        },
268 #    ];
269 #
270 $Conf{DHCPAddressRanges} = [];
271
272 #
273 # These configuration settings aren't used by BackupPC, but simply
274 # remember a few settings used by configure.pl during installation.
275 # These are used by configure.pl when upgrading to new versions of
276 # BackupPC.
277 #
278 $Conf{BackupPCUser} = '';
279 $Conf{CgiDir}       = '';
280 $Conf{InstallDir}   = '';
281
282 #
283 # Whether BackupPC and the CGI script BackupPC_Admin verify that they
284 # are really running as user $Conf{BackupPCUser}.  If this flag is set
285 # and the effective user id (euid) differs from $Conf{BackupPCUser}
286 # then both scripts exit with an error.  This catches cases where
287 # BackupPC might be accidently started as root or the wrong user,
288 # or if the CGI script is not installed correctly.
289 #
290 $Conf{BackupPCUserVerify} = 1;
291
292 #
293 # Maximum number of hardlinks supported by the $TopDir file system
294 # that BackupPC uses.  Most linux or unix file systems should support
295 # at least 32000 hardlinks per file, or 64000 in other cases.  If a pool
296 # file already has this number of hardlinks, a new pool file is created
297 # so that new hardlinks can be accommodated.  This limit will only
298 # be hit if an identical file appears at least this number of times
299 # across all the backups.
300 #
301 $Conf{HardLinkMax} = 31999;
302
303 #
304 # Advanced option for asking BackupPC to load additional perl modules.
305 # Can be a list (array ref) of module names to load at startup.
306 #
307 $Conf{PerlModuleLoad}     = undef;
308
309 #
310 # Path to init.d script and command to use that script to start the
311 # server from the CGI interface.  The following variables are substituted
312 # at run-time:
313 #
314 #   $sshPath           path to ssh ($Conf{SshPath})
315 #   $serverHost        same as $Conf{ServerHost}
316 #   $serverInitdPath   path to init.d script ($Conf{ServerInitdPath})
317 #
318 # Example:
319 #
320 # $Conf{ServerInitdPath}     = '/etc/init.d/backuppc';
321 # $Conf{ServerInitdStartCmd} = '$sshPath -q -x -l root $serverHost'
322 #                            . ' $serverInitdPath start'
323 #                            . ' < /dev/null >& /dev/null';
324 #
325 $Conf{ServerInitdPath} = '';
326 $Conf{ServerInitdStartCmd} = '';
327
328
329 ###########################################################################
330 # What to backup and when to do it
331 # (can be overridden in the per-PC config.pl)
332 ###########################################################################
333 #
334 # Minimum period in days between full backups. A full dump will only be
335 # done if at least this much time has elapsed since the last full dump,
336 # and at least $Conf{IncrPeriod} days has elapsed since the last
337 # successful dump.
338 #
339 # Typically this is set slightly less than an integer number of days. The
340 # time taken for the backup, plus the granularity of $Conf{WakeupSchedule}
341 # will make the actual backup interval a bit longer.
342 #
343 # There are two special values for $Conf{FullPeriod}:
344 #
345 #   -1   Don't do any regular backups on this machine.  Manually
346 #        requested backups (via the CGI interface) will still occur.
347 #
348 #   -2   Don't do any backups on this machine.  Manually requested
349 #        backups (via the CGI interface) will be ignored.
350 #
351 # These special settings are useful for a client that is no longer
352 # being backed up (eg: a retired machine), but you wish to keep the
353 # last backups available for browsing or restoring to other machines.
354 #
355 $Conf{FullPeriod} = 6.97;
356
357 #
358 # Minimum period in days between incremental backups (a user requested
359 # incremental backup will be done anytime on demand).
360 #
361 # Typically this is set slightly less than an integer number of days. The
362 # time taken for the backup, plus the granularity of $Conf{WakeupSchedule}
363 # will make the actual backup interval a bit longer.
364 #
365 $Conf{IncrPeriod} = 0.97;
366
367 #
368 # Number of full backups to keep.  Must be >= 1.
369 #
370 # In the steady state, each time a full backup completes successfully
371 # the oldest one is removed.  If this number is decreased, the
372 # extra old backups will be removed.
373 #
374 # If filling of incremental dumps is off the oldest backup always
375 # has to be a full (ie: filled) dump.  This might mean one or two
376 # extra full dumps are kept until the oldest incremental backups expire.
377 #
378 # Exponential backup expiry is also supported.  This allows you to specify:
379 #
380 #   - num fulls to keep at intervals of 1 * $Conf{FullPeriod}, followed by
381 #   - num fulls to keep at intervals of 2 * $Conf{FullPeriod},
382 #   - num fulls to keep at intervals of 4 * $Conf{FullPeriod},
383 #   - num fulls to keep at intervals of 8 * $Conf{FullPeriod},
384 #   - num fulls to keep at intervals of 16 * $Conf{FullPeriod},
385 #
386 # and so on.  This works by deleting every other full as each expiry
387 # boundary is crossed.
388 #
389 # Exponential expiry is specified using an array for $Conf{FullKeepCnt}:
390 #
391 #   $Conf{FullKeepCnt} = [4, 2, 3];
392 #
393 # Entry #n specifies how many fulls to keep at an interval of
394 # 2^n * $Conf{FullPeriod} (ie: 1, 2, 4, 8, 16, 32, ...).
395 #
396 # The example above specifies keeping 4 of the most recent full backups
397 # (1 week interval) two full backups at 2 week intervals, and 3 full
398 # backups at 4 week intervals, eg:
399 #
400 #    full 0 19 weeks old   \
401 #    full 1 15 weeks old    >---  3 backups at 4 * $Conf{FullPeriod}
402 #    full 2 11 weeks old   / 
403 #    full 3  7 weeks old   \____  2 backups at 2 * $Conf{FullPeriod}
404 #    full 4  5 weeks old   /
405 #    full 5  3 weeks old   \
406 #    full 6  2 weeks old    \___  4 backups at 1 * $Conf{FullPeriod}
407 #    full 7  1 week old     /
408 #    full 8  current       /
409 #
410 # On a given week the spacing might be less than shown as each backup
411 # ages through each expiry period.  For example, one week later, a
412 # new full is completed and the oldest is deleted, giving:
413 #
414 #    full 0 16 weeks old   \
415 #    full 1 12 weeks old    >---  3 backups at 4 * $Conf{FullPeriod}
416 #    full 2  8 weeks old   / 
417 #    full 3  6 weeks old   \____  2 backups at 2 * $Conf{FullPeriod}
418 #    full 4  4 weeks old   /
419 #    full 5  3 weeks old   \
420 #    full 6  2 weeks old    \___  4 backups at 1 * $Conf{FullPeriod}
421 #    full 7  1 week old     /
422 #    full 8  current       /
423 #
424 # You can specify 0 as a count (except in the first entry), and the
425 # array can be as long as you wish.  For example:
426 #
427 #   $Conf{FullKeepCnt} = [4, 0, 4, 0, 0, 2];
428 #
429 # This will keep 10 full dumps, 4 most recent at 1 * $Conf{FullPeriod},
430 # followed by 4 at an interval of 4 * $Conf{FullPeriod} (approx 1 month
431 # apart), and then 2 at an interval of 32 * $Conf{FullPeriod} (approx
432 # 7-8 months apart).
433 #
434 # Example: these two settings are equivalent and both keep just
435 # the four most recent full dumps:
436 #
437 #    $Conf{FullKeepCnt} = 4;
438 #    $Conf{FullKeepCnt} = [4];
439 #
440 $Conf{FullKeepCnt} = 1;
441
442 #
443 # Very old full backups are removed after $Conf{FullAgeMax} days.  However,
444 # we keep at least $Conf{FullKeepCntMin} full backups no matter how old
445 # they are.
446 #
447 # Note that $Conf{FullAgeMax} will be increased to $Conf{FullKeepCnt}
448 # times $Conf{FullPeriod} if $Conf{FullKeepCnt} specifies enough
449 # full backups to exceed $Conf{FullAgeMax}.
450 #
451 $Conf{FullKeepCntMin} = 1;
452 $Conf{FullAgeMax}     = 90;
453
454 #
455 # Number of incremental backups to keep.  Must be >= 1.
456 #
457 # In the steady state, each time an incr backup completes successfully
458 # the oldest one is removed.  If this number is decreased, the
459 # extra old backups will be removed.
460 #
461 $Conf{IncrKeepCnt} = 6;
462
463 #
464 # Very old incremental backups are removed after $Conf{IncrAgeMax} days.
465 # However, we keep at least $Conf{IncrKeepCntMin} incremental backups no
466 # matter how old they are.
467 #
468 $Conf{IncrKeepCntMin} = 1;
469 $Conf{IncrAgeMax}     = 30;
470
471 #
472 # A failed full backup is saved as a partial backup.  The rsync
473 # XferMethod can take advantage of the partial full when the next
474 # backup is run. This parameter sets the age of the partial full
475 # in days: if the partial backup is older than this number of
476 # days, then rsync will ignore (not use) the partial full when
477 # the next backup is run.  If you set this to a negative value
478 # then no partials will be saved.  If you set this to 0, partials
479 # will be saved, but will not be used by the next backup.
480 #
481 # The default setting of 3 days means that a partial older than
482 # 3 days is ignored when the next full backup is done.
483 #
484 $Conf{PartialAgeMax} = 3;
485
486 #
487 # Whether incremental backups are filled.  "Filling" means that the
488 # most recent full (or filled) dump is merged into the new incremental
489 # dump using hardlinks.  This makes an incremental dump look like a
490 # full dump.  Prior to v1.03 all incremental backups were filled.
491 # In v1.4.0 and later the default is off.
492 #
493 # BackupPC, and the cgi interface in particular, do the right thing on
494 # un-filled incremental backups.  It will correctly display the merged
495 # incremental backup with the most recent filled backup, giving the
496 # un-filled incremental backups a filled appearance.  That means it
497 # invisible to the user whether incremental dumps are filled or not.
498 #
499 # Filling backups takes a little extra disk space, and it does cost
500 # some extra disk activity for filling, and later removal.  Filling
501 # is no longer useful, since file mangling and compression doesn't
502 # make a filled backup very useful. It's likely the filling option
503 # will be removed from future versions: filling will be delegated to
504 # the display and extraction of backup data.
505 #
506 # If filling is off, BackupPC makes sure that the oldest backup is
507 # a full, otherwise the following incremental backups will be
508 # incomplete.  This might mean an extra full backup has to be
509 # kept until the following incremental backups expire.
510 #
511 # The default is off.  You can turn this on or off at any
512 # time without affecting existing backups.
513 #
514 $Conf{IncrFill} = 0;
515
516 #
517 # Number of restore logs to keep.  BackupPC remembers information about
518 # each restore request.  This number per client will be kept around before
519 # the oldest ones are pruned.
520 #
521 # Note: files/dirs delivered via Zip or Tar downloads don't count as
522 # restores.  Only the first restore option (where the files and dirs
523 # are written to the host) count as restores that are logged.
524 #
525 $Conf{RestoreInfoKeepCnt} = 10;
526
527 #
528 # Number of archive logs to keep.  BackupPC remembers information
529 # about each archive request.  This number per archive client will
530 # be kept around before the oldest ones are pruned.
531 #
532 $Conf{ArchiveInfoKeepCnt} = 10;
533
534 #
535 # List of directories or files to backup.  If this is defined, only these
536 # directories or files will be backed up.
537 #
538 # For Smb, only one of $Conf{BackupFilesExclude} and $Conf{BackupFilesOnly}
539 # can be specified per share. If both are set for a particular share, then
540 # $Conf{BackupFilesOnly} takes precedence and $Conf{BackupFilesExclude}
541 # is ignored.
542 #
543 # This can be set to a string, an array of strings, or, in the case
544 # of multiple shares, a hash of strings or arrays.  A hash is used
545 # to give a list of directories or files to backup for each share
546 # (the share name is the key).  If this is set to just a string or
547 # array, and $Conf{SmbShareName} contains multiple share names, then
548 # the setting is assumed to apply all shares.
549 #
550 # Examples:
551 #    $Conf{BackupFilesOnly} = '/myFiles';
552 #    $Conf{BackupFilesOnly} = ['/myFiles'];     # same as first example
553 #    $Conf{BackupFilesOnly} = ['/myFiles', '/important'];
554 #    $Conf{BackupFilesOnly} = {
555 #       'c' => ['/myFiles', '/important'],      # these are for 'c' share
556 #       'd' => ['/moreFiles', '/archive'],      # these are for 'd' share
557 #    };
558 #
559 $Conf{BackupFilesOnly} = undef;
560
561 #
562 # List of directories or files to exclude from the backup.  For Smb,
563 # only one of $Conf{BackupFilesExclude} and $Conf{BackupFilesOnly}
564 # can be specified per share.  If both are set for a particular share,
565 # then $Conf{BackupFilesOnly} takes precedence and
566 # $Conf{BackupFilesExclude} is ignored.
567 #
568 # This can be set to a string, an array of strings, or, in the case
569 # of multiple shares, a hash of strings or arrays.  A hash is used
570 # to give a list of directories or files to exclude for each share
571 # (the share name is the key).  If this is set to just a string or
572 # array, and $Conf{SmbShareName} contains multiple share names, then
573 # the setting is assumed to apply to all shares.
574 #
575 # The exact behavior is determined by the underlying transport program,
576 # smbclient or tar.  For smbclient the exlclude file list is passed into
577 # the X option.  Simple shell wild-cards using "*" or "?" are allowed.
578 #
579 # For tar, if the exclude file contains a "/" it is assumed to be anchored
580 # at the start of the string.  Since all the tar paths start with "./",
581 # BackupPC prepends a "." if the exclude file starts with a "/".  Note
582 # that GNU tar version >= 1.13.7 is required for the exclude option to
583 # work correctly.  For linux or unix machines you should add
584 # "/proc" to $Conf{BackupFilesExclude} unless you have specified
585 # --one-file-system in $Conf{TarClientCmd} or --one-file-system in
586 # $Conf{RsyncArgs}.  Also, for tar, do not use a trailing "/" in
587 # the directory name: a trailing "/" causes the name to not match
588 # and the directory will not be excluded.
589 #
590 # Users report that for smbclient you should specify a directory
591 # followed by "/*", eg: "/proc/*", instead of just "/proc".
592 #
593 # Examples:
594 #    $Conf{BackupFilesExclude} = '/temp';
595 #    $Conf{BackupFilesExclude} = ['/temp'];     # same as first example
596 #    $Conf{BackupFilesExclude} = ['/temp', '/winnt/tmp'];
597 #    $Conf{BackupFilesExclude} = {
598 #       'c' => ['/temp', '/winnt/tmp'],         # these are for 'c' share
599 #       'd' => ['/junk', '/dont_back_this_up'], # these are for 'd' share
600 #    };
601 #
602 $Conf{BackupFilesExclude} = undef;
603
604 #
605 # PCs that are always or often on the network can be backed up after
606 # hours, to reduce PC, network and server load during working hours. For
607 # each PC a count of consecutive good pings is maintained. Once a PC has
608 # at least $Conf{BlackoutGoodCnt} consecutive good pings it is subject
609 # to "blackout" and not backed up during hours and days specified by
610 # $Conf{BlackoutPeriods}.
611 #
612 # To allow for periodic rebooting of a PC or other brief periods when a
613 # PC is not on the network, a number of consecutive bad pings is allowed
614 # before the good ping count is reset. This parameter is
615 # $Conf{BlackoutBadPingLimit}.
616 #
617 # Note that bad and good pings don't occur with the same interval. If a
618 # machine is always on the network, it will only be pinged roughly once
619 # every $Conf{IncrPeriod} (eg: once per day). So a setting for
620 # $Conf{BlackoutGoodCnt} of 7 means it will take around 7 days for a
621 # machine to be subject to blackout. On the other hand, if a ping is
622 # failed, it will be retried roughly every time BackupPC wakes up, eg,
623 # every one or two hours. So a setting for $Conf{BlackoutBadPingLimit} of
624 # 3 means that the PC will lose its blackout status after 3-6 hours of
625 # unavailability.
626 #
627 # To disable the blackout feature set $Conf{BlackoutGoodCnt} to a negative
628 # value.  A value of 0 will make all machines subject to blackout.  But
629 # if you don't want to do any backups during the day it would be easier
630 # to just set $Conf{WakeupSchedule} to a restricted schedule.
631 #
632 $Conf{BlackoutBadPingLimit} = 3;
633 $Conf{BlackoutGoodCnt}      = 7;
634
635 #
636 # One or more blackout periods can be specified.  If a client is
637 # subject to blackout then no regular (non-manual) backups will
638 # be started during any of these periods.  hourBegin and hourEnd
639 # specify hours fro midnight and weekDays is a list of days of
640 # the week where 0 is Sunday, 1 is Monday etc.
641 #
642 # For example:
643 #
644 #    $Conf{BlackoutPeriods} = [
645 #       {
646 #           hourBegin =>  7.0,
647 #           hourEnd   => 19.5,
648 #           weekDays  => [1, 2, 3, 4, 5],
649 #       },
650 #    ];
651 #
652 # specifies one blackout period from 7:00am to 7:30pm local time
653 # on Mon-Fri.
654 #
655 # The blackout period can also span midnight by setting
656 # hourBegin > hourEnd, eg:
657 #
658 #    $Conf{BlackoutPeriods} = [
659 #       {
660 #           hourBegin =>  7.0,
661 #           hourEnd   => 19.5,
662 #           weekDays  => [1, 2, 3, 4, 5],
663 #       },
664 #       {
665 #           hourBegin => 23,
666 #           hourEnd   =>  5,
667 #           weekDays  => [5, 6],
668 #       },
669 #    ];
670 #
671 # This specifies one blackout period from 7:00am to 7:30pm local time
672 # on Mon-Fri, and a second period from 11pm to 5am on Friday and
673 # Saturday night.
674 #
675 $Conf{BlackoutPeriods} = [
676     {
677         hourBegin =>  7.0,
678         hourEnd   => 19.5,
679         weekDays  => [1, 2, 3, 4, 5],
680     },
681 ];
682
683 #
684 # A backup of a share that has zero files is considered fatal. This is
685 # used to catch miscellaneous Xfer errors that result in no files being
686 # backed up.  If you have shares that might be empty (and therefore an
687 # empty backup is valid) you should set this flag to 0.
688 #
689 $Conf{BackupZeroFilesIsFatal} = 1;
690
691 ###########################################################################
692 # How to backup a client
693 # (can be overridden in the per-PC config.pl)
694 ###########################################################################
695 #
696 # What transport method to use to backup each host.  If you have
697 # a mixed set of WinXX and linux/unix hosts you will need to override
698 # this in the per-PC config.pl.
699 #
700 # The valid values are:
701 #
702 #   - 'smb':     backup and restore via smbclient and the SMB protocol.
703 #                Easiest choice for WinXX.
704 #
705 #   - 'rsync':   backup and restore via rsync (via rsh or ssh).
706 #                Best choice for linux/unix.  Good choice also for WinXX.
707 #
708 #   - 'rsyncd':  backup and restore via rsync daemon on the client.
709 #                Best choice for linux/unix if you have rsyncd running on
710 #                the client.  Good choice also for WinXX.
711 #
712 #   - 'tar':    backup and restore via tar, tar over ssh, rsh or nfs.
713 #               Good choice for linux/unix.
714 #
715 #   - 'archive': host is a special archive host.  Backups are not done.
716 #                An archive host is used to archive other host's backups
717 #                to permanent media, such as tape, CDR or DVD.
718 #               
719 #
720 $Conf{XferMethod} = 'smb';
721
722 #
723 # Level of verbosity in Xfer log files.  0 means be quiet, 1 will give
724 # will give one line per file, 2 will also show skipped files on
725 # incrementals, higher values give more output.
726 #
727 $Conf{XferLogLevel} = 1;
728
729 #
730 # Name of the host share that is backed up when using SMB.  This can be a
731 # string or an array of strings if there are multiple shares per host.
732 # Examples:
733 #
734 #   $Conf{SmbShareName} = 'c';          # backup 'c' share
735 #   $Conf{SmbShareName} = ['c', 'd'];   # backup 'c' and 'd' shares
736 #
737 # This setting only matters if $Conf{XferMethod} = 'smb'.
738 #
739 $Conf{SmbShareName} = 'C$';
740
741 #
742 # Smbclient share user name.  This is passed to smbclient's -U argument.
743 #
744 # This setting only matters if $Conf{XferMethod} = 'smb'.
745 #
746 $Conf{SmbShareUserName} = '';
747
748 #
749 # Smbclient share password.  This is passed to smbclient via its PASSWD
750 # environment variable.  There are several ways you can tell BackupPC
751 # the smb share password.  In each case you should be very careful about
752 # security.  If you put the password here, make sure that this file is
753 # not readable by regular users!  See the "Setting up config.pl" section
754 # in the documentation for more information.
755 #
756 # This setting only matters if $Conf{XferMethod} = 'smb'.
757 #
758 $Conf{SmbSharePasswd} = '';
759
760 #
761 # Full path for smbclient. Security caution: normal users should not
762 # allowed to write to this file or directory.
763 #
764 # smbclient is from the Samba distribution. smbclient is used to
765 # actually extract the incremental or full dump of the share filesystem
766 # from the PC.
767 #
768 # This setting only matters if $Conf{XferMethod} = 'smb'.
769 #
770 $Conf{SmbClientPath} = '/usr/bin/smbclient';
771
772 #
773 # Command to run smbclient for a full dump.
774 # This setting only matters if $Conf{XferMethod} = 'smb'.
775 #
776 # The following variables are substituted at run-time:
777 #
778 #    $smbClientPath   same as $Conf{SmbClientPath}
779 #    $host            host to backup/restore
780 #    $hostIP          host IP address
781 #    $shareName       share name
782 #    $userName        user name
783 #    $fileList        list of files to backup (based on exclude/include)
784 #    $I_option        optional -I option to smbclient
785 #    $X_option        exclude option (if $fileList is an exclude list)
786 #    $timeStampFile   start time for incremental dump
787 #
788 $Conf{SmbClientFullCmd} = '$smbClientPath \\\\$host\\$shareName'
789             . ' $I_option -U $userName -E -N -d 1'
790             . ' -c tarmode\\ full -Tc$X_option - $fileList';
791
792 #
793 # Command to run smbclient for an incremental dump.
794 # This setting only matters if $Conf{XferMethod} = 'smb'.
795 #
796 # Same variable substitutions are applied as $Conf{SmbClientFullCmd}.
797 #
798 $Conf{SmbClientIncrCmd} = '$smbClientPath \\\\$host\\$shareName'
799             . ' $I_option -U $userName -E -N -d 1'
800             . ' -c tarmode\\ full -TcN$X_option $timeStampFile - $fileList';
801
802 #
803 # Command to run smbclient for a restore.
804 # This setting only matters if $Conf{XferMethod} = 'smb'.
805 #
806 # Same variable substitutions are applied as $Conf{SmbClientFullCmd}.
807 #
808 # If your smb share is read-only then direct restores will fail.
809 # You should set $Conf{SmbClientRestoreCmd} to undef and the
810 # corresponding CGI restore option will be removed.
811 #
812 $Conf{SmbClientRestoreCmd} = '$smbClientPath \\\\$host\\$shareName'
813             . ' $I_option -U $userName -E -N -d 1'
814             . ' -c tarmode\\ full -Tx -';
815
816 #
817 # Which host directories to backup when using tar transport.  This can be a
818 # string or an array of strings if there are multiple directories to
819 # backup per host.  Examples:
820 #
821 #   $Conf{TarShareName} = '/';                  # backup everything
822 #   $Conf{TarShareName} = '/home';              # only backup /home
823 #   $Conf{TarShareName} = ['/home', '/src'];    # backup /home and /src
824 #
825 # The fact this parameter is called 'TarShareName' is for historical
826 # consistency with the Smb transport options.  You can use any valid
827 # directory on the client: there is no need for it to correspond to
828 # any Smb share or device mount point.
829 #
830 # Note also that you can also use $Conf{BackupFilesOnly} to specify
831 # a specific list of directories to backup.  It's more efficient to
832 # use this option instead of $Conf{TarShareName} since a new tar is
833 # run for each entry in $Conf{TarShareName}.
834 #
835 # On the other hand, if you add --one-file-system to $Conf{TarClientCmd}
836 # you can backup each file system separately, which makes restoring one
837 # bad file system easier.  In this case you would list all of the mount
838 # points here, since you can't get the same result with
839 # $Conf{BackupFilesOnly}:
840 #
841 #     $Conf{TarShareName} = ['/', '/var', '/data', '/boot'];
842 #
843 # This setting only matters if $Conf{XferMethod} = 'tar'.
844 #
845 $Conf{TarShareName} = '/';
846
847 #
848 # Full command to run tar on the client.  GNU tar is required.  You will
849 # need to fill in the correct paths for ssh2 on the local host (server)
850 # and GNU tar on the client.  Security caution: normal users should not
851 # allowed to write to these executable files or directories.
852 #
853 # See the documentation for more information about setting up ssh2 keys.
854 #
855 # If you plan to use NFS then tar just runs locally and ssh2 is not needed.
856 # For example, assuming the client filesystem is mounted below /mnt/hostName,
857 # you could use something like:
858 #
859 #    $Conf{TarClientCmd} = '$tarPath -c -v -f - -C /mnt/$host/$shareName'
860 #                        . ' --totals';
861 #
862 # In the case of NFS or rsh you need to make sure BackupPC's privileges
863 # are sufficient to read all the files you want to backup.  Also, you
864 # will probably want to add "/proc" to $Conf{BackupFilesExclude}.
865 #
866 # The following variables are substituted at run-time:
867 #
868 #   $host        host name
869 #   $hostIP      host's IP address
870 #   $incrDate    newer-than date for incremental backups
871 #   $shareName   share name to backup (ie: top-level directory path)
872 #   $fileList    specific files to backup or exclude
873 #   $tarPath     same as $Conf{TarClientPath}
874 #   $sshPath     same as $Conf{SshPath}
875 #
876 # If a variable is followed by a "+" it is shell escaped.  This is
877 # necessary for the command part of ssh or rsh, since it ends up
878 # getting passed through the shell.
879 #
880 # This setting only matters if $Conf{XferMethod} = 'tar'.
881 #
882 $Conf{TarClientCmd} = '$sshPath -q -x -n -l root $host'
883                     . ' env LC_ALL=C $tarPath -c -v -f - -C $shareName+'
884                     . ' --totals';
885
886 #
887 # Extra tar arguments for full backups.  Several variables are substituted at
888 # run-time.  See $Conf{TarClientCmd} for the list of variable substitutions.
889 #
890 # If you are running tar locally (ie: without rsh or ssh) then remove the
891 # "+" so that the argument is no longer shell escaped.
892 #
893 # This setting only matters if $Conf{XferMethod} = 'tar'.
894 #
895 $Conf{TarFullArgs} = '$fileList+';
896
897 #
898 # Extra tar arguments for incr backups.  Several variables are substituted at
899 # run-time.  See $Conf{TarClientCmd} for the list of variable substitutions.
900 #
901 # Note that GNU tar has several methods for specifying incremental backups,
902 # including:
903 #
904 #   --newer-mtime $incrDate+
905 #          This causes a file to be included if the modification time is
906 #          later than $incrDate (meaning its contents might have changed).
907 #          But changes in the ownership or modes will not qualify the
908 #          file to be included in an incremental.
909 #
910 #   --newer=$incrDate+
911 #          This causes the file to be included if any attribute of the
912 #          file is later than $incrDate, meaning either attributes or
913 #          the modification time.  This is the default method.  Do
914 #          not use --atime-preserve in $Conf{TarClientCmd} above,
915 #          otherwise resetting the atime (access time) counts as an
916 #          attribute change, meaning the file will always be included
917 #          in each new incremental dump.
918 #
919 # If you are running tar locally (ie: without rsh or ssh) then remove the
920 # "+" so that the argument is no longer shell escaped.
921 #
922 # This setting only matters if $Conf{XferMethod} = 'tar'.
923 #
924 $Conf{TarIncrArgs} = '--newer=$incrDate+ $fileList+';
925
926 #
927 # Full command to run tar for restore on the client.  GNU tar is required.
928 # This can be the same as $Conf{TarClientCmd}, with tar's -c replaced by -x
929 # and ssh's -n removed.
930 #
931 # See $Conf{TarClientCmd} for full details.
932 #
933 # This setting only matters if $Conf{XferMethod} = "tar".
934 #
935 # If you want to disable direct restores using tar, you should set
936 # $Conf{TarClientRestoreCmd} to undef and the corresponding CGI
937 # restore option will be removed.
938 #
939 $Conf{TarClientRestoreCmd} = '$sshPath -q -x -l root $host'
940                    . ' env LC_ALL=C $tarPath -x -p --numeric-owner --same-owner'
941                    . ' -v -f - -C $shareName+';
942
943 #
944 # Full path for tar on the client. Security caution: normal users should not
945 # allowed to write to this file or directory.
946 #
947 # This setting only matters if $Conf{XferMethod} = 'tar'.
948 #
949 $Conf{TarClientPath} = '/bin/tar';
950
951 #
952 # Path to rsync executable on the client
953 #
954 $Conf{RsyncClientPath} = '/bin/rsync';
955
956 #
957 # Full command to run rsync on the client machine.  The following variables
958 # are substituted at run-time:
959 #
960 #        $host           host name being backed up
961 #        $hostIP         host's IP address
962 #        $shareName      share name to backup (ie: top-level directory path)
963 #        $rsyncPath      same as $Conf{RsyncClientPath}
964 #        $sshPath        same as $Conf{SshPath}
965 #        $argList        argument list, built from $Conf{RsyncArgs},
966 #                        $shareName, $Conf{BackupFilesExclude} and
967 #                        $Conf{BackupFilesOnly}
968 #
969 # This setting only matters if $Conf{XferMethod} = 'rsync'.
970 #
971 $Conf{RsyncClientCmd} = '$sshPath -q -x -l root $host $rsyncPath $argList+';
972
973 #
974 # Full command to run rsync for restore on the client.  The following
975 # variables are substituted at run-time:
976 #
977 #        $host           host name being backed up
978 #        $hostIP         host's IP address
979 #        $shareName      share name to backup (ie: top-level directory path)
980 #        $rsyncPath      same as $Conf{RsyncClientPath}
981 #        $sshPath        same as $Conf{SshPath}
982 #        $argList        argument list, built from $Conf{RsyncArgs},
983 #                        $shareName, $Conf{BackupFilesExclude} and
984 #                        $Conf{BackupFilesOnly}
985 #
986 # This setting only matters if $Conf{XferMethod} = 'rsync'.
987 #
988 $Conf{RsyncClientRestoreCmd} = '$sshPath -q -x -l root $host $rsyncPath $argList+';
989
990 #
991 # Share name to backup.  For $Conf{XferMethod} = "rsync" this should
992 # be a file system path, eg '/' or '/home'.
993 #
994 # For $Conf{XferMethod} = "rsyncd" this should be the name of the module
995 # to backup (ie: the name from /etc/rsynd.conf).
996 #
997 # This can also be a list of multiple file system paths or modules.
998 # For example, by adding --one-file-system to $Conf{RsyncArgs} you
999 # can backup each file system separately, which makes restoring one
1000 # bad file system easier.  In this case you would list all of the mount
1001 # points:
1002 #
1003 #     $Conf{RsyncShareName} = ['/', '/var', '/data', '/boot'];
1004 #
1005 $Conf{RsyncShareName} = '/';
1006
1007 #
1008 # Rsync daemon port on the client, for $Conf{XferMethod} = "rsyncd".
1009 #
1010 $Conf{RsyncdClientPort} = 873;
1011
1012 #
1013 # Rsync daemon user name on client, for $Conf{XferMethod} = "rsyncd".
1014 # The user name and password are stored on the client in whatever file
1015 # the "secrets file" parameter in rsyncd.conf points to
1016 # (eg: /etc/rsyncd.secrets).
1017 #
1018 $Conf{RsyncdUserName} = '';
1019
1020 #
1021 # Rsync daemon user name on client, for $Conf{XferMethod} = "rsyncd".
1022 # The user name and password are stored on the client in whatever file
1023 # the "secrets file" parameter in rsyncd.conf points to
1024 # (eg: /etc/rsyncd.secrets).
1025 #
1026 $Conf{RsyncdPasswd} = '';
1027
1028 #
1029 # Whether authentication is mandatory when connecting to the client's
1030 # rsyncd.  By default this is on, ensuring that BackupPC will refuse to
1031 # connect to an rsyncd on the client that is not password protected.
1032 # Turn off at your own risk.
1033 #
1034 $Conf{RsyncdAuthRequired} = 1;
1035
1036 #
1037 # When rsync checksum caching is enabled (by adding the
1038 # --checksum-seed=32761 option to $Conf{RsyncArgs}), the cached
1039 # checksums can be occaisonally verified to make sure the file
1040 # contents matches the cached checksums.  This is to avoid the
1041 # risk that disk problems might cause the pool file contents to
1042 # get corrupted, but the cached checksums would make BackupPC
1043 # think that the file still matches the client.
1044 #
1045 # This setting is the probability (0 means never and 1 means always)
1046 # that a file will be rechecked.  Setting it to 0 means the checksums
1047 # will not be rechecked (unless there is a phase 0 failure).  Setting
1048 # it to 1 (ie: 100%) means all files will be checked, but that is
1049 # not a desirable setting since you are better off simply turning
1050 # caching off (ie: remove the --checksum-seed option).
1051 #   
1052 # The default of 0.01 means 1% (on average) of the files during a full
1053 # backup will have their cached checksum re-checked.
1054 #   
1055 # This setting has no effect unless checksum caching is turned on.
1056 #   
1057 $Conf{RsyncCsumCacheVerifyProb} = 0.01;
1058
1059 #
1060 # Arguments to rsync for backup.  Do not edit the first set unless you
1061 # have a thorough understanding of how File::RsyncP works.
1062 #
1063 # Examples of additional arguments that should work are --exclude/--include,
1064 # eg:
1065 #
1066 #     $Conf{RsyncArgs} = [
1067 #           # original arguments here
1068 #           '-v',
1069 #           '--exclude', '/proc',
1070 #           '--exclude', '*.tmp',
1071 #     ];
1072 #
1073 $Conf{RsyncArgs} = [
1074             #
1075             # Do not edit these!
1076             #
1077             '--numeric-ids',
1078             '--perms',
1079             '--owner',
1080             '--group',
1081             '--devices',
1082             '--links',
1083             '--times',
1084             '--block-size=2048',
1085             '--recursive',
1086
1087             #
1088             # If you are using a patched client rsync that supports the
1089             # --checksum-seed option (see http://backuppc.sourceforge.net),
1090             # then uncomment this to enabled rsync checksum cachcing
1091             #
1092             #'--checksum-seed=32761',
1093
1094             #
1095             # Add additional arguments here
1096             #
1097 ];
1098
1099 #
1100 # Arguments to rsync for restore.  Do not edit the first set unless you
1101 # have a thorough understanding of how File::RsyncP works.
1102 #
1103 # If you want to disable direct restores using rsync (eg: is the module
1104 # is read-only), you should set $Conf{RsyncRestoreArgs} to undef and
1105 # the corresponding CGI restore option will be removed.
1106 #
1107 $Conf{RsyncRestoreArgs} = [
1108             #
1109             # Do not edit these!
1110             #
1111             '--numeric-ids',
1112             '--perms',
1113             '--owner',
1114             '--group',
1115             '--devices',
1116             '--links',
1117             '--times',
1118             '--block-size=2048',
1119             '--relative',
1120             '--ignore-times',
1121             '--recursive',
1122
1123             #
1124             # If you are using a patched client rsync that supports the
1125             # --checksum-seed option (see http://backuppc.sourceforge.net),
1126             # then uncomment this to enabled rsync checksum cachcing
1127             #
1128             #'--checksum-seed=32761',
1129
1130             #
1131             # Add additional arguments here
1132             #
1133 ];
1134
1135 #
1136 # Archive Destination
1137 #
1138 # The Destination of the archive
1139 # e.g. /tmp for file archive or /dev/nst0 for device archive
1140 #
1141 $Conf{ArchiveDest} = '/tmp';
1142
1143 #
1144 # Archive Compression type
1145 #
1146 # The valid values are:
1147 #
1148 #   - 'none':  No Compression
1149 #
1150 #   - 'gzip':  Medium Compression. Recommended.
1151 #
1152 #   - 'bzip2': High Compression but takes longer.
1153 #
1154 $Conf{ArchiveComp} = 'gzip';
1155
1156 #
1157 # Archive Parity Files
1158 #
1159 # The amount of Parity data to generate, as a percentage
1160 # of the archive size.
1161 # Uses the commandline par2 (par2cmdline) available from
1162 # http://parchive.sourceforge.net
1163 #
1164 # Only useful for file dumps.
1165 #
1166 # Set to 0 to disable this feature.
1167 #
1168 $Conf{ArchivePar} = 0;
1169
1170 #
1171 # Archive Size Split
1172 #
1173 # Only for file archives. Splits the output into 
1174 # the specified size * 1,000,000.
1175 # e.g. to split into 650,000,000 bytes, specify 650 below.
1176
1177 # If the value is 0, or if $Conf{ArchiveDest} is an existing file or
1178 # device (e.g. a streaming tape drive), this feature is disabled.
1179 #
1180 $Conf{ArchiveSplit} = 0;
1181
1182 #
1183 # Archive Command
1184 #
1185 # This is the command that is called to actually run the archive process
1186 # for each host.  The following variables are substituted at run-time:
1187 #
1188 #   $Installdir    The installation directory of BackupPC
1189 #   $tarCreatePath The path to BackupPC_tarCreate
1190 #   $splitpath     The path to the split program
1191 #   $parpath       The path to the par2 program
1192 #   $host          The host to archive
1193 #   $backupnumber  The backup number of the host to archive
1194 #   $compression   The path to the compression program
1195 #   $compext       The extension assigned to the compression type
1196 #   $splitsize     The number of bytes to split archives into
1197 #   $archiveloc    The location to put the archive
1198 #   $parfile       The amount of parity data to create (percentage)
1199 #
1200 $Conf{ArchiveClientCmd} = '$Installdir/bin/BackupPC_archiveHost'
1201         . ' $tarCreatePath $splitpath $parpath $host $backupnumber'
1202         . ' $compression $compext $splitsize $archiveloc $parfile *';
1203
1204 #
1205 # Full path for ssh. Security caution: normal users should not
1206 # allowed to write to this file or directory.
1207 #
1208 $Conf{SshPath} = '/usr/bin/ssh';
1209
1210 #
1211 # Full path for nmblookup. Security caution: normal users should not
1212 # allowed to write to this file or directory.
1213 #
1214 # nmblookup is from the Samba distribution. nmblookup is used to get the
1215 # netbios name, necessary for DHCP hosts.
1216 #
1217 $Conf{NmbLookupPath} = '/usr/bin/nmblookup';
1218
1219 #
1220 # NmbLookup command.  Given an IP address, does an nmblookup on that
1221 # IP address.  The following variables are substituted at run-time:
1222 #
1223 #   $nmbLookupPath      path to nmblookup ($Conf{NmbLookupPath})
1224 #   $host               IP address
1225 #
1226 # This command is only used for DHCP hosts: given an IP address, this
1227 # command should try to find its NetBios name.
1228 #
1229 $Conf{NmbLookupCmd} = '$nmbLookupPath -A $host';
1230
1231 #
1232 # NmbLookup command.  Given a netbios name, finds that host by doing
1233 # a NetBios lookup.  Several variables are substituted at run-time:
1234 #
1235 #   $nmbLookupPath      path to nmblookup ($Conf{NmbLookupPath})
1236 #   $host               NetBios name
1237 #
1238 # In some cases you might need to change the broadcast address, for
1239 # example if nmblookup uses 192.168.255.255 by default and you find
1240 # that doesn't work, try 192.168.1.255 (or your equivalent class C
1241 # address) using the -B option:
1242 #
1243 #    $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath -B 192.168.1.255 $host';
1244 #
1245 # If you use a WINS server and your machines don't respond to
1246 # multicast NetBios requests you can use this (replace 1.2.3.4
1247 # with the IP address of your WINS server):
1248 #
1249 #    $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath -R -U 1.2.3.4 $host';
1250 #
1251 # This is preferred over multicast since it minimizes network traffic.
1252 #
1253 # Experiment manually for your site to see what form of nmblookup command
1254 # works.
1255 #
1256 $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath $host';
1257
1258 #
1259 # For fixed IP address hosts, BackupPC_dump can also verify the netbios
1260 # name to ensure it matches the host name.  An error is generated if
1261 # they do not match.  Typically this flag is off.  But if you are going
1262 # to transition a bunch of machines from fixed host addresses to DHCP,
1263 # setting this flag is a great way to verify that the machines have
1264 # their netbios name set correctly before turning on DCHP.
1265 #
1266 $Conf{FixedIPNetBiosNameCheck} = 0;
1267
1268 #
1269 # Full path to the ping command.  Security caution: normal users
1270 # should not be allowed to write to this file or directory.
1271 #
1272 # If you want to disable ping checking, set this to some program
1273 # that exits with 0 status, eg:
1274 #
1275 #     $Conf{PingPath} = '/bin/echo';
1276 #
1277 $Conf{PingPath} = '/bin/ping';
1278
1279 #
1280 # Ping command.  The following variables are substituted at run-time:
1281 #
1282 #   $pingPath      path to ping ($Conf{PingPath})
1283 #   $host          host name
1284 #
1285 # Wade Brown reports that on solaris 2.6 and 2.7 ping -s returns the wrong
1286 # exit status (0 even on failure).  Replace with "ping $host 1", which
1287 # gets the correct exit status but we don't get the round-trip time.
1288 #
1289 $Conf{PingCmd} = '$pingPath -c 1 $host';
1290
1291 #
1292 # Maximum round-trip ping time in milliseconds.  This threshold is set
1293 # to avoid backing up PCs that are remotely connected through WAN or
1294 # dialup connections.  The output from ping -s (assuming it is supported
1295 # on your system) is used to check the round-trip packet time.  On your
1296 # local LAN round-trip times should be much less than 20msec.  On most
1297 # WAN or dialup connections the round-trip time will be typically more
1298 # than 20msec.  Tune if necessary.
1299 #
1300 $Conf{PingMaxMsec} = 20;
1301
1302 #
1303 # Compression level to use on files.  0 means no compression.  Compression
1304 # levels can be from 1 (least cpu time, slightly worse compression) to
1305 # 9 (most cpu time, slightly better compression).  The recommended value
1306 # is 3.  Changing to 5, for example, will take maybe 20% more cpu time
1307 # and will get another 2-3% additional compression. See the zlib
1308 # documentation for more information about compression levels.
1309 #
1310 # Changing compression on or off after backups have already been done
1311 # will require both compressed and uncompressed pool files to be stored.
1312 # This will increase the pool storage requirements, at least until all
1313 # the old backups expire and are deleted.
1314 #
1315 # It is ok to change the compression value (from one non-zero value to
1316 # another non-zero value) after dumps are already done.  Since BackupPC
1317 # matches pool files by comparing the uncompressed versions, it will still
1318 # correctly match new incoming files against existing pool files.  The
1319 # new compression level will take effect only for new files that are
1320 # newly compressed and added to the pool.
1321 #
1322 # If compression was off and you are enabling compression for the first
1323 # time you can use the BackupPC_compressPool utility to compress the
1324 # pool.  This avoids having the pool grow to accommodate both compressed
1325 # and uncompressed backups.  See the documentation for more information.
1326 #
1327 # Note: compression needs the Compress::Zlib perl library.  If the
1328 # Compress::Zlib library can't be found then $Conf{CompressLevel} is
1329 # forced to 0 (compression off).
1330 #
1331 $Conf{CompressLevel} = 0;
1332
1333 #
1334 # Timeout in seconds when listening for the transport program's
1335 # (smbclient, tar etc) stdout. If no output is received during this
1336 # time, then it is assumed that something has wedged during a backup,
1337 # and the backup is terminated.
1338 #
1339 # Note that stdout buffering combined with huge files being backed up
1340 # could cause longish delays in the output from smbclient that
1341 # BackupPC_dump sees, so in rare cases you might want to increase
1342 # this value.
1343 #
1344 # Despite the name, this parameter sets the timeout for all transport
1345 # methods (tar, smb etc).
1346 #
1347 $Conf{ClientTimeout} = 72000;
1348
1349 #
1350 # Maximum number of log files we keep around in each PC's directory
1351 # (ie: pc/$host).  These files are aged monthly.  A setting of 12
1352 # means there will be at most the files LOG, LOG.0, LOG.1, ... LOG.11
1353 # in the pc/$host directory (ie: about a years worth).  (Except this
1354 # month's LOG, these files will have a .z extension if compression
1355 # is on).
1356 #
1357 # If you decrease this number after BackupPC has been running for a
1358 # while you will have to manually remove the older log files.
1359 #
1360 $Conf{MaxOldPerPCLogFiles} = 12;
1361
1362 #
1363 # Optional commands to run before and after dumps and restores,
1364 # and also before and after each share of a dump.
1365 #
1366 # Stdout from these commands will be written to the Xfer (or Restore)
1367 # log file.  One example of using these commands would be to
1368 # shut down and restart a database server, dump a database
1369 # to files for backup, or doing a snapshot of a share prior
1370 # to a backup.  Example:
1371 #
1372 #    $Conf{DumpPreUserCmd} = '$sshPath -q -x -l root $host /usr/bin/dumpMysql';
1373 #
1374 # The following variable substitutions are made at run time for
1375 # $Conf{DumpPreUserCmd}, $Conf{DumpPostUserCmd}, $Conf{DumpPreShareCmd}
1376 # and $Conf{DumpPostShareCmd}:
1377 #
1378 #        $type         type of dump (incr or full)
1379 #        $xferOK       1 if the dump succeeded, 0 if it didn't
1380 #        $client       client name being backed up
1381 #        $host         host name (could be different from client name if
1382 #                                 $Conf{ClientNameAlias} is set)
1383 #        $hostIP       IP address of host
1384 #        $user         user name from the hosts file
1385 #        $moreUsers    list of additional users from the hosts file
1386 #        $share        the first share name (or current share for
1387 #                        $Conf{DumpPreShareCmd} and $Conf{DumpPostShareCmd})
1388 #        $shares       list of all the share names
1389 #        $XferMethod   value of $Conf{XferMethod} (eg: tar, rsync, smb)
1390 #        $sshPath      value of $Conf{SshPath},
1391 #        $cmdType      set to DumpPreUserCmd or DumpPostUserCmd
1392 #
1393 # The following variable substitutions are made at run time for
1394 # $Conf{RestorePreUserCmd} and $Conf{RestorePostUserCmd}:
1395 #
1396 #        $client       client name being backed up
1397 #        $xferOK       1 if the restore succeeded, 0 if it didn't
1398 #        $host         host name (could be different from client name if
1399 #                                 $Conf{ClientNameAlias} is set)
1400 #        $hostIP       IP address of host
1401 #        $user         user name from the hosts file
1402 #        $moreUsers    list of additional users from the hosts file
1403 #        $share        the first share name
1404 #        $XferMethod   value of $Conf{XferMethod} (eg: tar, rsync, smb)
1405 #        $sshPath      value of $Conf{SshPath},
1406 #        $type         set to "restore"
1407 #        $bkupSrcHost  host name of the restore source
1408 #        $bkupSrcShare share name of the restore source
1409 #        $bkupSrcNum   backup number of the restore source
1410 #        $pathHdrSrc   common starting path of restore source
1411 #        $pathHdrDest  common starting path of destination
1412 #        $fileList     list of files being restored
1413 #        $cmdType      set to RestorePreUserCmd or RestorePostUserCmd
1414 #
1415 # The following variable substitutions are made at run time for
1416 # $Conf{ArchivePreUserCmd} and $Conf{ArchivePostUserCmd}:
1417 #
1418 #        $client       client name being backed up
1419 #        $xferOK       1 if the archive succeeded, 0 if it didn't
1420 #        $host         Name of the archive host
1421 #        $user         user name from the hosts file
1422 #        $share        the first share name
1423 #        $XferMethod   value of $Conf{XferMethod} (eg: tar, rsync, smb)
1424 #        $HostList     list of hosts being archived
1425 #        $BackupList   list of backup numbers for the hosts being archived
1426 #        $archiveloc   location where the archive is sent to
1427 #        $parfile      amount of parity data being generated (percentage)
1428 #        $compression  compression program being used (eg: cat, gzip, bzip2)
1429 #        $compext      extension used for compression type (eg: raw, gz, bz2)
1430 #        $splitsize    size of the files that the archive creates
1431 #        $sshPath      value of $Conf{SshPath},
1432 #        $type         set to "archive"
1433 #        $cmdType      set to ArchivePreUserCmd or ArchivePostUserCmd
1434 #
1435 $Conf{DumpPreUserCmd}     = undef;
1436 $Conf{DumpPostUserCmd}    = undef;
1437 $Conf{DumpPreShareCmd}    = undef;
1438 $Conf{DumpPostShareCmd}   = undef;
1439 $Conf{RestorePreUserCmd}  = undef;
1440 $Conf{RestorePostUserCmd} = undef;
1441 $Conf{ArchivePreUserCmd}  = undef;
1442 $Conf{ArchivePostUserCmd} = undef;
1443
1444 #
1445 # Override the client's host name.  This allows multiple clients
1446 # to all refer to the same physical host.  This should only be
1447 # set in the per-PC config file and is only used by BackupPC at
1448 # the last moment prior to generating the command used to backup
1449 # that machine (ie: the value of $Conf{ClientNameAlias} is invisible
1450 # everywhere else in BackupPC).  The setting can be a host name or
1451 # IP address, eg:
1452 #
1453 #         $Conf{ClientNameAlias} = 'realHostName';
1454 #         $Conf{ClientNameAlias} = '192.1.1.15';
1455 #
1456 # will cause the relevant smb/tar/rsync backup/restore commands to be
1457 # directed to realHostName, not the client name.
1458 #
1459 # Note: this setting doesn't work for hosts with DHCP set to 1.
1460 #
1461 $Conf{ClientNameAlias} = undef;
1462
1463 ###########################################################################
1464 # Email reminders, status and messages
1465 # (can be overridden in the per-PC config.pl)
1466 ###########################################################################
1467 #
1468 # Full path to the sendmail command.  Security caution: normal users
1469 # should not allowed to write to this file or directory.
1470 #
1471 $Conf{SendmailPath} = '/usr/sbin/sendmail';
1472
1473 #
1474 # Minimum period between consecutive emails to a single user.
1475 # This tries to keep annoying email to users to a reasonable
1476 # level.  Email checks are done nightly, so this number is effectively
1477 # rounded up (ie: 2.5 means a user will never receive email more
1478 # than once every 3 days).
1479 #
1480 $Conf{EMailNotifyMinDays} = 2.5;
1481
1482 #
1483 # Name to use as the "from" name for email.  Depending upon your mail
1484 # handler this is either a plain name (eg: "admin") or a fully-qualified
1485 # name (eg: "admin@mydomain.com").
1486 #
1487 $Conf{EMailFromUserName} = '';
1488
1489 #
1490 # Destination address to an administrative user who will receive a
1491 # nightly email with warnings and errors.  If there are no warnings
1492 # or errors then no email will be sent.  Depending upon your mail
1493 # handler this is either a plain name (eg: "admin") or a fully-qualified
1494 # name (eg: "admin@mydomain.com").
1495 #
1496 $Conf{EMailAdminUserName} = '';
1497
1498 #
1499 # Destination domain name for email sent to users.  By default
1500 # this is empty, meaning email is sent to plain, unqualified
1501 # addresses.  Otherwise, set it to the destintation domain, eg:
1502 #
1503 #    $Cong{EMailUserDestDomain} = '@mydomain.com';
1504 #
1505 # With this setting user email will be set to 'user@mydomain.com'.
1506 #
1507 $Conf{EMailUserDestDomain} = '';
1508
1509 #
1510 # This subject and message is sent to a user if their PC has never been
1511 # backed up.
1512 #
1513 # These values are language-dependent.  The default versions can be
1514 # found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
1515 # need to change the message, copy it here and edit it, eg:
1516 #
1517 #   $Conf{EMailNoBackupEverMesg} = <<'EOF';
1518 #   To: $user$domain
1519 #   cc:
1520 #   Subject: $subj
1521 #   
1522 #   Dear $userName,
1523 #   
1524 #   This is a site-specific email message.
1525 #   EOF
1526 #
1527 $Conf{EMailNoBackupEverSubj} = undef;
1528 $Conf{EMailNoBackupEverMesg} = undef;
1529
1530 #
1531 # How old the most recent backup has to be before notifying user.
1532 # When there have been no backups in this number of days the user
1533 # is sent an email.
1534 #
1535 $Conf{EMailNotifyOldBackupDays} = 7.0;
1536
1537 #
1538 # This subject and message is sent to a user if their PC has not recently
1539 # been backed up (ie: more than $Conf{EMailNotifyOldBackupDays} days ago).
1540 #
1541 # These values are language-dependent.  The default versions can be
1542 # found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
1543 # need to change the message, copy it here and edit it, eg:
1544 #
1545 #   $Conf{EMailNoBackupRecentMesg} = <<'EOF';
1546 #   To: $user$domain
1547 #   cc:
1548 #   Subject: $subj
1549 #   
1550 #   Dear $userName,
1551 #   
1552 #   This is a site-specific email message.
1553 #   EOF
1554 #
1555 $Conf{EMailNoBackupRecentSubj} = undef;
1556 $Conf{EMailNoBackupRecentMesg} = undef;
1557
1558 #
1559 # How old the most recent backup of Outlook files has to be before
1560 # notifying user.
1561 #
1562 $Conf{EMailNotifyOldOutlookDays} = 5.0;
1563
1564 #
1565 # This subject and message is sent to a user if their Outlook files have
1566 # not recently been backed up (ie: more than $Conf{EMailNotifyOldOutlookDays}
1567 # days ago).
1568 #
1569 # These values are language-dependent.  The default versions can be
1570 # found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
1571 # need to change the message, copy it here and edit it, eg:
1572 #
1573 #   $Conf{EMailOutlookBackupMesg} = <<'EOF';
1574 #   To: $user$domain
1575 #   cc:
1576 #   Subject: $subj
1577 #   
1578 #   Dear $userName,
1579 #   
1580 #   This is a site-specific email message.
1581 #   EOF
1582 #
1583 $Conf{EMailOutlookBackupSubj} = undef;
1584 $Conf{EMailOutlookBackupMesg} = undef;
1585
1586 #
1587 # Additional email headers
1588 #
1589 $Conf{EMailHeaders} = <<EOF;
1590 MIME-Version: 1.0
1591 Content-Type: text/plain; charset="iso-8859-1"
1592 EOF
1593
1594 ###########################################################################
1595 # CGI user interface configuration settings
1596 # (can be overridden in the per-PC config.pl)
1597 ###########################################################################
1598 #
1599 # Normal users can only access information specific to their host.
1600 # They can start/stop/browse/restore backups.
1601 #
1602 # Administrative users have full access to all hosts, plus overall
1603 # status and log information.
1604 #
1605 # The administrative users are the union of the unix/linux group
1606 # $Conf{CgiAdminUserGroup} and the manual list of users, separated
1607 # by spaces, in $Conf{CgiAdminUsers}. If you don't want a group or
1608 # manual list of users set the corresponding configuration setting
1609 # to undef or an empty string.
1610 #
1611 # If you want every user to have admin privileges (careful!), set
1612 # $Conf{CgiAdminUsers} = '*'.
1613 #
1614 # Examples:
1615 #    $Conf{CgiAdminUserGroup} = 'admin';
1616 #    $Conf{CgiAdminUsers}     = 'craig celia';
1617 #    --> administrative users are the union of group admin, plus
1618 #      craig and celia.
1619 #
1620 #    $Conf{CgiAdminUserGroup} = '';
1621 #    $Conf{CgiAdminUsers}     = 'craig celia';
1622 #    --> administrative users are only craig and celia'.
1623 #
1624 $Conf{CgiAdminUserGroup} = '';
1625 $Conf{CgiAdminUsers}     = '';
1626
1627 #
1628 # URL of the BackupPC_Admin CGI script.  Used for email messages.
1629 #
1630 $Conf{CgiURL} = undef;
1631
1632 #   
1633 # Language to use.  See lib/BackupPC/Lang for the list of supported
1634 # languages, which include English (en), French (fr), Spanish (es),
1635 # German (de), Italian (it), Dutch (nl) and Portuguese Brazillian
1636 # (pt_br).
1637 #
1638 # Currently the Language setting applies to the CGI interface and email
1639 # messages sent to users.  Log files and other text are still in English.
1640 #
1641 $Conf{Language} = 'en';
1642
1643 #
1644 # User names that are rendered by the CGI interface can be turned
1645 # into links into their home page or other information about the
1646 # user.  To set this up you need to create two sprintf() strings,
1647 # that each contain a single '%s' that will be replaced by the user
1648 # name.  The default is a mailto: link.
1649 #
1650 # $Conf{CgiUserHomePageCheck} should be an absolute file path that
1651 # is used to check (via "-f") that the user has a valid home page.
1652 # Set this to undef or an empty string to turn off this check.
1653 #
1654 # $Conf{CgiUserUrlCreate} should be a full URL that points to the
1655 # user's home page.  Set this to undef or an empty string to turn
1656 # off generation of URLs for user names.
1657 #
1658 # Example:
1659 #    $Conf{CgiUserHomePageCheck} = '/var/www/html/users/%s.html';
1660 #    $Conf{CgiUserUrlCreate}     = 'http://myhost/users/%s.html';
1661 #    --> if /var/www/html/users/craig.html exists, then 'craig' will
1662 #      be rendered as a link to http://myhost/users/craig.html.
1663 #
1664 $Conf{CgiUserHomePageCheck} = '';
1665 $Conf{CgiUserUrlCreate}     = 'mailto:%s';
1666
1667 #
1668 # Date display format for CGI interface.  True for US-style dates (MM/DD)
1669 # and zero for international dates (DD/MM).
1670 #
1671 $Conf{CgiDateFormatMMDD} = 1;
1672
1673 #
1674 # If set, the complete list of hosts appears in the left navigation
1675 # bar pull-down for administrators.  Otherwise, just the hosts for which
1676 # the user is listed in the host file (as either the user or in moreUsers)
1677 # are displayed.
1678 #
1679 $Conf{CgiNavBarAdminAllHosts} = 1;
1680
1681 #
1682 # Enable/disable the search box in the navigation bar.
1683 #
1684 $Conf{CgiSearchBoxEnable} = 1;
1685
1686 #
1687 # Additional navigation bar links.  These appear for both regular users
1688 # and administrators.  This is a list of hashes giving the link (URL)
1689 # and the text (name) for the link.  Specifying lname instead of name
1690 # uses the language specific string (ie: $Lang->{lname}) instead of
1691 # just literally displaying name.
1692 #
1693 $Conf{CgiNavBarLinks} = [
1694     {
1695         link  => "?action=view&type=docs",
1696         lname => "Documentation",    # actually displays $Lang->{Documentation}
1697     },
1698     {
1699         link  => "http://backuppc.sourceforge.net/faq",
1700         name  => "FAQ",              # displays literal "FAQ"
1701     },
1702     {
1703         link  => "http://backuppc.sourceforge.net",
1704         name  => "SourceForge",      # displays literal "SourceForge"
1705     },
1706 ];
1707
1708 #
1709 # Hilight colors based on status that are used in the PC summary page.
1710 #
1711 $Conf{CgiStatusHilightColor} = {
1712     Reason_backup_failed           => '#ffcccc',
1713     Reason_backup_done             => '#ccffcc',
1714     Reason_no_ping                 => '#ffff99',
1715     Reason_backup_canceled_by_user => '#ff9900',
1716     Status_backup_in_progress      => '#66cc99',
1717 };
1718
1719 #
1720 # Additional CGI header text.
1721 #
1722 $Conf{CgiHeaders} = '<meta http-equiv="pragma" content="no-cache">';
1723
1724 #
1725 # Directory where images are stored.  This directory should be below
1726 # Apache's DocumentRoot.  This value isn't used by BackupPC but is
1727 # used by configure.pl when you upgrade BackupPC.
1728 #
1729 # Example:
1730 #     $Conf{CgiImageDir} = '/usr/local/apache/htdocs/BackupPC';
1731 #
1732 $Conf{CgiImageDir} = '';
1733
1734 #
1735 # Additional mappings of file name extenions to Content-Type for
1736 # individual file restore.  See $Ext2ContentType in BackupPC_Admin
1737 # for the default setting.  You can add additional settings here,
1738 # or override any default settings.  Example:
1739 #
1740 #     $Conf{CgiExt2ContentType} = {
1741 #                 'pl'  => 'text/plain',
1742 #          };
1743 #
1744 $Conf{CgiExt2ContentType} = { };
1745
1746 #
1747 # URL (without the leading http://host) for BackupPC's image directory.
1748 # The CGI script uses this value to serve up image files.
1749 #
1750 # Example:
1751 #     $Conf{CgiImageDirURL} = '/BackupPC';
1752 #
1753 $Conf{CgiImageDirURL} = '';
1754
1755 #
1756 # CSS stylesheet for the CGI interface.  It is stored in the
1757 # $Conf{CgiImageDir} directory and accessed via the
1758 # $Conf{CgiImageDirURL} URL.
1759 #
1760 $Conf{CgiCSSFile} = 'BackupPC_stnd.css';
1761
1762 #
1763 # Which per-host config variables a non-admin user is allowed
1764 # to edit.
1765 #
1766 $Conf{CgiUserConfigEdit} = {
1767         FullPeriod                => 1,
1768         IncrPeriod                => 1,
1769         FullKeepCnt               => 1,
1770         FullKeepCntMin            => 1,
1771         FullAgeMax                => 1,
1772         IncrKeepCnt               => 1,
1773         IncrKeepCntMin            => 1,
1774         IncrAgeMax                => 1,
1775         PartialAgeMax             => 1,
1776         IncrFill                  => 1,
1777         RestoreInfoKeepCnt        => 1,
1778         ArchiveInfoKeepCnt        => 1,
1779         BackupFilesOnly           => 1,
1780         BackupFilesExclude        => 1,
1781         BlackoutBadPingLimit      => 1,
1782         BlackoutGoodCnt           => 1,
1783         BlackoutPeriods           => 1,
1784         BackupZeroFilesIsFatal    => 1,
1785         XferMethod                => 1,
1786         XferLogLevel              => 1,
1787         SmbShareName              => 1,
1788         SmbShareUserName          => 1,
1789         SmbSharePasswd            => 1,
1790         TarShareName              => 1,
1791         TarFullArgs               => 1,
1792         TarIncrArgs               => 1,
1793         RsyncShareName            => 1,
1794         RsyncdClientPort          => 1,
1795         RsyncdPasswd              => 1,
1796         RsyncdAuthRequired        => 1,
1797         RsyncCsumCacheVerifyProb  => 1,
1798         RsyncArgs                 => 1,
1799         RsyncRestoreArgs          => 1,
1800         ArchiveDest               => 1,
1801         ArchiveComp               => 1,
1802         ArchivePar                => 1,
1803         ArchiveSplit              => 1,
1804         FixedIPNetBiosNameCheck   => 1,
1805         PingMaxMsec               => 1,
1806         ClientTimeout             => 1,
1807         MaxOldPerPCLogFiles       => 1,
1808         CompressLevel             => 1,
1809         ClientNameAlias           => 1,
1810         EMailNotifyMinDays        => 1,
1811         EMailFromUserName         => 1,
1812         EMailAdminUserName        => 1,
1813         EMailUserDestDomain       => 1,
1814         EMailNoBackupEverSubj     => 1,
1815         EMailNoBackupEverMesg     => 1,
1816         EMailNotifyOldBackupDays  => 1,
1817         EMailNoBackupRecentSubj   => 1,
1818         EMailNoBackupRecentMesg   => 1,
1819         EMailNotifyOldOutlookDays => 1,
1820         EMailOutlookBackupSubj    => 1,
1821         EMailOutlookBackupMesg    => 1,
1822         EMailHeaders              => 1,
1823 };