d8bf14597ee149cc2ac08fbf4fc036a8a0608aec
[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 # What to backup and when to do it
305 # (can be overridden in the per-PC config.pl)
306 ###########################################################################
307 #
308 # Name of the host share that is backed up when using SMB.  This can be a
309 # string or an array of strings if there are multiple shares per host.
310 # Examples:
311 #
312 #   $Conf{SmbShareName} = 'c';          # backup 'c' share
313 #   $Conf{SmbShareName} = ['c', 'd'];   # backup 'c' and 'd' shares
314 #
315 # This setting only matters if $Conf{XferMethod} = 'smb'.
316 #
317 $Conf{SmbShareName} = 'C$';
318
319 #
320 # Smbclient share user name.  This is passed to smbclient's -U argument.
321 #
322 # This setting only matters if $Conf{XferMethod} = 'smb'.
323 #
324 $Conf{SmbShareUserName} = '';
325
326 #
327 # Smbclient share password.  This is passed to smbclient via its PASSWD
328 # environment variable.  There are several ways you can tell BackupPC
329 # the smb share password.  In each case you should be very careful about
330 # security.  If you put the password here, make sure that this file is
331 # not readable by regular users!  See the "Setting up config.pl" section
332 # in the documentation for more information.
333 #
334 # This setting only matters if $Conf{XferMethod} = 'smb'.
335 #
336 $Conf{SmbSharePasswd} = '';
337
338 #
339 # Which host directories to backup when using tar transport.  This can be a
340 # string or an array of strings if there are multiple directories to
341 # backup per host.  Examples:
342 #
343 #   $Conf{TarShareName} = '/';                  # backup everything
344 #   $Conf{TarShareName} = '/home';              # only backup /home
345 #   $Conf{TarShareName} = ['/home', '/src'];    # backup /home and /src
346 #
347 # The fact this parameter is called 'TarShareName' is for historical
348 # consistency with the Smb transport options.  You can use any valid
349 # directory on the client: there is no need for it to correspond to
350 # any Smb share or device mount point.
351 #
352 # Note also that you can also use $Conf{BackupFilesOnly} to specify
353 # a specific list of directories to backup.  It's more efficient to
354 # use this option instead of $Conf{TarShareName} since a new tar is
355 # run for each entry in $Conf{TarShareName}.
356 #
357 # On the other hand, if you add --one-file-system to $Conf{TarClientCmd}
358 # you can backup each file system separately, which makes restoring one
359 # bad file system easier.  In this case you would list all of the mount
360 # points here, since you can't get the same result with
361 # $Conf{BackupFilesOnly}:
362 #
363 #     $Conf{TarShareName} = ['/', '/var', '/data', '/boot'];
364 #
365 # This setting only matters if $Conf{XferMethod} = 'tar'.
366 #
367 $Conf{TarShareName} = '/';
368
369 #
370 # Minimum period in days between full backups. A full dump will only be
371 # done if at least this much time has elapsed since the last full dump,
372 # and at least $Conf{IncrPeriod} days has elapsed since the last
373 # successful dump.
374 #
375 # Typically this is set slightly less than an integer number of days. The
376 # time taken for the backup, plus the granularity of $Conf{WakeupSchedule}
377 # will make the actual backup interval a bit longer.
378 #
379 # There are two special values for $Conf{FullPeriod}:
380 #
381 #   -1   Don't do any regular backups on this machine.  Manually
382 #        requested backups (via the CGI interface) will still occur.
383 #
384 #   -2   Don't do any backups on this machine.  Manually requested
385 #        backups (via the CGI interface) will be ignored.
386 #
387 # These special settings are useful for a client that is no longer
388 # being backed up (eg: a retired machine), but you wish to keep the
389 # last backups available for browsing or restoring to other machines.
390 #
391 $Conf{FullPeriod} = 6.97;
392
393 #
394 # Minimum period in days between incremental backups (a user requested
395 # incremental backup will be done anytime on demand).
396 #
397 # Typically this is set slightly less than an integer number of days. The
398 # time taken for the backup, plus the granularity of $Conf{WakeupSchedule}
399 # will make the actual backup interval a bit longer.
400 #
401 $Conf{IncrPeriod} = 0.97;
402
403 #
404 # Number of full backups to keep.  Must be >= 1.
405 #
406 # In the steady state, each time a full backup completes successfully
407 # the oldest one is removed.  If this number is decreased, the
408 # extra old backups will be removed.
409 #
410 # If filling of incremental dumps is off the oldest backup always
411 # has to be a full (ie: filled) dump.  This might mean one or two
412 # extra full dumps are kept until the oldest incremental backups expire.
413 #
414 # Exponential backup expiry is also supported.  This allows you to specify:
415 #
416 #   - num fulls to keep at intervals of 1 * $Conf{FullPeriod}, followed by
417 #   - num fulls to keep at intervals of 2 * $Conf{FullPeriod},
418 #   - num fulls to keep at intervals of 4 * $Conf{FullPeriod},
419 #   - num fulls to keep at intervals of 8 * $Conf{FullPeriod},
420 #   - num fulls to keep at intervals of 16 * $Conf{FullPeriod},
421 #
422 # and so on.  This works by deleting every other full as each expiry
423 # boundary is crossed.
424 #
425 # Exponential expiry is specified using an array for $Conf{FullKeepCnt}:
426 #
427 #   $Conf{FullKeepCnt} = [4, 2, 3];
428 #
429 # Entry #n specifies how many fulls to keep at an interval of
430 # 2^n * $Conf{FullPeriod} (ie: 1, 2, 4, 8, 16, 32, ...).
431 #
432 # The example above specifies keeping 4 of the most recent full backups
433 # (1 week interval) two full backups at 2 week intervals, and 3 full
434 # backups at 4 week intervals, eg:
435 #
436 #    full 0 19 weeks old   \
437 #    full 1 15 weeks old    >---  3 backups at 4 * $Conf{FullPeriod}
438 #    full 2 11 weeks old   / 
439 #    full 3  7 weeks old   \____  2 backups at 2 * $Conf{FullPeriod}
440 #    full 4  5 weeks old   /
441 #    full 5  3 weeks old   \
442 #    full 6  2 weeks old    \___  4 backups at 1 * $Conf{FullPeriod}
443 #    full 7  1 week old     /
444 #    full 8  current       /
445 #
446 # On a given week the spacing might be less than shown as each backup
447 # ages through each expiry period.  For example, one week later, a
448 # new full is completed and the oldest is deleted, giving:
449 #
450 #    full 0 16 weeks old   \
451 #    full 1 12 weeks old    >---  3 backups at 4 * $Conf{FullPeriod}
452 #    full 2  8 weeks old   / 
453 #    full 3  6 weeks old   \____  2 backups at 2 * $Conf{FullPeriod}
454 #    full 4  4 weeks old   /
455 #    full 5  3 weeks old   \
456 #    full 6  2 weeks old    \___  4 backups at 1 * $Conf{FullPeriod}
457 #    full 7  1 week old     /
458 #    full 8  current       /
459 #
460 # You can specify 0 as a count (except in the first entry), and the
461 # array can be as long as you wish.  For example:
462 #
463 #   $Conf{FullKeepCnt} = [4, 0, 4, 0, 0, 2];
464 #
465 # This will keep 10 full dumps, 4 most recent at 1 * $Conf{FullPeriod},
466 # followed by 4 at an interval of 4 * $Conf{FullPeriod} (approx 1 month
467 # apart), and then 2 at an interval of 32 * $Conf{FullPeriod} (approx
468 # 7-8 months apart).
469 #
470 # Note that you will have to increase $Conf{FullAgeMax} if you want
471 # very old full backups to be kept.  Full backups are removed according
472 # to both $Conf{FullKeepCnt} and $Conf{FullAgeMax}.
473 #
474 # Note also that these two settings are equivalent and both keep just
475 # the four most recent full dumps:
476 #
477 #    $Conf{FullKeepCnt} = 4;
478 #    $Conf{FullKeepCnt} = [4];
479 #
480 $Conf{FullKeepCnt} = 1;
481
482 #
483 # Very old full backups are removed after $Conf{FullAgeMax} days.  However,
484 # we keep at least $Conf{FullKeepCntMin} full backups no matter how old
485 # they are.
486 #
487 $Conf{FullKeepCntMin} = 1;
488 $Conf{FullAgeMax}     = 90;
489
490 #
491 # Number of incremental backups to keep.  Must be >= 1.
492 #
493 # In the steady state, each time an incr backup completes successfully
494 # the oldest one is removed.  If this number is decreased, the
495 # extra old backups will be removed.
496 #
497 $Conf{IncrKeepCnt} = 6;
498
499 #
500 # Very old incremental backups are removed after $Conf{IncrAgeMax} days.
501 # However, we keep at least $Conf{IncrKeepCntMin} incremental backups no
502 # matter how old they are.
503 #
504 $Conf{IncrKeepCntMin} = 1;
505 $Conf{IncrAgeMax}     = 30;
506
507 #
508 # Whether incremental backups are filled.  "Filling" means that the
509 # most recent full (or filled) dump is merged into the new incremental
510 # dump using hardlinks.  This makes an incremental dump look like a
511 # full dump.  Prior to v1.03 all incremental backups were filled.
512 # In v1.4.0 and later the default is off.
513 #
514 # BackupPC, and the cgi interface in particular, do the right thing on
515 # un-filled incremental backups.  It will correctly display the merged
516 # incremental backup with the most recent filled backup, giving the
517 # un-filled incremental backups a filled appearance.  That means it
518 # invisible to the user whether incremental dumps are filled or not.
519 #
520 # Filling backups takes a little extra disk space, and it does cost
521 # some extra disk activity for filling, and later removal.  Filling
522 # is no longer useful, since file mangling and compression doesn't
523 # make a filled backup very useful. It's likely the filling option
524 # will be removed from future versions: filling will be delegated to
525 # the display and extraction of backup data.
526 #
527 # If filling is off, BackupPC makes sure that the oldest backup is
528 # a full, otherwise the following incremental backups will be
529 # incomplete.  This might mean an extra full backup has to be
530 # kept until the following incremental backups expire.
531 #
532 # The default is off.  You can turn this on or off at any
533 # time without affecting existing backups.
534 #
535 $Conf{IncrFill} = 0;
536
537 #
538 # Number of restore logs to keep.  BackupPC remembers information about
539 # each restore request.  This number per client will be kept around before
540 # the oldest ones are pruned.
541 #
542 # Note: files/dirs delivered via Zip or Tar downloads don't count as
543 # restores.  Only the first restore option (where the files and dirs
544 # are written to the host) count as restores that are logged.
545 #
546 $Conf{RestoreInfoKeepCnt} = 10;
547
548 #
549 # Number of archive logs to keep.  BackupPC remembers information
550 # about each archive request.  This number per archive client will
551 # be kept around before the oldest ones are pruned.
552 #
553 $Conf{ArchiveInfoKeepCnt} = 10;
554
555 #
556 # List of directories or files to backup.  If this is defined, only these
557 # directories or files will be backed up.
558 #
559 # For Smb, only one of $Conf{BackupFilesExclude} and $Conf{BackupFilesOnly}
560 # can be specified per share. If both are set for a particular share, then
561 # $Conf{BackupFilesOnly} takes precedence and $Conf{BackupFilesExclude}
562 # is ignored.
563 #
564 # This can be set to a string, an array of strings, or, in the case
565 # of multiple shares, a hash of strings or arrays.  A hash is used
566 # to give a list of directories or files to backup for each share
567 # (the share name is the key).  If this is set to just a string or
568 # array, and $Conf{SmbShareName} contains multiple share names, then
569 # the setting is assumed to apply to only the first share name.
570 #
571 # Examples:
572 #    $Conf{BackupFilesOnly} = '/myFiles';
573 #    $Conf{BackupFilesOnly} = ['/myFiles'];     # same as first example
574 #    $Conf{BackupFilesOnly} = ['/myFiles', '/important'];
575 #    $Conf{BackupFilesOnly} = {
576 #       'c' => ['/myFiles', '/important'],      # these are for 'c' share
577 #       'd' => ['/moreFiles', '/archive'],      # these are for 'd' share
578 #    };
579 #
580 $Conf{BackupFilesOnly} = undef;
581
582 #
583 # List of directories or files to exclude from the backup.  For Smb,
584 # only one of $Conf{BackupFilesExclude} and $Conf{BackupFilesOnly}
585 # can be specified per share.  If both are set for a particular share,
586 # then $Conf{BackupFilesOnly} takes precedence and
587 # $Conf{BackupFilesExclude} is ignored.
588 #
589 # This can be set to a string, an array of strings, or, in the case
590 # of multiple shares, a hash of strings or arrays.  A hash is used
591 # to give a list of directories or files to exclude for each share
592 # (the share name is the key).  If this is set to just a string or
593 # array, and $Conf{SmbShareName} contains multiple share names, then
594 # the setting is assumed to apply to only the first share name.
595 #
596 # The exact behavior is determined by the underlying transport program,
597 # smbclient or tar.  For smbclient the exlclude file list is passed into
598 # the X option.  Simple shell wild-cards using "*" or "?" are allowed.
599 #
600 # For tar, if the exclude file contains a "/" it is assumed to be anchored
601 # at the start of the string.  Since all the tar paths start with "./",
602 # BackupPC prepends a "." if the exclude file starts with a "/".  Note
603 # that GNU tar version >= 1.13.7 is required for the exclude option to
604 # work correctly.  For linux or unix machines you should add
605 # "/proc" to $Conf{BackupFilesExclude} unless you have specified
606 # --one-file-system in $Conf{TarClientCmd} or --one-file-system in
607 # $Conf{RsyncArgs}.  Also, for tar, do not use a trailing "/" in
608 # the directory name: a trailing "/" causes the name to not match
609 # and the directory will not be excluded.
610 #
611 # Users report that for smbclient you should specify a directory
612 # followed by "/*", eg: "/proc/*", instead of just "/proc".
613 #
614 # Examples:
615 #    $Conf{BackupFilesExclude} = '/temp';
616 #    $Conf{BackupFilesExclude} = ['/temp'];     # same as first example
617 #    $Conf{BackupFilesExclude} = ['/temp', '/winnt/tmp'];
618 #    $Conf{BackupFilesExclude} = {
619 #       'c' => ['/temp', '/winnt/tmp'],         # these are for 'c' share
620 #       'd' => ['/junk', '/dont_back_this_up'], # these are for 'd' share
621 #    };
622 #
623 $Conf{BackupFilesExclude} = undef;
624
625 #
626 # PCs that are always or often on the network can be backed up after
627 # hours, to reduce PC, network and server load during working hours. For
628 # each PC a count of consecutive good pings is maintained. Once a PC has
629 # at least $Conf{BlackoutGoodCnt} consecutive good pings it is subject
630 # to "blackout" and not backed up during hours and days specified by
631 # $Conf{BlackoutPeriods}.
632 #
633 # To allow for periodic rebooting of a PC or other brief periods when a
634 # PC is not on the network, a number of consecutive bad pings is allowed
635 # before the good ping count is reset. This parameter is
636 # $Conf{BlackoutBadPingLimit}.
637 #
638 # Note that bad and good pings don't occur with the same interval. If a
639 # machine is always on the network, it will only be pinged roughly once
640 # every $Conf{IncrPeriod} (eg: once per day). So a setting for
641 # $Conf{BlackoutGoodCnt} of 7 means it will take around 7 days for a
642 # machine to be subject to blackout. On the other hand, if a ping is
643 # failed, it will be retried roughly every time BackupPC wakes up, eg,
644 # every one or two hours. So a setting for $Conf{BlackoutBadPingLimit} of
645 # 3 means that the PC will lose its blackout status after 3-6 hours of
646 # unavailability.
647 #
648 # To disable the blackout feature set $Conf{BlackoutGoodCnt} to a negative
649 # value.  A value of 0 will make all machines subject to blackout.  But
650 # if you don't want to do any backups during the day it would be easier
651 # to just set $Conf{WakeupSchedule} to a restricted schedule.
652 #
653 $Conf{BlackoutBadPingLimit} = 3;
654 $Conf{BlackoutGoodCnt}      = 7;
655
656 #
657 # One or more blackout periods can be specified.  If a client is
658 # subject to blackout then no regular (non-manual) backups will
659 # be started during any of these periods.  hourBegin and hourEnd
660 # specify hours fro midnight and weekDays is a list of days of
661 # the week where 0 is Sunday, 1 is Monday etc.
662 #
663 # For example:
664 #
665 #    $Conf{BlackoutPeriods} = [
666 #       {
667 #           hourBegin =>  7.0,
668 #           hourEnd   => 19.5,
669 #           weekDays  => [1, 2, 3, 4, 5],
670 #       },
671 #    ];
672 #
673 # specifies one blackout period from 7:00am to 7:30pm local time
674 # on Mon-Fri.
675 #
676 # The blackout period can also span midnight by setting
677 # hourBegin > hourEnd, eg:
678 #
679 #    $Conf{BlackoutPeriods} = [
680 #       {
681 #           hourBegin =>  7.0,
682 #           hourEnd   => 19.5,
683 #           weekDays  => [1, 2, 3, 4, 5],
684 #       },
685 #       {
686 #           hourBegin => 23,
687 #           hourEnd   =>  5,
688 #           weekDays  => [5, 6],
689 #       },
690 #    ];
691 #
692 # This specifies one blackout period from 7:00am to 7:30pm local time
693 # on Mon-Fri, and a second period from 11pm to 5am on Friday and
694 # Saturday night.
695 #
696 $Conf{BlackoutPeriods} = [
697     {
698         hourBegin =>  7.0,
699         hourEnd   => 19.5,
700         weekDays  => [1, 2, 3, 4, 5],
701     },
702 ];
703
704 #
705 # A backup of a share that has zero files is considered fatal. This is
706 # used to catch miscellaneous Xfer errors that result in no files being
707 # backed up.  If you have shares that might be empty (and therefore an
708 # empty backup is valid) you should set this flag to 0.
709 #
710 $Conf{BackupZeroFilesIsFatal} = 1;
711
712 ###########################################################################
713 # General per-PC configuration settings
714 # (can be overridden in the per-PC config.pl)
715 ###########################################################################
716 #
717 # What transport method to use to backup each host.  If you have
718 # a mixed set of WinXX and linux/unix hosts you will need to override
719 # this in the per-PC config.pl.
720 #
721 # The valid values are:
722 #
723 #   - 'smb':     backup and restore via smbclient and the SMB protocol.
724 #                Easiest choice for WinXX.
725 #
726 #   - 'rsync':   backup and restore via rsync (via rsh or ssh).
727 #                Best choice for linux/unix.  Good choice also for WinXX.
728 #
729 #   - 'rsyncd':  backup and restre via rsync daemon on the client.
730 #                Best choice for linux/unix if you have rsyncd running on
731 #                the client.  Good choice also for WinXX.
732 #
733 #   - 'tar':    backup and restore via tar, tar over ssh, rsh or nfs.
734 #               Good choice for linux/unix.
735 #
736 #   - 'archive': host is a special archive host.  Backups are not done.
737 #                An archive host is used to archive other host's backups
738 #                to permanent media, such as tape, CDR or DVD.
739 #               
740 #
741 $Conf{XferMethod} = 'smb';
742
743 #
744 # Level of verbosity in Xfer log files.  0 means be quiet, 1 will give
745 # will give one line per file, 2 will also show skipped files on
746 # incrementals, higher values give more output.
747 #
748 $Conf{XferLogLevel} = 1;
749
750 #
751 # Full path for smbclient. Security caution: normal users should not
752 # allowed to write to this file or directory.
753 #
754 # smbclient is from the Samba distribution. smbclient is used to
755 # actually extract the incremental or full dump of the share filesystem
756 # from the PC.
757 #
758 # This setting only matters if $Conf{XferMethod} = 'smb'.
759 #
760 $Conf{SmbClientPath} = '/usr/bin/smbclient';
761
762 #
763 # Commands to run smbclient for a full dump, incremental dump or a restore.
764 # This setting only matters if $Conf{XferMethod} = 'smb'.
765 #
766 # The following variables are substituted at run-time:
767 #
768 #    $smbClientPath   same as $Conf{SmbClientPath}
769 #    $host            host to backup/restore
770 #    $hostIP          host IP address
771 #    $shareName       share name
772 #    $userName        user name
773 #    $fileList        list of files to backup (based on exclude/include)
774 #    $I_option        optional -I option to smbclient
775 #    $X_option        exclude option (if $fileList is an exclude list)
776 #    $timeStampFile   start time for incremental dump
777 #
778 # If your smb share is read-only then direct restores will fail.
779 # You should set $Conf{SmbClientRestoreCmd} to undef and the
780 # corresponding CGI restore option will be removed.
781 #
782 $Conf{SmbClientFullCmd} = '$smbClientPath \\\\$host\\$shareName'
783             . ' $I_option -U $userName -E -N -d 1'
784             . ' -c tarmode\\ full -Tc$X_option - $fileList';
785
786 $Conf{SmbClientIncrCmd} = '$smbClientPath \\\\$host\\$shareName'
787             . ' $I_option -U $userName -E -N -d 1'
788             . ' -c tarmode\\ full -TcN$X_option $timeStampFile - $fileList';
789
790 $Conf{SmbClientRestoreCmd} = '$smbClientPath \\\\$host\\$shareName'
791             . ' $I_option -U $userName -E -N -d 1'
792             . ' -c tarmode\\ full -Tx -';
793
794 #
795 # Full command to run tar on the client.  GNU tar is required.  You will
796 # need to fill in the correct paths for ssh2 on the local host (server)
797 # and GNU tar on the client.  Security caution: normal users should not
798 # allowed to write to these executable files or directories.
799 #
800 # See the documentation for more information about setting up ssh2 keys.
801 #
802 # If you plan to use NFS then tar just runs locally and ssh2 is not needed.
803 # For example, assuming the client filesystem is mounted below /mnt/hostName,
804 # you could use something like:
805 #
806 #    $Conf{TarClientCmd} = '$tarPath -c -v -f - -C /mnt/$host/$shareName'
807 #                        . ' --totals';
808 #
809 # In the case of NFS or rsh you need to make sure BackupPC's privileges
810 # are sufficient to read all the files you want to backup.  Also, you
811 # will probably want to add "/proc" to $Conf{BackupFilesExclude}.
812 #
813 # The following variables are substituted at run-time:
814 #
815 #   $host        host name
816 #   $hostIP      host's IP address
817 #   $incrDate    newer-than date for incremental backups
818 #   $shareName   share name to backup (ie: top-level directory path)
819 #   $fileList    specific files to backup or exclude
820 #   $tarPath     same as $Conf{TarClientPath}
821 #   $sshPath     same as $Conf{SshPath}
822 #
823 # If a variable is followed by a "+" it is shell escaped.  This is
824 # necessary for the command part of ssh or rsh, since it ends up
825 # getting passed through the shell.
826 #
827 # This setting only matters if $Conf{XferMethod} = 'tar'.
828 #
829 $Conf{TarClientCmd} = '$sshPath -q -x -n -l root $host'
830                     . ' $tarPath -c -v -f - -C $shareName+'
831                     . ' --totals';
832
833 #
834 # Extra tar arguments for full backups.  Several variables are substituted at
835 # run-time.  See $Conf{TarClientCmd} for the list of variable substitutions.
836 #
837 # If you are running tar locally (ie: without rsh or ssh) then remove the
838 # "+" so that the argument is no longer shell escaped.
839 #
840 # This setting only matters if $Conf{XferMethod} = 'tar'.
841 #
842 $Conf{TarFullArgs} = '$fileList+';
843
844 #
845 # Extra tar arguments for incr backups.  Several variables are substituted at
846 # run-time.  See $Conf{TarClientCmd} for the list of variable substitutions.
847 #
848 # Note that GNU tar has several methods for specifying incremental backups,
849 # including:
850 #
851 #   --newer-mtime $incrDate+
852 #          This causes a file to be included if the modification time is
853 #          later than $incrDate (meaning its contents might have changed).
854 #          But changes in the ownership or modes will not qualify the
855 #          file to be included in an incremental.
856 #
857 #   --newer=$incrDate+
858 #          This causes the file to be included if any attribute of the
859 #          file is later than $incrDate, meaning either attributes or
860 #          the modification time.  This is the default method.  Do
861 #          not use --atime-preserve in $Conf{TarClientCmd} above,
862 #          otherwise resetting the atime (access time) counts as an
863 #          attribute change, meaning the file will always be included
864 #          in each new incremental dump.
865 #
866 # If you are running tar locally (ie: without rsh or ssh) then remove the
867 # "+" so that the argument is no longer shell escaped.
868 #
869 # This setting only matters if $Conf{XferMethod} = 'tar'.
870 #
871 $Conf{TarIncrArgs} = '--newer=$incrDate+ $fileList+';
872
873 #
874 # Full command to run tar for restore on the client.  GNU tar is required.
875 # This can be the same as $Conf{TarClientCmd}, with tar's -c replaced by -x
876 # and ssh's -n removed.
877 #
878 # See $Conf{TarClientCmd} for full details.
879 #
880 # This setting only matters if $Conf{XferMethod} = "tar".
881 #
882 # If you want to disable direct restores using tar, you should set
883 # $Conf{TarClientRestoreCmd} to undef and the corresponding CGI
884 # restore option will be removed.
885 #
886 $Conf{TarClientRestoreCmd} = '$sshPath -q -x -l root $host'
887                    . ' $tarPath -x -p --numeric-owner --same-owner'
888                    . ' -v -f - -C $shareName+';
889
890 #
891 # Full path for tar on the client. Security caution: normal users should not
892 # allowed to write to this file or directory.
893 #
894 # This setting only matters if $Conf{XferMethod} = 'tar'.
895 #
896 $Conf{TarClientPath} = '/bin/tar';
897
898 #
899 # Path to rsync executable on the client
900 #
901 $Conf{RsyncClientPath} = '/bin/rsync';
902
903 #
904 # Full command to run rsync on the client machine.  The following variables
905 # are substituted at run-time:
906 #
907 #        $host           host name being backed up
908 #        $hostIP         host's IP address
909 #        $shareName      share name to backup (ie: top-level directory path)
910 #        $rsyncPath      same as $Conf{RsyncClientPath}
911 #        $sshPath        same as $Conf{SshPath}
912 #        $argList        argument list, built from $Conf{RsyncArgs},
913 #                        $shareName, $Conf{BackupFilesExclude} and
914 #                        $Conf{BackupFilesOnly}
915 #
916 # This setting only matters if $Conf{XferMethod} = 'rsync'.
917 #
918 $Conf{RsyncClientCmd} = '$sshPath -q -x -l root $host $rsyncPath $argList+';
919
920 #
921 # Full command to run rsync for restore on the client.  The following
922 # variables are substituted at run-time:
923 #
924 #        $host           host name being backed up
925 #        $hostIP         host's IP address
926 #        $shareName      share name to backup (ie: top-level directory path)
927 #        $rsyncPath      same as $Conf{RsyncClientPath}
928 #        $sshPath        same as $Conf{SshPath}
929 #        $argList        argument list, built from $Conf{RsyncArgs},
930 #                        $shareName, $Conf{BackupFilesExclude} and
931 #                        $Conf{BackupFilesOnly}
932 #
933 # This setting only matters if $Conf{XferMethod} = 'rsync'.
934 #
935 $Conf{RsyncClientRestoreCmd} = '$sshPath -q -x -l root $host $rsyncPath $argList+';
936
937 #
938 # Share name to backup.  For $Conf{XferMethod} = "rsync" this should
939 # be a file system path, eg '/' or '/home'.
940 #
941 # For $Conf{XferMethod} = "rsyncd" this should be the name of the module
942 # to backup (ie: the name from /etc/rsynd.conf).
943 #
944 # This can also be a list of multiple file system paths or modules.
945 # For example, by adding --one-file-system to $Conf{RsyncArgs} you
946 # can backup each file system separately, which makes restoring one
947 # bad file system easier.  In this case you would list all of the mount
948 # points:
949 #
950 #     $Conf{RsyncShareName} = ['/', '/var', '/data', '/boot'];
951 #
952 $Conf{RsyncShareName} = '/';
953
954 #
955 # Rsync daemon port on the client, for $Conf{XferMethod} = "rsyncd".
956 #
957 $Conf{RsyncdClientPort} = 873;
958
959 #
960 # Rsync daemon user name on client, for $Conf{XferMethod} = "rsyncd".
961 # The user name and password are stored on the client in whatever file
962 # the "secrets file" parameter in rsyncd.conf points to
963 # (eg: /etc/rsyncd.secrets).
964 #
965 $Conf{RsyncdUserName} = '';
966
967 #
968 # Rsync daemon user name on client, for $Conf{XferMethod} = "rsyncd".
969 # The user name and password are stored on the client in whatever file
970 # the "secrets file" parameter in rsyncd.conf points to
971 # (eg: /etc/rsyncd.secrets).
972 #
973 $Conf{RsyncdPasswd} = '';
974
975 #
976 # Whether authentication is mandatory when connecting to the client's
977 # rsyncd.  By default this is on, ensuring that BackupPC will refuse to
978 # connect to an rsyncd on the client that is not password protected.
979 # Turn off at your own risk.
980 #
981 $Conf{RsyncdAuthRequired} = 1;
982
983 #
984 # Arguments to rsync for backup.  Do not edit the first set unless you
985 # have a thorough understanding of how File::RsyncP works.
986 #
987 # Examples of additional arguments that should work are --exclude/--include,
988 # eg:
989 #
990 #     $Conf{RsyncArgs} = [
991 #           # original arguments here
992 #           '-v',
993 #           '--exclude', '/proc',
994 #           '--exclude', '*.tmp',
995 #     ];
996 #
997 $Conf{RsyncArgs} = [
998             #
999             # Do not edit these!
1000             #
1001             '--numeric-ids',
1002             '--perms',
1003             '--owner',
1004             '--group',
1005             '--devices',
1006             '--links',
1007             '--times',
1008             '--block-size=2048',
1009             '--recursive',
1010
1011             #
1012             # If you are using a patched client rsync that supports the
1013             # --fixed-csumseed option (see http://backuppc.sourceforge.net),
1014             # then uncomment this to enabled rsync checksum cachcing
1015             #
1016             #'--fixed-csumseed',
1017
1018             #
1019             # Add additional arguments here
1020             #
1021 ];
1022
1023 #
1024 # Arguments to rsync for restore.  Do not edit the first set unless you
1025 # have a thorough understanding of how File::RsyncP works.
1026 #
1027 # If you want to disable direct restores using rsync (eg: is the module
1028 # is read-only), you should set $Conf{RsyncRestoreArgs} to undef and
1029 # the corresponding CGI restore option will be removed.
1030 #
1031 $Conf{RsyncRestoreArgs} = [
1032             #
1033             # Do not edit these!
1034             #
1035             '--numeric-ids',
1036             '--perms',
1037             '--owner',
1038             '--group',
1039             '--devices',
1040             '--links',
1041             '--times',
1042             '--block-size=2048',
1043             '--relative',
1044             '--ignore-times',
1045             '--recursive',
1046
1047             #
1048             # If you are using a patched client rsync that supports the
1049             # --fixed-csumseed option (see http://backuppc.sourceforge.net),
1050             # then uncomment this to enabled rsync checksum cachcing
1051             #
1052             #'--fixed-csumseed',
1053
1054             #
1055             # Add additional arguments here
1056             #
1057 ];
1058
1059 #
1060 # Archive Destination
1061 #
1062 # The Destination of the archive
1063 # e.g. /tmp for file archive or /dev/nst0 for device archive
1064 #
1065 $Conf{ArchiveDest} = '/tmp';
1066
1067 #
1068 # Archive Compression type
1069 #
1070 # The valid values are:
1071 #
1072 #   - 'none':  No Compression
1073 #
1074 #   - 'gzip':  Medium Compression. Recommended.
1075 #
1076 #   - 'bzip2': High Compression but takes longer.
1077 #
1078 $Conf{ArchiveComp} = 'gzip';
1079
1080 #
1081 # Archive Parity Files
1082 #
1083 # The amount of Parity data to generate, as a percentage
1084 # of the archive size.
1085 # Uses the commandline par2 (par2cmdline) available from
1086 # http://parchive.sourceforge.net
1087 #
1088 # Only useful for file dumps.
1089 #
1090 # Set to 0 to disable this feature.
1091 #
1092 $Conf{ArchivePar} = 0;
1093
1094 #
1095 # Archive Size Split
1096 #
1097 # Only for file archives. Splits the output into 
1098 # the specified size * 1,000,000.
1099 # e.g. to split into 650,000,000 bytes, specify 650 below.
1100 #
1101 $Conf{ArchiveSplit} = 650;
1102
1103 #
1104 # Archive Command
1105 #
1106 # This is the command that is called to actually run the archive process
1107 # for each host.  The following variables are substituted at run-time:
1108 #
1109 #   $Installdir    The installation directory of BackupPC
1110 #   $tarCreatePath The path to BackupPC_tarCreate
1111 #   $splitpath     The path to the split program
1112 #   $parpath       The path to the par2 program
1113 #   $host          The host to archive
1114 #   $backupnumber  The backup number of the host to archive
1115 #   $compression   The path to the compression program
1116 #   $compext       The extension assigned to the compression type
1117 #   $splitsize     The number of bytes to split archives into
1118 #   $archiveloc    The location to put the archive
1119 #   $parfile       The amount of parity data to create (percentage)
1120 #
1121 $Conf{ArchiveClientCmd} = '$Installdir/bin/BackupPC_archiveHost'
1122         . ' $tarCreatePath $splitpath $parpath $host $backupnumber'
1123         . ' $compression $compext $splitsize $archiveloc $parfile *';
1124
1125 #
1126 # Full path for ssh. Security caution: normal users should not
1127 # allowed to write to this file or directory.
1128 #
1129 $Conf{SshPath} = '/usr/bin/ssh';
1130
1131 #
1132 # Full path for nmblookup. Security caution: normal users should not
1133 # allowed to write to this file or directory.
1134 #
1135 # nmblookup is from the Samba distribution. nmblookup is used to get the
1136 # netbios name, necessary for DHCP hosts.
1137 #
1138 $Conf{NmbLookupPath} = '/usr/bin/nmblookup';
1139
1140 #
1141 # NmbLookup command.  Given an IP address, does an nmblookup on that
1142 # IP address.  The following variables are substituted at run-time:
1143 #
1144 #   $nmbLookupPath      path to nmblookup ($Conf{NmbLookupPath})
1145 #   $host               IP address
1146 #
1147 # This command is only used for DHCP hosts: given an IP address, this
1148 # command should try to find its NetBios name.
1149 #
1150 $Conf{NmbLookupCmd} = '$nmbLookupPath -A $host';
1151
1152 #
1153 # NmbLookup command.  Given a netbios name, finds that host by doing
1154 # a NetBios lookup.  Several variables are substituted at run-time:
1155 #
1156 #   $nmbLookupPath      path to nmblookup ($Conf{NmbLookupPath})
1157 #   $host               NetBios name
1158 #
1159 # In some cases you might need to change the broadcast address, for
1160 # example if nmblookup uses 192.168.255.255 by default and you find
1161 # that doesn't work, try 192.168.1.255 (or your equivalent class C
1162 # address) using the -B option:
1163 #
1164 #    $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath -B 192.168.1.255 $host';
1165 #
1166 # If you use a WINS server and your machines don't respond to
1167 # multicast NetBios requests you can use this (replace 1.2.3.4
1168 # with the IP address of your WINS server):
1169 #
1170 #    $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath -R -U 1.2.3.4 $host';
1171 #
1172 # This is preferred over multicast since it minimizes network traffic.
1173 #
1174 # Experiment manually for your site to see what form of nmblookup command
1175 # works.
1176 #
1177 $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath $host';
1178
1179 #
1180 # For fixed IP address hosts, BackupPC_dump can also verify the netbios
1181 # name to ensure it matches the host name.  An error is generated if
1182 # they do not match.  Typically this flag is off.  But if you are going
1183 # to transition a bunch of machines from fixed host addresses to DHCP,
1184 # setting this flag is a great way to verify that the machines have
1185 # their netbios name set correctly before turning on DCHP.
1186 #
1187 $Conf{FixedIPNetBiosNameCheck} = 0;
1188
1189 #
1190 # Full path to the ping command.  Security caution: normal users
1191 # should not be allowed to write to this file or directory.
1192 #
1193 # If you want to disable ping checking, set this to some program
1194 # that exits with 0 status, eg:
1195 #
1196 #     $Conf{PingPath} = '/bin/echo';
1197 #
1198 $Conf{PingPath} = '/bin/ping';
1199
1200 #
1201 # Ping command.  The following variables are substituted at run-time:
1202 #
1203 #   $pingPath      path to ping ($Conf{PingPath})
1204 #   $host          host name
1205 #
1206 # Wade Brown reports that on solaris 2.6 and 2.7 ping -s returns the wrong
1207 # exit status (0 even on failure).  Replace with "ping $host 1", which
1208 # gets the correct exit status but we don't get the round-trip time.
1209 #
1210 $Conf{PingCmd} = '$pingPath -c 1 $host';
1211
1212 #
1213 # Path to init.d script and command to use that script to start the
1214 # server from the CGI interface.  The following variables are substituted
1215 # at run-time:
1216 #
1217 #   $sshPath           path to ssh ($Conf{SshPath})
1218 #   $serverHost        same as $Conf{ServerHost}
1219 #   $serverInitdPath   path to init.d script ($Conf{ServerInitdPath})
1220 #
1221 # Example:
1222 #
1223 # $Conf{ServerInitdPath}     = '/etc/init.d/backuppc';
1224 # $Conf{ServerInitdStartCmd} = '$sshPath -q -x -l root $serverHost'
1225 #                            . ' $serverInitdPath start'
1226 #                            . ' < /dev/null >& /dev/null';
1227 #
1228 $Conf{ServerInitdPath} = '';
1229 $Conf{ServerInitdStartCmd} = '';
1230
1231 #
1232 # Compression level to use on files.  0 means no compression.  Compression
1233 # levels can be from 1 (least cpu time, slightly worse compression) to
1234 # 9 (most cpu time, slightly better compression).  The recommended value
1235 # is 3.  Changing to 5, for example, will take maybe 20% more cpu time
1236 # and will get another 2-3% additional compression. See the zlib
1237 # documentation for more information about compression levels.
1238 #
1239 # Changing compression on or off after backups have already been done
1240 # will require both compressed and uncompressed pool files to be stored.
1241 # This will increase the pool storage requirements, at least until all
1242 # the old backups expire and are deleted.
1243 #
1244 # It is ok to change the compression value (from one non-zero value to
1245 # another non-zero value) after dumps are already done.  Since BackupPC
1246 # matches pool files by comparing the uncompressed versions, it will still
1247 # correctly match new incoming files against existing pool files.  The
1248 # new compression level will take effect only for new files that are
1249 # newly compressed and added to the pool.
1250 #
1251 # If compression was off and you are enabling compression for the first
1252 # time you can use the BackupPC_compressPool utility to compress the
1253 # pool.  This avoids having the pool grow to accommodate both compressed
1254 # and uncompressed backups.  See the documentation for more information.
1255 #
1256 # Note: compression needs the Compress::Zlib perl library.  If the
1257 # Compress::Zlib library can't be found then $Conf{CompressLevel} is
1258 # forced to 0 (compression off).
1259 #
1260 $Conf{CompressLevel} = 0;
1261
1262 #
1263 # Maximum round-trip ping time in milliseconds.  This threshold is set
1264 # to avoid backing up PCs that are remotely connected through WAN or
1265 # dialup connections.  The output from ping -s (assuming it is supported
1266 # on your system) is used to check the round-trip packet time.  On your
1267 # local LAN round-trip times should be much less than 20msec.  On most
1268 # WAN or dialup connections the round-trip time will be typically more
1269 # than 20msec.  Tune if necessary.
1270 #
1271 $Conf{PingMaxMsec} = 20;
1272
1273 #
1274 # Timeout in seconds when listening for the transport program's
1275 # (smbclient, tar etc) stdout. If no output is received during this
1276 # time, then it is assumed that something has wedged during a backup,
1277 # and the backup is terminated.
1278 #
1279 # Note that stdout buffering combined with huge files being backed up
1280 # could cause longish delays in the output from smbclient that
1281 # BackupPC_dump sees, so in rare cases you might want to increase
1282 # this value.
1283 #
1284 # Despite the name, this parameter sets the timeout for all transport
1285 # methods (tar, smb etc).
1286 #
1287 $Conf{ClientTimeout} = 7200;
1288
1289 #
1290 # Maximum number of log files we keep around in each PC's directory
1291 # (ie: pc/$host).  These files are aged monthly.  A setting of 12
1292 # means there will be at most the files LOG, LOG.0, LOG.1, ... LOG.11
1293 # in the pc/$host directory (ie: about a years worth).  (Except this
1294 # month's LOG, these files will have a .z extension if compression
1295 # is on).
1296 #
1297 # If you decrease this number after BackupPC has been running for a
1298 # while you will have to manually remove the older log files.
1299 #
1300 $Conf{MaxOldPerPCLogFiles} = 12;
1301
1302 #
1303 # Optional commands to run before and after dumps and restores.
1304 # Stdout from these commands will be written to the Xfer (or Restore)
1305 # log file.  One example of using these commands would be to
1306 # shut down and restart a database server, or to dump a database
1307 # to files for backup.  Example:
1308 #
1309 #    $Conf{DumpPreUserCmd} = '$sshPath -q -x -l root $host /usr/bin/dumpMysql';
1310 #
1311 # The following variable substitutions are made at run time for
1312 # $Conf{DumpPreUserCmd} and $Conf{DumpPostUserCmd}:
1313 #
1314 #        $type         type of dump (incr or full)
1315 #        $xferOK       1 if the dump succeeded, 0 if it didn't
1316 #        $client       client name being backed up
1317 #        $host         host name (could be different from client name if
1318 #                                 $Conf{ClientNameAlias} is set)
1319 #        $hostIP       IP address of host
1320 #        $user         user name from the hosts file
1321 #        $moreUsers    list of additional users from the hosts file
1322 #        $share        the first share name
1323 #        $shares       list of all the share names
1324 #        $XferMethod   value of $Conf{XferMethod} (eg: tar, rsync, smb)
1325 #        $sshPath      value of $Conf{SshPath},
1326 #
1327 # The following variable substitutions are made at run time for
1328 # $Conf{RestorePreUserCmd} and $Conf{RestorePostUserCmd}:
1329 #
1330 #        $client       client name being backed up
1331 #        $xferOK       1 if the restore succeeded, 0 if it didn't
1332 #        $host         host name (could be different from client name if
1333 #                                 $Conf{ClientNameAlias} is set)
1334 #        $hostIP       IP address of host
1335 #        $user         user name from the hosts file
1336 #        $moreUsers    list of additional users from the hosts file
1337 #        $share        the first share name
1338 #        $XferMethod   value of $Conf{XferMethod} (eg: tar, rsync, smb)
1339 #        $sshPath      value of $Conf{SshPath},
1340 #        $type         set to "restore"
1341 #        $bkupSrcHost  host name of the restore source
1342 #        $bkupSrcShare share name of the restore source
1343 #        $bkupSrcNum   backup number of the restore source
1344 #        $pathHdrSrc   common starting path of restore source
1345 #        $pathHdrDest  common starting path of destination
1346 #        $fileList     list of files being restored
1347 #
1348 # The following variable substitutions are made at run time for
1349 # $Conf{ArchivePreUserCmd} and $Conf{ArchivePostUserCmd}:
1350 #
1351 #        $client       client name being backed up
1352 #        $xferOK       1 if the archive succeeded, 0 if it didn't
1353 #        $host         Name of the archive host
1354 #        $user         user name from the hosts file
1355 #        $share        the first share name
1356 #        $XferMethod   value of $Conf{XferMethod} (eg: tar, rsync, smb)
1357 #        $HostList     list of hosts being archived
1358 #        $BackupList   list of backup numbers for the hosts being archived
1359 #        $archiveloc   location where the archive is sent to
1360 #        $parfile      amount of parity data being generated (percentage)
1361 #        $compression  compression program being used (eg: cat, gzip, bzip2)
1362 #        $compext      extension used for compression type (eg: raw, gz, bz2)
1363 #        $splitsize    size of the files that the archive creates
1364 #        $sshPath      value of $Conf{SshPath},
1365 #        $type         set to "archive"
1366 #
1367 $Conf{DumpPreUserCmd}     = undef;
1368 $Conf{DumpPostUserCmd}    = undef;
1369 $Conf{RestorePreUserCmd}  = undef;
1370 $Conf{RestorePostUserCmd} = undef;
1371 $Conf{ArchivePreUserCmd}  = undef;
1372 $Conf{ArchivePostUserCmd} = undef;
1373
1374 #
1375 # Override the client's host name.  This allows multiple clients
1376 # to all refer to the same physical host.  This should only be
1377 # set in the per-PC config file and is only used by BackupPC at
1378 # the last moment prior to generating the command used to backup
1379 # that machine (ie: the value of $Conf{ClientNameAlias} is invisible
1380 # everywhere else in BackupPC).  The setting can be a host name or
1381 # IP address, eg:
1382 #
1383 #         $Conf{ClientNameAlias} = 'realHostName';
1384 #         $Conf{ClientNameAlias} = '192.1.1.15';
1385 #
1386 # will cause the relevant smb/tar/rsync backup/restore commands to be
1387 # directed to realHostName, not the client name.
1388 #
1389 # Note: this setting doesn't work for hosts with DHCP set to 1.
1390 #
1391 $Conf{ClientNameAlias} = undef;
1392
1393 #
1394 # Advanced option for asking BackupPC to load additional perl modules.
1395 # Can be a list (array ref) of module names to load at startup.
1396 #
1397 $Conf{PerlModuleLoad}     = undef;
1398
1399 ###########################################################################
1400 # Email reminders, status and messages
1401 # (can be overridden in the per-PC config.pl)
1402 ###########################################################################
1403 #
1404 # Full path to the sendmail command.  Security caution: normal users
1405 # should not allowed to write to this file or directory.
1406 #
1407 $Conf{SendmailPath} = '/usr/sbin/sendmail';
1408
1409 #
1410 # Minimum period between consecutive emails to a single user.
1411 # This tries to keep annoying email to users to a reasonable
1412 # level.  Email checks are done nightly, so this number is effectively
1413 # rounded up (ie: 2.5 means a user will never receive email more
1414 # than once every 3 days).
1415 #
1416 $Conf{EMailNotifyMinDays} = 2.5;
1417
1418 #
1419 # Name to use as the "from" name for email.  Depending upon your mail
1420 # handler this is either a plain name (eg: "admin") or a fully-qualified
1421 # name (eg: "admin@mydomain.com").
1422 #
1423 $Conf{EMailFromUserName} = '';
1424
1425 #
1426 # Destination address to an administrative user who will receive a
1427 # nightly email with warnings and errors.  If there are no warnings
1428 # or errors then no email will be sent.  Depending upon your mail
1429 # handler this is either a plain name (eg: "admin") or a fully-qualified
1430 # name (eg: "admin@mydomain.com").
1431 #
1432 $Conf{EMailAdminUserName} = '';
1433
1434 #
1435 # Destination domain name for email sent to users.  By default
1436 # this is empty, meaning email is sent to plain, unqualified
1437 # addresses.  Otherwise, set it to the destintation domain, eg:
1438 #
1439 #    $Cong{EMailUserDestDomain} = '@mydomain.com';
1440 #
1441 # With this setting user email will be set to 'user@mydomain.com'.
1442 #
1443 $Conf{EMailUserDestDomain} = '';
1444
1445 #
1446 # This subject and message is sent to a user if their PC has never been
1447 # backed up.
1448 #
1449 # These values are language-dependent.  The default versions can be
1450 # found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
1451 # need to change the message, copy it here and edit it, eg:
1452 #
1453 #   $Conf{EMailNoBackupEverMesg} = <<'EOF';
1454 #   To: $user$domain
1455 #   cc:
1456 #   Subject: $subj
1457 #   
1458 #   Dear $userName,
1459 #   
1460 #   This is a site-specific email message.
1461 #   EOF
1462 #
1463 $Conf{EMailNoBackupEverSubj} = undef;
1464 $Conf{EMailNoBackupEverMesg} = undef;
1465
1466 #
1467 # How old the most recent backup has to be before notifying user.
1468 # When there have been no backups in this number of days the user
1469 # is sent an email.
1470 #
1471 $Conf{EMailNotifyOldBackupDays} = 7.0;
1472
1473 #
1474 # This subject and message is sent to a user if their PC has not recently
1475 # been backed up (ie: more than $Conf{EMailNotifyOldBackupDays} days ago).
1476 #
1477 # These values are language-dependent.  The default versions can be
1478 # found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
1479 # need to change the message, copy it here and edit it, eg:
1480 #
1481 #   $Conf{EMailNoBackupRecentMesg} = <<'EOF';
1482 #   To: $user$domain
1483 #   cc:
1484 #   Subject: $subj
1485 #   
1486 #   Dear $userName,
1487 #   
1488 #   This is a site-specific email message.
1489 #   EOF
1490 #
1491 $Conf{EMailNoBackupRecentSubj} = undef;
1492 $Conf{EMailNoBackupRecentMesg} = undef;
1493
1494 #
1495 # How old the most recent backup of Outlook files has to be before
1496 # notifying user.
1497 #
1498 $Conf{EMailNotifyOldOutlookDays} = 5.0;
1499
1500 #
1501 # This subject and message is sent to a user if their Outlook files have
1502 # not recently been backed up (ie: more than $Conf{EMailNotifyOldOutlookDays}
1503 # days ago).
1504 #
1505 # These values are language-dependent.  The default versions can be
1506 # found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
1507 # need to change the message, copy it here and edit it, eg:
1508 #
1509 #   $Conf{EMailOutlookBackupMesg} = <<'EOF';
1510 #   To: $user$domain
1511 #   cc:
1512 #   Subject: $subj
1513 #   
1514 #   Dear $userName,
1515 #   
1516 #   This is a site-specific email message.
1517 #   EOF
1518 #
1519 $Conf{EMailOutlookBackupSubj} = undef;
1520 $Conf{EMailOutlookBackupMesg} = undef;
1521
1522 ###########################################################################
1523 # CGI user interface configuration settings
1524 # (can be overridden in the per-PC config.pl)
1525 ###########################################################################
1526 #
1527 # Normal users can only access information specific to their host.
1528 # They can start/stop/browse/restore backups.
1529 #
1530 # Administrative users have full access to all hosts, plus overall
1531 # status and log information.
1532 #
1533 # The administrative users are the union of the unix/linux group
1534 # $Conf{CgiAdminUserGroup} and the manual list of users, separated
1535 # by spaces, in $Conf{CgiAdminUsers}. If you don't want a group or
1536 # manual list of users set the corresponding configuration setting
1537 # to undef or an empty string.
1538 #
1539 # If you want every user to have admin privileges (careful!), set
1540 # $Conf{CgiAdminUsers} = '*'.
1541 #
1542 # Examples:
1543 #    $Conf{CgiAdminUserGroup} = 'admin';
1544 #    $Conf{CgiAdminUsers}     = 'craig celia';
1545 #    --> administrative users are the union of group admin, plus
1546 #      craig and celia.
1547 #
1548 #    $Conf{CgiAdminUserGroup} = '';
1549 #    $Conf{CgiAdminUsers}     = 'craig celia';
1550 #    --> administrative users are only craig and celia'.
1551 #
1552 $Conf{CgiAdminUserGroup} = '';
1553 $Conf{CgiAdminUsers}     = '';
1554
1555 #
1556 # URL of the BackupPC_Admin CGI script.  Used for email messages.
1557 #
1558 $Conf{CgiURL} = undef;
1559
1560 #   
1561 # Language to use.  See lib/BackupPC/Lang for the list of supported
1562 # languages, which include English (en), French (fr), Spanish (es),
1563 # German (de), and Italian (it).
1564 #
1565 # Currently the Language setting applies to the CGI interface and email
1566 # messages sent to users.  Log files and other text are still in English.
1567 #
1568 $Conf{Language} = 'en';
1569
1570 #
1571 # User names that are rendered by the CGI interface can be turned
1572 # into links into their home page or other information about the
1573 # user.  To set this up you need to create two sprintf() strings,
1574 # that each contain a single '%s' that will be replaced by the user
1575 # name.  The default is a mailto: link.
1576 #
1577 # $Conf{CgiUserHomePageCheck} should be an absolute file path that
1578 # is used to check (via "-f") that the user has a valid home page.
1579 # Set this to undef or an empty string to turn off this check.
1580 #
1581 # $Conf{CgiUserUrlCreate} should be a full URL that points to the
1582 # user's home page.  Set this to undef or an empty string to turn
1583 # off generation of URLs for user names.
1584 #
1585 # Example:
1586 #    $Conf{CgiUserHomePageCheck} = '/var/www/html/users/%s.html';
1587 #    $Conf{CgiUserUrlCreate}     = 'http://myhost/users/%s.html';
1588 #    --> if /var/www/html/users/craig.html exists, then 'craig' will
1589 #      be rendered as a link to http://myhost/users/craig.html.
1590 #
1591 $Conf{CgiUserHomePageCheck} = '';
1592 $Conf{CgiUserUrlCreate}     = 'mailto:%s';
1593
1594 #
1595 # Date display format for CGI interface.  True for US-style dates (MM/DD)
1596 # and zero for international dates (DD/MM).
1597 #
1598 $Conf{CgiDateFormatMMDD} = 1;
1599
1600 #
1601 # If set, the complete list of hosts appears in the left navigation
1602 # bar pull-down for administrators.  Otherwise, just the hosts for which
1603 # the user is listed in the host file (as either the user or in moreUsers)
1604 # are displayed.
1605 #
1606 $Conf{CgiNavBarAdminAllHosts} = 1;
1607
1608 #
1609 # Hilight colors based on status that are used in the PC summary page.
1610 #
1611 $Conf{CgiStatusHilightColor} = {
1612     Reason_backup_failed           => '#ffcccc',
1613     Reason_backup_done             => '#ccffcc',
1614     Reason_no_ping                 => '#ffff99',
1615     Reason_backup_canceled_by_user => '#ff9900',
1616     Status_backup_in_progress      => '#66cc99',
1617 };
1618
1619 #
1620 # Additional CGI header text.
1621 #
1622 $Conf{CgiHeaders} = '<meta http-equiv="pragma" content="no-cache">';
1623
1624 #
1625 # Directory where images are stored.  This directory should be below
1626 # Apache's DocumentRoot.  This value isn't used by BackupPC but is
1627 # used by configure.pl when you upgrade BackupPC.
1628 #
1629 # Example:
1630 #     $Conf{CgiImageDir} = '/usr/local/apache/htdocs/BackupPC';
1631 #
1632 $Conf{CgiImageDir} = '';
1633
1634 #
1635 # Additional mappings of file name extenions to Content-Type for
1636 # individual file restore.  See $Ext2ContentType in BackupPC_Admin
1637 # for the default setting.  You can add additional settings here,
1638 # or override any default settings.  Example:
1639 #
1640 #     $Conf{CgiExt2ContentType} = {
1641 #                 'pl'  => 'text/plain',
1642 #          };
1643 #
1644 $Conf{CgiExt2ContentType} = { };
1645
1646 #
1647 # URL (without the leading http://host) for BackupPC's image directory.
1648 # The CGI script uses this value to serve up image files.
1649 #
1650 # Example:
1651 #     $Conf{CgiImageDirURL} = '/BackupPC';
1652 #
1653 $Conf{CgiImageDirURL} = '';
1654
1655 #
1656 # CSS stylesheet for the CGI interface.  It is stored in the
1657 # $Conf{CgiImageDir} directory and accessed via the
1658 # $Conf{CgiImageDirURL} URL.
1659 #
1660 $Conf{CgiCSSFile} = 'BackupPC_stnd.css';