62c301a8a2722c6ae3cb0005650a3df17f764ce3
[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 # The BackupPC user.
274 #
275 $Conf{BackupPCUser} = '';
276
277 #
278 # Important installation directories:
279 #
280 #   TopDir     - where all the backup data is stored
281 #   ConfDir    - where the main config and hosts files resides
282 #   LogDir     - where log files and other transient information
283 #   InstallDir - where the bin, lib and doc installation dirs reside.
284 #                Note: you cannot change this value since all the
285 #                perl scripts include this path.  You must reinstall
286 #                with configure.pl to change InstallDir.
287 #   CgiDir     - Apache CGI directory for BackupPC_Admin
288 #
289 $Conf{TopDir}      = '';
290 $Conf{ConfDir}     = '';
291 $Conf{LogDir}      = '';
292 $Conf{InstallDir}  = '';
293 $Conf{CgiDir}      = '';
294
295 #
296 # Whether BackupPC and the CGI script BackupPC_Admin verify that they
297 # are really running as user $Conf{BackupPCUser}.  If this flag is set
298 # and the effective user id (euid) differs from $Conf{BackupPCUser}
299 # then both scripts exit with an error.  This catches cases where
300 # BackupPC might be accidently started as root or the wrong user,
301 # or if the CGI script is not installed correctly.
302 #
303 $Conf{BackupPCUserVerify} = 1;
304
305 #
306 # Maximum number of hardlinks supported by the $TopDir file system
307 # that BackupPC uses.  Most linux or unix file systems should support
308 # at least 32000 hardlinks per file, or 64000 in other cases.  If a pool
309 # file already has this number of hardlinks, a new pool file is created
310 # so that new hardlinks can be accommodated.  This limit will only
311 # be hit if an identical file appears at least this number of times
312 # across all the backups.
313 #
314 $Conf{HardLinkMax} = 31999;
315
316 #
317 # Advanced option for asking BackupPC to load additional perl modules.
318 # Can be a list (array ref) of module names to load at startup.
319 #
320 $Conf{PerlModuleLoad}     = undef;
321
322 #
323 # Path to init.d script and command to use that script to start the
324 # server from the CGI interface.  The following variables are substituted
325 # at run-time:
326 #
327 #   $sshPath           path to ssh ($Conf{SshPath})
328 #   $serverHost        same as $Conf{ServerHost}
329 #   $serverInitdPath   path to init.d script ($Conf{ServerInitdPath})
330 #
331 # Example:
332 #
333 # $Conf{ServerInitdPath}     = '/etc/init.d/backuppc';
334 # $Conf{ServerInitdStartCmd} = '$sshPath -q -x -l root $serverHost'
335 #                            . ' $serverInitdPath start'
336 #                            . ' < /dev/null >& /dev/null';
337 #
338 $Conf{ServerInitdPath} = '';
339 $Conf{ServerInitdStartCmd} = '';
340
341
342 ###########################################################################
343 # What to backup and when to do it
344 # (can be overridden in the per-PC config.pl)
345 ###########################################################################
346 #
347 # Minimum period in days between full backups. A full dump will only be
348 # done if at least this much time has elapsed since the last full dump,
349 # and at least $Conf{IncrPeriod} days has elapsed since the last
350 # successful dump.
351 #
352 # Typically this is set slightly less than an integer number of days. The
353 # time taken for the backup, plus the granularity of $Conf{WakeupSchedule}
354 # will make the actual backup interval a bit longer.
355 #
356 $Conf{FullPeriod} = 6.97;
357
358 #
359 # Minimum period in days between incremental backups (a user requested
360 # incremental backup will be done anytime on demand).
361 #
362 # Typically this is set slightly less than an integer number of days. The
363 # time taken for the backup, plus the granularity of $Conf{WakeupSchedule}
364 # will make the actual backup interval a bit longer.
365 #
366 $Conf{IncrPeriod} = 0.97;
367
368 #
369 # Number of full backups to keep.  Must be >= 1.
370 #
371 # In the steady state, each time a full backup completes successfully
372 # the oldest one is removed.  If this number is decreased, the
373 # extra old backups will be removed.
374 #
375 # If filling of incremental dumps is off the oldest backup always
376 # has to be a full (ie: filled) dump.  This might mean one or two
377 # extra full dumps are kept until the oldest incremental backups expire.
378 #
379 # Exponential backup expiry is also supported.  This allows you to specify:
380 #
381 #   - num fulls to keep at intervals of 1 * $Conf{FullPeriod}, followed by
382 #   - num fulls to keep at intervals of 2 * $Conf{FullPeriod},
383 #   - num fulls to keep at intervals of 4 * $Conf{FullPeriod},
384 #   - num fulls to keep at intervals of 8 * $Conf{FullPeriod},
385 #   - num fulls to keep at intervals of 16 * $Conf{FullPeriod},
386 #
387 # and so on.  This works by deleting every other full as each expiry
388 # boundary is crossed.
389 #
390 # Exponential expiry is specified using an array for $Conf{FullKeepCnt}:
391 #
392 #   $Conf{FullKeepCnt} = [4, 2, 3];
393 #
394 # Entry #n specifies how many fulls to keep at an interval of
395 # 2^n * $Conf{FullPeriod} (ie: 1, 2, 4, 8, 16, 32, ...).
396 #
397 # The example above specifies keeping 4 of the most recent full backups
398 # (1 week interval) two full backups at 2 week intervals, and 3 full
399 # backups at 4 week intervals, eg:
400 #
401 #    full 0 19 weeks old   \
402 #    full 1 15 weeks old    >---  3 backups at 4 * $Conf{FullPeriod}
403 #    full 2 11 weeks old   / 
404 #    full 3  7 weeks old   \____  2 backups at 2 * $Conf{FullPeriod}
405 #    full 4  5 weeks old   /
406 #    full 5  3 weeks old   \
407 #    full 6  2 weeks old    \___  4 backups at 1 * $Conf{FullPeriod}
408 #    full 7  1 week old     /
409 #    full 8  current       /
410 #
411 # On a given week the spacing might be less than shown as each backup
412 # ages through each expiry period.  For example, one week later, a
413 # new full is completed and the oldest is deleted, giving:
414 #
415 #    full 0 16 weeks old   \
416 #    full 1 12 weeks old    >---  3 backups at 4 * $Conf{FullPeriod}
417 #    full 2  8 weeks old   / 
418 #    full 3  6 weeks old   \____  2 backups at 2 * $Conf{FullPeriod}
419 #    full 4  4 weeks old   /
420 #    full 5  3 weeks old   \
421 #    full 6  2 weeks old    \___  4 backups at 1 * $Conf{FullPeriod}
422 #    full 7  1 week old     /
423 #    full 8  current       /
424 #
425 # You can specify 0 as a count (except in the first entry), and the
426 # array can be as long as you wish.  For example:
427 #
428 #   $Conf{FullKeepCnt} = [4, 0, 4, 0, 0, 2];
429 #
430 # This will keep 10 full dumps, 4 most recent at 1 * $Conf{FullPeriod},
431 # followed by 4 at an interval of 4 * $Conf{FullPeriod} (approx 1 month
432 # apart), and then 2 at an interval of 32 * $Conf{FullPeriod} (approx
433 # 7-8 months apart).
434 #
435 # Example: these two settings are equivalent and both keep just
436 # the four most recent full dumps:
437 #
438 #    $Conf{FullKeepCnt} = 4;
439 #    $Conf{FullKeepCnt} = [4];
440 #
441 $Conf{FullKeepCnt} = 1;
442
443 #
444 # Very old full backups are removed after $Conf{FullAgeMax} days.  However,
445 # we keep at least $Conf{FullKeepCntMin} full backups no matter how old
446 # they are.
447 #
448 # Note that $Conf{FullAgeMax} will be increased to $Conf{FullKeepCnt}
449 # times $Conf{FullPeriod} if $Conf{FullKeepCnt} specifies enough
450 # full backups to exceed $Conf{FullAgeMax}.
451 #
452 $Conf{FullKeepCntMin} = 1;
453 $Conf{FullAgeMax}     = 90;
454
455 #
456 # Number of incremental backups to keep.  Must be >= 1.
457 #
458 # In the steady state, each time an incr backup completes successfully
459 # the oldest one is removed.  If this number is decreased, the
460 # extra old backups will be removed.
461 #
462 $Conf{IncrKeepCnt} = 6;
463
464 #
465 # Very old incremental backups are removed after $Conf{IncrAgeMax} days.
466 # However, we keep at least $Conf{IncrKeepCntMin} incremental backups no
467 # matter how old they are.
468 #
469 $Conf{IncrKeepCntMin} = 1;
470 $Conf{IncrAgeMax}     = 30;
471
472 #
473 # Level of each incremental.  "Level" follows the terminology
474 # of dump(1).  A full backup has level 0.  A new incremental
475 # of level N will backup all files that have changed since
476 # the most recent backup of a lower level.
477 #
478 # The entries of $Conf{IncrLevels} apply in order to each
479 # incremental after each full backup.  It wraps around until
480 # the next full backup.  For example, these two settings
481 # have the same effect:
482 #
483 #       $Conf{IncrLevels} = [1, 2, 3];
484 #       $Conf{IncrLevels} = [1, 2, 3, 1, 2, 3];
485 #
486 # This means the 1st and 4th incrementals (level 1) go all
487 # the way back to the full.  The 2nd and 3rd (and 5th and
488 # 6th) backups just go back to the immediate preceeding
489 # incremental.
490 #
491 # Specifying a sequence of multi-level incrementals will
492 # usually mean more than $Conf{IncrKeepCnt} incrementals will
493 # need to be kept, since lower level incrementals are needed
494 # to merge a complete view of a backup.  For example, with
495 #
496 #       $Conf{FullPeriod}  = 7;
497 #       $Conf{IncrPeriod}  = 1;
498 #       $Conf{IncrKeepCnt} = 6;
499 #       $Conf{IncrLevels}  = [1, 2, 3, 4, 5, 6];
500 #
501 # there will be up to 11 incrementals in this case: 
502 #
503 #       backup #0  (full, level 0, oldest)
504 #       backup #1  (incr, level 1)
505 #       backup #2  (incr, level 2)
506 #       backup #3  (incr, level 3)
507 #       backup #4  (incr, level 4)
508 #       backup #5  (incr, level 5)
509 #       backup #6  (incr, level 6)
510 #       backup #7  (full, level 0)
511 #       backup #8  (incr, level 1)
512 #       backup #9  (incr, level 2)
513 #       backup #10 (incr, level 3)
514 #       backup #11 (incr, level 4)
515 #       backup #12 (incr, level 5, newest)
516 #
517 # Backup #1 (the oldest level 1 incremental) can't be deleted
518 # since backups 2..6 depend on it.  Those 6 incrementals can't
519 # all be deleted since that would only leave 5 (#8..12).
520 # When the next incremental happens (level 6), the complete
521 # set of 6 older incrementals (#1..6) will be deleted, since
522 # that maintains the required number ($Conf{IncrKeepCnt})
523 # of incrementals.  This situation is reduced if you set
524 # shorter chains of multi-level incrementals, eg:
525 #
526 #       $Conf{IncrLevels}  = [1, 2, 3];
527 #
528 # would only have up to 2 extra incremenals before all 3
529 # are deleted.
530 #
531 # BackupPC as usual merges the full and the sequence
532 # of incrementals together so each incremental can be
533 # browsed and restored as though it is a complete backup.
534 # If you specify a long chain of incrementals then more
535 # backups need to be merged when browsing, restoring,
536 # or getting the starting point for rsync backups.
537 # In the example above (levels 1..6), browing backup
538 # #6 requires 7 different backups (#0..6) to be merged.
539 #
540 # Because of this merging and the additional incrementals
541 # that need to be kept, it is recommended that some
542 # level 1 incrementals be included in $Conf{IncrLevels}.
543 #
544 # Prior to version 3.0 incrementals were always level 1,
545 # meaning each incremental backed up all the files that
546 # changed since the last full.
547 #
548 $Conf{IncrLevels} = [1];
549
550 #
551 # Disable all full and incremental backups.  These settings are
552 # useful for a client that is no longer being backed up
553 # (eg: a retired machine), but you wish to keep the last
554 # backups available for browsing or restoring to other machines.
555 #
556 # There are three values for $Conf{BackupsDisable}:
557 #
558 #   0    Backups are enabled.
559 #
560 #   1    Don't do any regular backups on this client.  Manually
561 #        requested backups (via the CGI interface) will still occur.
562 #
563 #   2    Don't do any backups on this client.  Manually requested
564 #        backups (via the CGI interface) will be ignored.
565 #
566 # In versions prior to 3.0 Backups were disabled by setting
567 # $Conf{FullPeriod} to -1 or -2.
568 #
569 $Conf{BackupsDisable} = 0;
570
571 #
572 # A failed full backup is saved as a partial backup.  The rsync
573 # XferMethod can take advantage of the partial full when the next
574 # backup is run. This parameter sets the age of the partial full
575 # in days: if the partial backup is older than this number of
576 # days, then rsync will ignore (not use) the partial full when
577 # the next backup is run.  If you set this to a negative value
578 # then no partials will be saved.  If you set this to 0, partials
579 # will be saved, but will not be used by the next backup.
580 #
581 # The default setting of 3 days means that a partial older than
582 # 3 days is ignored when the next full backup is done.
583 #
584 $Conf{PartialAgeMax} = 3;
585
586 #
587 # Whether incremental backups are filled.  "Filling" means that the
588 # most recent full (or filled) dump is merged into the new incremental
589 # dump using hardlinks.  This makes an incremental dump look like a
590 # full dump.  Prior to v1.03 all incremental backups were filled.
591 # In v1.4.0 and later the default is off.
592 #
593 # BackupPC, and the cgi interface in particular, do the right thing on
594 # un-filled incremental backups.  It will correctly display the merged
595 # incremental backup with the most recent filled backup, giving the
596 # un-filled incremental backups a filled appearance.  That means it
597 # invisible to the user whether incremental dumps are filled or not.
598 #
599 # Filling backups takes a little extra disk space, and it does cost
600 # some extra disk activity for filling, and later removal.  Filling
601 # is no longer useful, since file mangling and compression doesn't
602 # make a filled backup very useful. It's likely the filling option
603 # will be removed from future versions: filling will be delegated to
604 # the display and extraction of backup data.
605 #
606 # If filling is off, BackupPC makes sure that the oldest backup is
607 # a full, otherwise the following incremental backups will be
608 # incomplete.  This might mean an extra full backup has to be
609 # kept until the following incremental backups expire.
610 #
611 # The default is off.  You can turn this on or off at any
612 # time without affecting existing backups.
613 #
614 $Conf{IncrFill} = 0;
615
616 #
617 # Number of restore logs to keep.  BackupPC remembers information about
618 # each restore request.  This number per client will be kept around before
619 # the oldest ones are pruned.
620 #
621 # Note: files/dirs delivered via Zip or Tar downloads don't count as
622 # restores.  Only the first restore option (where the files and dirs
623 # are written to the host) count as restores that are logged.
624 #
625 $Conf{RestoreInfoKeepCnt} = 10;
626
627 #
628 # Number of archive logs to keep.  BackupPC remembers information
629 # about each archive request.  This number per archive client will
630 # be kept around before the oldest ones are pruned.
631 #
632 $Conf{ArchiveInfoKeepCnt} = 10;
633
634 #
635 # List of directories or files to backup.  If this is defined, only these
636 # directories or files will be backed up.
637 #
638 # For Smb, only one of $Conf{BackupFilesExclude} and $Conf{BackupFilesOnly}
639 # can be specified per share. If both are set for a particular share, then
640 # $Conf{BackupFilesOnly} takes precedence and $Conf{BackupFilesExclude}
641 # is ignored.
642 #
643 # This can be set to a string, an array of strings, or, in the case
644 # of multiple shares, a hash of strings or arrays.  A hash is used
645 # to give a list of directories or files to backup for each share
646 # (the share name is the key).  If this is set to just a string or
647 # array, and $Conf{SmbShareName} contains multiple share names, then
648 # the setting is assumed to apply all shares.
649 #
650 # If a hash is used, a special key "*" means it applies to all
651 # shares.
652 #
653 # Examples:
654 #    $Conf{BackupFilesOnly} = '/myFiles';
655 #    $Conf{BackupFilesOnly} = ['/myFiles'];     # same as first example
656 #    $Conf{BackupFilesOnly} = ['/myFiles', '/important'];
657 #    $Conf{BackupFilesOnly} = {
658 #       'c' => ['/myFiles', '/important'],      # these are for 'c' share
659 #       'd' => ['/moreFiles', '/archive'],      # these are for 'd' share
660 #    };
661 #    $Conf{BackupFilesOnly} = {
662 #       'c' => ['/myFiles', '/important'],      # these are for 'c' share
663 #       '*' => ['/myFiles', '/important'],      # these are other shares
664 #    };
665 #
666 $Conf{BackupFilesOnly} = undef;
667
668 #
669 # List of directories or files to exclude from the backup.  For Smb,
670 # only one of $Conf{BackupFilesExclude} and $Conf{BackupFilesOnly}
671 # can be specified per share.  If both are set for a particular share,
672 # then $Conf{BackupFilesOnly} takes precedence and
673 # $Conf{BackupFilesExclude} is ignored.
674 #
675 # This can be set to a string, an array of strings, or, in the case
676 # of multiple shares, a hash of strings or arrays.  A hash is used
677 # to give a list of directories or files to exclude for each share
678 # (the share name is the key).  If this is set to just a string or
679 # array, and $Conf{SmbShareName} contains multiple share names, then
680 # the setting is assumed to apply to all shares.
681 #
682 # The exact behavior is determined by the underlying transport program,
683 # smbclient or tar.  For smbclient the exlclude file list is passed into
684 # the X option.  Simple shell wild-cards using "*" or "?" are allowed.
685 #
686 # For tar, if the exclude file contains a "/" it is assumed to be anchored
687 # at the start of the string.  Since all the tar paths start with "./",
688 # BackupPC prepends a "." if the exclude file starts with a "/".  Note
689 # that GNU tar version >= 1.13.7 is required for the exclude option to
690 # work correctly.  For linux or unix machines you should add
691 # "/proc" to $Conf{BackupFilesExclude} unless you have specified
692 # --one-file-system in $Conf{TarClientCmd} or --one-file-system in
693 # $Conf{RsyncArgs}.  Also, for tar, do not use a trailing "/" in
694 # the directory name: a trailing "/" causes the name to not match
695 # and the directory will not be excluded.
696 #
697 # Users report that for smbclient you should specify a directory
698 # followed by "/*", eg: "/proc/*", instead of just "/proc".
699 #
700 # If a hash is used, a special key "*" means it applies to all
701 # shares.
702 #
703 # Examples:
704 #    $Conf{BackupFilesExclude} = '/temp';
705 #    $Conf{BackupFilesExclude} = ['/temp'];     # same as first example
706 #    $Conf{BackupFilesExclude} = ['/temp', '/winnt/tmp'];
707 #    $Conf{BackupFilesExclude} = {
708 #       'c' => ['/temp', '/winnt/tmp'],         # these are for 'c' share
709 #       'd' => ['/junk', '/dont_back_this_up'], # these are for 'd' share
710 #    };
711 #    $Conf{BackupFilesExclude} = {
712 #       'c' => ['/temp', '/winnt/tmp'],         # these are for 'c' share
713 #       '*' => ['/junk', '/dont_back_this_up'], # these are for other shares
714 #    };
715 #
716 $Conf{BackupFilesExclude} = undef;
717
718 #
719 # PCs that are always or often on the network can be backed up after
720 # hours, to reduce PC, network and server load during working hours. For
721 # each PC a count of consecutive good pings is maintained. Once a PC has
722 # at least $Conf{BlackoutGoodCnt} consecutive good pings it is subject
723 # to "blackout" and not backed up during hours and days specified by
724 # $Conf{BlackoutPeriods}.
725 #
726 # To allow for periodic rebooting of a PC or other brief periods when a
727 # PC is not on the network, a number of consecutive bad pings is allowed
728 # before the good ping count is reset. This parameter is
729 # $Conf{BlackoutBadPingLimit}.
730 #
731 # Note that bad and good pings don't occur with the same interval. If a
732 # machine is always on the network, it will only be pinged roughly once
733 # every $Conf{IncrPeriod} (eg: once per day). So a setting for
734 # $Conf{BlackoutGoodCnt} of 7 means it will take around 7 days for a
735 # machine to be subject to blackout. On the other hand, if a ping is
736 # failed, it will be retried roughly every time BackupPC wakes up, eg,
737 # every one or two hours. So a setting for $Conf{BlackoutBadPingLimit} of
738 # 3 means that the PC will lose its blackout status after 3-6 hours of
739 # unavailability.
740 #
741 # To disable the blackout feature set $Conf{BlackoutGoodCnt} to a negative
742 # value.  A value of 0 will make all machines subject to blackout.  But
743 # if you don't want to do any backups during the day it would be easier
744 # to just set $Conf{WakeupSchedule} to a restricted schedule.
745 #
746 $Conf{BlackoutBadPingLimit} = 3;
747 $Conf{BlackoutGoodCnt}      = 7;
748
749 #
750 # One or more blackout periods can be specified.  If a client is
751 # subject to blackout then no regular (non-manual) backups will
752 # be started during any of these periods.  hourBegin and hourEnd
753 # specify hours fro midnight and weekDays is a list of days of
754 # the week where 0 is Sunday, 1 is Monday etc.
755 #
756 # For example:
757 #
758 #    $Conf{BlackoutPeriods} = [
759 #       {
760 #           hourBegin =>  7.0,
761 #           hourEnd   => 19.5,
762 #           weekDays  => [1, 2, 3, 4, 5],
763 #       },
764 #    ];
765 #
766 # specifies one blackout period from 7:00am to 7:30pm local time
767 # on Mon-Fri.
768 #
769 # The blackout period can also span midnight by setting
770 # hourBegin > hourEnd, eg:
771 #
772 #    $Conf{BlackoutPeriods} = [
773 #       {
774 #           hourBegin =>  7.0,
775 #           hourEnd   => 19.5,
776 #           weekDays  => [1, 2, 3, 4, 5],
777 #       },
778 #       {
779 #           hourBegin => 23,
780 #           hourEnd   =>  5,
781 #           weekDays  => [5, 6],
782 #       },
783 #    ];
784 #
785 # This specifies one blackout period from 7:00am to 7:30pm local time
786 # on Mon-Fri, and a second period from 11pm to 5am on Friday and
787 # Saturday night.
788 #
789 $Conf{BlackoutPeriods} = [
790     {
791         hourBegin =>  7.0,
792         hourEnd   => 19.5,
793         weekDays  => [1, 2, 3, 4, 5],
794     },
795 ];
796
797 #
798 # A backup of a share that has zero files is considered fatal. This is
799 # used to catch miscellaneous Xfer errors that result in no files being
800 # backed up.  If you have shares that might be empty (and therefore an
801 # empty backup is valid) you should set this flag to 0.
802 #
803 $Conf{BackupZeroFilesIsFatal} = 1;
804
805 ###########################################################################
806 # How to backup a client
807 # (can be overridden in the per-PC config.pl)
808 ###########################################################################
809 #
810 # What transport method to use to backup each host.  If you have
811 # a mixed set of WinXX and linux/unix hosts you will need to override
812 # this in the per-PC config.pl.
813 #
814 # The valid values are:
815 #
816 #   - 'smb':     backup and restore via smbclient and the SMB protocol.
817 #                Easiest choice for WinXX.
818 #
819 #   - 'rsync':   backup and restore via rsync (via rsh or ssh).
820 #                Best choice for linux/unix.  Good choice also for WinXX.
821 #
822 #   - 'rsyncd':  backup and restore via rsync daemon on the client.
823 #                Best choice for linux/unix if you have rsyncd running on
824 #                the client.  Good choice also for WinXX.
825 #
826 #   - 'tar':    backup and restore via tar, tar over ssh, rsh or nfs.
827 #               Good choice for linux/unix.
828 #
829 #   - 'archive': host is a special archive host.  Backups are not done.
830 #                An archive host is used to archive other host's backups
831 #                to permanent media, such as tape, CDR or DVD.
832 #               
833 #
834 $Conf{XferMethod} = 'smb';
835
836 #
837 # Level of verbosity in Xfer log files.  0 means be quiet, 1 will give
838 # will give one line per file, 2 will also show skipped files on
839 # incrementals, higher values give more output.
840 #
841 $Conf{XferLogLevel} = 1;
842
843 #
844 # Filename charset encoding on the client.  BackupPC uses utf8
845 # on the server for filename encoding.  If this is empty, then
846 # utf8 is assumed and client filenames will not be modified.  If set
847 # to a different encoding then filenames will be re-encoded in utf8.
848 # A typical WinXX encoding for latin1/western europe is 'cp1252'.
849 # Do "perldoc Encode::Supported" to see the list of possible charset
850 # values, and also see http://czyborra.com/charsets/iso8859.html.
851 #   
852 $Conf{ClientCharset} = '';
853
854 #
855 # Name of the host share that is backed up when using SMB.  This can be a
856 # string or an array of strings if there are multiple shares per host.
857 # Examples:
858 #
859 #   $Conf{SmbShareName} = 'c';          # backup 'c' share
860 #   $Conf{SmbShareName} = ['c', 'd'];   # backup 'c' and 'd' shares
861 #
862 # This setting only matters if $Conf{XferMethod} = 'smb'.
863 #
864 $Conf{SmbShareName} = 'C$';
865
866 #
867 # Smbclient share user name.  This is passed to smbclient's -U argument.
868 #
869 # This setting only matters if $Conf{XferMethod} = 'smb'.
870 #
871 $Conf{SmbShareUserName} = '';
872
873 #
874 # Smbclient share password.  This is passed to smbclient via its PASSWD
875 # environment variable.  There are several ways you can tell BackupPC
876 # the smb share password.  In each case you should be very careful about
877 # security.  If you put the password here, make sure that this file is
878 # not readable by regular users!  See the "Setting up config.pl" section
879 # in the documentation for more information.
880 #
881 # This setting only matters if $Conf{XferMethod} = 'smb'.
882 #
883 $Conf{SmbSharePasswd} = '';
884
885 #
886 # Full path for smbclient. Security caution: normal users should not
887 # allowed to write to this file or directory.
888 #
889 # smbclient is from the Samba distribution. smbclient is used to
890 # actually extract the incremental or full dump of the share filesystem
891 # from the PC.
892 #
893 # This setting only matters if $Conf{XferMethod} = 'smb'.
894 #
895 $Conf{SmbClientPath} = '/usr/bin/smbclient';
896
897 #
898 # Command to run smbclient for a full dump.
899 # This setting only matters if $Conf{XferMethod} = 'smb'.
900 #
901 # The following variables are substituted at run-time:
902 #
903 #    $smbClientPath   same as $Conf{SmbClientPath}
904 #    $host            host to backup/restore
905 #    $hostIP          host IP address
906 #    $shareName       share name
907 #    $userName        user name
908 #    $fileList        list of files to backup (based on exclude/include)
909 #    $I_option        optional -I option to smbclient
910 #    $X_option        exclude option (if $fileList is an exclude list)
911 #    $timeStampFile   start time for incremental dump
912 #
913 $Conf{SmbClientFullCmd} = '$smbClientPath \\\\$host\\$shareName'
914             . ' $I_option -U $userName -E -N -d 1'
915             . ' -c tarmode\\ full -Tc$X_option - $fileList';
916
917 #
918 # Command to run smbclient for an incremental dump.
919 # This setting only matters if $Conf{XferMethod} = 'smb'.
920 #
921 # Same variable substitutions are applied as $Conf{SmbClientFullCmd}.
922 #
923 $Conf{SmbClientIncrCmd} = '$smbClientPath \\\\$host\\$shareName'
924             . ' $I_option -U $userName -E -N -d 1'
925             . ' -c tarmode\\ full -TcN$X_option $timeStampFile - $fileList';
926
927 #
928 # Command to run smbclient for a restore.
929 # This setting only matters if $Conf{XferMethod} = 'smb'.
930 #
931 # Same variable substitutions are applied as $Conf{SmbClientFullCmd}.
932 #
933 # If your smb share is read-only then direct restores will fail.
934 # You should set $Conf{SmbClientRestoreCmd} to undef and the
935 # corresponding CGI restore option will be removed.
936 #
937 $Conf{SmbClientRestoreCmd} = '$smbClientPath \\\\$host\\$shareName'
938             . ' $I_option -U $userName -E -N -d 1'
939             . ' -c tarmode\\ full -Tx -';
940
941 #
942 # Which host directories to backup when using tar transport.  This can be a
943 # string or an array of strings if there are multiple directories to
944 # backup per host.  Examples:
945 #
946 #   $Conf{TarShareName} = '/';                  # backup everything
947 #   $Conf{TarShareName} = '/home';              # only backup /home
948 #   $Conf{TarShareName} = ['/home', '/src'];    # backup /home and /src
949 #
950 # The fact this parameter is called 'TarShareName' is for historical
951 # consistency with the Smb transport options.  You can use any valid
952 # directory on the client: there is no need for it to correspond to
953 # any Smb share or device mount point.
954 #
955 # Note also that you can also use $Conf{BackupFilesOnly} to specify
956 # a specific list of directories to backup.  It's more efficient to
957 # use this option instead of $Conf{TarShareName} since a new tar is
958 # run for each entry in $Conf{TarShareName}.
959 #
960 # On the other hand, if you add --one-file-system to $Conf{TarClientCmd}
961 # you can backup each file system separately, which makes restoring one
962 # bad file system easier.  In this case you would list all of the mount
963 # points here, since you can't get the same result with
964 # $Conf{BackupFilesOnly}:
965 #
966 #     $Conf{TarShareName} = ['/', '/var', '/data', '/boot'];
967 #
968 # This setting only matters if $Conf{XferMethod} = 'tar'.
969 #
970 $Conf{TarShareName} = '/';
971
972 #
973 # Full command to run tar on the client.  GNU tar is required.  You will
974 # need to fill in the correct paths for ssh2 on the local host (server)
975 # and GNU tar on the client.  Security caution: normal users should not
976 # allowed to write to these executable files or directories.
977 #
978 # See the documentation for more information about setting up ssh2 keys.
979 #
980 # If you plan to use NFS then tar just runs locally and ssh2 is not needed.
981 # For example, assuming the client filesystem is mounted below /mnt/hostName,
982 # you could use something like:
983 #
984 #    $Conf{TarClientCmd} = '$tarPath -c -v -f - -C /mnt/$host/$shareName'
985 #                        . ' --totals';
986 #
987 # In the case of NFS or rsh you need to make sure BackupPC's privileges
988 # are sufficient to read all the files you want to backup.  Also, you
989 # will probably want to add "/proc" to $Conf{BackupFilesExclude}.
990 #
991 # The following variables are substituted at run-time:
992 #
993 #   $host        host name
994 #   $hostIP      host's IP address
995 #   $incrDate    newer-than date for incremental backups
996 #   $shareName   share name to backup (ie: top-level directory path)
997 #   $fileList    specific files to backup or exclude
998 #   $tarPath     same as $Conf{TarClientPath}
999 #   $sshPath     same as $Conf{SshPath}
1000 #
1001 # If a variable is followed by a "+" it is shell escaped.  This is
1002 # necessary for the command part of ssh or rsh, since it ends up
1003 # getting passed through the shell.
1004 #
1005 # This setting only matters if $Conf{XferMethod} = 'tar'.
1006 #
1007 $Conf{TarClientCmd} = '$sshPath -q -x -n -l root $host'
1008                     . ' env LC_ALL=C $tarPath -c -v -f - -C $shareName+'
1009                     . ' --totals';
1010
1011 #
1012 # Extra tar arguments for full backups.  Several variables are substituted at
1013 # run-time.  See $Conf{TarClientCmd} for the list of variable substitutions.
1014 #
1015 # If you are running tar locally (ie: without rsh or ssh) then remove the
1016 # "+" so that the argument is no longer shell escaped.
1017 #
1018 # This setting only matters if $Conf{XferMethod} = 'tar'.
1019 #
1020 $Conf{TarFullArgs} = '$fileList+';
1021
1022 #
1023 # Extra tar arguments for incr backups.  Several variables are substituted at
1024 # run-time.  See $Conf{TarClientCmd} for the list of variable substitutions.
1025 #
1026 # Note that GNU tar has several methods for specifying incremental backups,
1027 # including:
1028 #
1029 #   --newer-mtime $incrDate+
1030 #          This causes a file to be included if the modification time is
1031 #          later than $incrDate (meaning its contents might have changed).
1032 #          But changes in the ownership or modes will not qualify the
1033 #          file to be included in an incremental.
1034 #
1035 #   --newer=$incrDate+
1036 #          This causes the file to be included if any attribute of the
1037 #          file is later than $incrDate, meaning either attributes or
1038 #          the modification time.  This is the default method.  Do
1039 #          not use --atime-preserve in $Conf{TarClientCmd} above,
1040 #          otherwise resetting the atime (access time) counts as an
1041 #          attribute change, meaning the file will always be included
1042 #          in each new incremental dump.
1043 #
1044 # If you are running tar locally (ie: without rsh or ssh) then remove the
1045 # "+" so that the argument is no longer shell escaped.
1046 #
1047 # This setting only matters if $Conf{XferMethod} = 'tar'.
1048 #
1049 $Conf{TarIncrArgs} = '--newer=$incrDate+ $fileList+';
1050
1051 #
1052 # Full command to run tar for restore on the client.  GNU tar is required.
1053 # This can be the same as $Conf{TarClientCmd}, with tar's -c replaced by -x
1054 # and ssh's -n removed.
1055 #
1056 # See $Conf{TarClientCmd} for full details.
1057 #
1058 # This setting only matters if $Conf{XferMethod} = "tar".
1059 #
1060 # If you want to disable direct restores using tar, you should set
1061 # $Conf{TarClientRestoreCmd} to undef and the corresponding CGI
1062 # restore option will be removed.
1063 #
1064 $Conf{TarClientRestoreCmd} = '$sshPath -q -x -l root $host'
1065                    . ' env LC_ALL=C $tarPath -x -p --numeric-owner --same-owner'
1066                    . ' -v -f - -C $shareName+';
1067
1068 #
1069 # Full path for tar on the client. Security caution: normal users should not
1070 # allowed to write to this file or directory.
1071 #
1072 # This setting only matters if $Conf{XferMethod} = 'tar'.
1073 #
1074 $Conf{TarClientPath} = '/bin/tar';
1075
1076 #
1077 # Path to rsync executable on the client
1078 #
1079 $Conf{RsyncClientPath} = '/bin/rsync';
1080
1081 #
1082 # Full command to run rsync on the client machine.  The following variables
1083 # are substituted at run-time:
1084 #
1085 #        $host           host name being backed up
1086 #        $hostIP         host's IP address
1087 #        $shareName      share name to backup (ie: top-level directory path)
1088 #        $rsyncPath      same as $Conf{RsyncClientPath}
1089 #        $sshPath        same as $Conf{SshPath}
1090 #        $argList        argument list, built from $Conf{RsyncArgs},
1091 #                        $shareName, $Conf{BackupFilesExclude} and
1092 #                        $Conf{BackupFilesOnly}
1093 #
1094 # This setting only matters if $Conf{XferMethod} = 'rsync'.
1095 #
1096 $Conf{RsyncClientCmd} = '$sshPath -q -x -l root $host $rsyncPath $argList+';
1097
1098 #
1099 # Full command to run rsync for restore on the client.  The following
1100 # variables are substituted at run-time:
1101 #
1102 #        $host           host name being backed up
1103 #        $hostIP         host's IP address
1104 #        $shareName      share name to backup (ie: top-level directory path)
1105 #        $rsyncPath      same as $Conf{RsyncClientPath}
1106 #        $sshPath        same as $Conf{SshPath}
1107 #        $argList        argument list, built from $Conf{RsyncArgs},
1108 #                        $shareName, $Conf{BackupFilesExclude} and
1109 #                        $Conf{BackupFilesOnly}
1110 #
1111 # This setting only matters if $Conf{XferMethod} = 'rsync'.
1112 #
1113 $Conf{RsyncClientRestoreCmd} = '$sshPath -q -x -l root $host $rsyncPath $argList+';
1114
1115 #
1116 # Share name to backup.  For $Conf{XferMethod} = "rsync" this should
1117 # be a file system path, eg '/' or '/home'.
1118 #
1119 # For $Conf{XferMethod} = "rsyncd" this should be the name of the module
1120 # to backup (ie: the name from /etc/rsynd.conf).
1121 #
1122 # This can also be a list of multiple file system paths or modules.
1123 # For example, by adding --one-file-system to $Conf{RsyncArgs} you
1124 # can backup each file system separately, which makes restoring one
1125 # bad file system easier.  In this case you would list all of the mount
1126 # points:
1127 #
1128 #     $Conf{RsyncShareName} = ['/', '/var', '/data', '/boot'];
1129 #
1130 $Conf{RsyncShareName} = '/';
1131
1132 #
1133 # Rsync daemon port on the client, for $Conf{XferMethod} = "rsyncd".
1134 #
1135 $Conf{RsyncdClientPort} = 873;
1136
1137 #
1138 # Rsync daemon user name on client, for $Conf{XferMethod} = "rsyncd".
1139 # The user name and password are stored on the client in whatever file
1140 # the "secrets file" parameter in rsyncd.conf points to
1141 # (eg: /etc/rsyncd.secrets).
1142 #
1143 $Conf{RsyncdUserName} = '';
1144
1145 #
1146 # Rsync daemon user name on client, for $Conf{XferMethod} = "rsyncd".
1147 # The user name and password are stored on the client in whatever file
1148 # the "secrets file" parameter in rsyncd.conf points to
1149 # (eg: /etc/rsyncd.secrets).
1150 #
1151 $Conf{RsyncdPasswd} = '';
1152
1153 #
1154 # Whether authentication is mandatory when connecting to the client's
1155 # rsyncd.  By default this is on, ensuring that BackupPC will refuse to
1156 # connect to an rsyncd on the client that is not password protected.
1157 # Turn off at your own risk.
1158 #
1159 $Conf{RsyncdAuthRequired} = 1;
1160
1161 #
1162 # When rsync checksum caching is enabled (by adding the
1163 # --checksum-seed=32761 option to $Conf{RsyncArgs}), the cached
1164 # checksums can be occaisonally verified to make sure the file
1165 # contents matches the cached checksums.  This is to avoid the
1166 # risk that disk problems might cause the pool file contents to
1167 # get corrupted, but the cached checksums would make BackupPC
1168 # think that the file still matches the client.
1169 #
1170 # This setting is the probability (0 means never and 1 means always)
1171 # that a file will be rechecked.  Setting it to 0 means the checksums
1172 # will not be rechecked (unless there is a phase 0 failure).  Setting
1173 # it to 1 (ie: 100%) means all files will be checked, but that is
1174 # not a desirable setting since you are better off simply turning
1175 # caching off (ie: remove the --checksum-seed option).
1176 #   
1177 # The default of 0.01 means 1% (on average) of the files during a full
1178 # backup will have their cached checksum re-checked.
1179 #   
1180 # This setting has no effect unless checksum caching is turned on.
1181 #   
1182 $Conf{RsyncCsumCacheVerifyProb} = 0.01;
1183
1184 #
1185 # Arguments to rsync for backup.  Do not edit the first set unless you
1186 # have a thorough understanding of how File::RsyncP works.
1187 #
1188 # Examples of additional arguments that should work are --exclude/--include,
1189 # eg:
1190 #
1191 #     $Conf{RsyncArgs} = [
1192 #           # original arguments here
1193 #           '-v',
1194 #           '--exclude', '/proc',
1195 #           '--exclude', '*.tmp',
1196 #     ];
1197 #
1198 $Conf{RsyncArgs} = [
1199             #
1200             # Do not edit these!
1201             #
1202             '--numeric-ids',
1203             '--perms',
1204             '--owner',
1205             '--group',
1206             '-D',
1207             '--links',
1208             '--hard-links',
1209             '--times',
1210             '--block-size=2048',
1211             '--recursive',
1212
1213             #
1214             # If you are using a patched client rsync that supports the
1215             # --checksum-seed option (see http://backuppc.sourceforge.net),
1216             # then uncomment this to enabled rsync checksum cachcing
1217             #
1218             #'--checksum-seed=32761',
1219
1220             #
1221             # Add additional arguments here
1222             #
1223 ];
1224
1225 #
1226 # Arguments to rsync for restore.  Do not edit the first set unless you
1227 # have a thorough understanding of how File::RsyncP works.
1228 #
1229 # If you want to disable direct restores using rsync (eg: is the module
1230 # is read-only), you should set $Conf{RsyncRestoreArgs} to undef and
1231 # the corresponding CGI restore option will be removed.
1232 #
1233 $Conf{RsyncRestoreArgs} = [
1234             #
1235             # Do not edit these!
1236             #
1237             '--numeric-ids',
1238             '--perms',
1239             '--owner',
1240             '--group',
1241             '-D',
1242             '--links',
1243             '--hard-links',
1244             '--times',
1245             '--block-size=2048',
1246             '--relative',
1247             '--ignore-times',
1248             '--recursive',
1249
1250             #
1251             # If you are using a patched client rsync that supports the
1252             # --checksum-seed option (see http://backuppc.sourceforge.net),
1253             # then uncomment this to enabled rsync checksum cachcing
1254             #
1255             #'--checksum-seed=32761',
1256
1257             #
1258             # Add additional arguments here
1259             #
1260 ];
1261
1262 #
1263 # Share name to backup.  For $Conf{XferMethod} = "backuppcd" this should
1264 # be a file system path, eg '/' or '/home'.
1265 #
1266 # This can also be a list of multiple file system paths or modules.
1267 # (Can it??)
1268 #
1269 #     $Conf{BackupPCdShareName} = ['/', '/var', '/data', '/boot'];
1270 #
1271 $Conf{BackupPCdShareName} = '/';
1272
1273 #
1274 # Path to backuppcd executable on the server
1275 #
1276 $Conf{BackupPCdPath} = '/usr/bin/backuppcd';
1277
1278 #
1279 # Full command to run backuppcd on the server to backup a given
1280 # client machine.  The following variables are substituted at
1281 # run-time (TODO: update this list)
1282 #
1283 #        $host           host name being backed up
1284 #        $hostIP         host's IP address
1285 #        $shareName      share name to backup (ie: top-level directory path)
1286 #        $backuppcdPath  same as $Conf{BackupPCdPath}
1287 #        $sshPath        same as $Conf{SshPath}
1288 #
1289 # This setting only matters if $Conf{XferMethod} = 'backuppcd'.
1290 #
1291 # Arguments to backupcpd are:
1292 #
1293 #   - the host name to backup
1294 #   - the share name to backup
1295 #   - the directory where the pool is
1296 #   - the directory where the last run was (NOT DONE YET)
1297 #   - a boolean value indicating whether or not the pool is
1298 #      compressed or not
1299 #   - the directory where the new run should occur (currently it assumes ".")
1300 #
1301 $Conf{BackupPCdCmd} = '$bpcdPath $host $shareName $poolDir XXXX $poolCompress $topDir/pc/$client/new';
1302
1303 #
1304 # Full command to run backuppcd on the server for restore to a
1305 # client machine.  The following variables are substituted at
1306 # run-time (TODO: update this list)
1307 #
1308 #        $host           host name being backed up
1309 #        $hostIP         host's IP address
1310 #        $shareName      share name to backup (ie: top-level directory path)
1311 #        $backuppcdPath  same as $Conf{BackupPCdPath}
1312 #        $sshPath        same as $Conf{SshPath}
1313 #
1314 # This setting only matters if $Conf{XferMethod} = 'backuppcd'.
1315 #
1316 $Conf{BackupPCdRestoreCmd} = '$bpcdPath TODO';
1317
1318
1319 #
1320 # Archive Destination
1321 #
1322 # The Destination of the archive
1323 # e.g. /tmp for file archive or /dev/nst0 for device archive
1324 #
1325 $Conf{ArchiveDest} = '/tmp';
1326
1327 #
1328 # Archive Compression type
1329 #
1330 # The valid values are:
1331 #
1332 #   - 'none':  No Compression
1333 #
1334 #   - 'gzip':  Medium Compression. Recommended.
1335 #
1336 #   - 'bzip2': High Compression but takes longer.
1337 #
1338 $Conf{ArchiveComp} = 'gzip';
1339
1340 #
1341 # Archive Parity Files
1342 #
1343 # The amount of Parity data to generate, as a percentage
1344 # of the archive size.
1345 # Uses the commandline par2 (par2cmdline) available from
1346 # http://parchive.sourceforge.net
1347 #
1348 # Only useful for file dumps.
1349 #
1350 # Set to 0 to disable this feature.
1351 #
1352 $Conf{ArchivePar} = 0;
1353
1354 #
1355 # Archive Size Split
1356 #
1357 # Only for file archives. Splits the output into 
1358 # the specified size * 1,000,000.
1359 # e.g. to split into 650,000,000 bytes, specify 650 below.
1360
1361 # If the value is 0, or if $Conf{ArchiveDest} is an existing file or
1362 # device (e.g. a streaming tape drive), this feature is disabled.
1363 #
1364 $Conf{ArchiveSplit} = 0;
1365
1366 #
1367 # Archive Command
1368 #
1369 # This is the command that is called to actually run the archive process
1370 # for each host.  The following variables are substituted at run-time:
1371 #
1372 #   $Installdir    The installation directory of BackupPC
1373 #   $tarCreatePath The path to BackupPC_tarCreate
1374 #   $splitpath     The path to the split program
1375 #   $parpath       The path to the par2 program
1376 #   $host          The host to archive
1377 #   $backupnumber  The backup number of the host to archive
1378 #   $compression   The path to the compression program
1379 #   $compext       The extension assigned to the compression type
1380 #   $splitsize     The number of bytes to split archives into
1381 #   $archiveloc    The location to put the archive
1382 #   $parfile       The amount of parity data to create (percentage)
1383 #
1384 $Conf{ArchiveClientCmd} = '$Installdir/bin/BackupPC_archiveHost'
1385         . ' $tarCreatePath $splitpath $parpath $host $backupnumber'
1386         . ' $compression $compext $splitsize $archiveloc $parfile *';
1387
1388 #
1389 # Full path for ssh. Security caution: normal users should not
1390 # allowed to write to this file or directory.
1391 #
1392 $Conf{SshPath} = '/usr/bin/ssh';
1393
1394 #
1395 # Full path for nmblookup. Security caution: normal users should not
1396 # allowed to write to this file or directory.
1397 #
1398 # nmblookup is from the Samba distribution. nmblookup is used to get the
1399 # netbios name, necessary for DHCP hosts.
1400 #
1401 $Conf{NmbLookupPath} = '/usr/bin/nmblookup';
1402
1403 #
1404 # NmbLookup command.  Given an IP address, does an nmblookup on that
1405 # IP address.  The following variables are substituted at run-time:
1406 #
1407 #   $nmbLookupPath      path to nmblookup ($Conf{NmbLookupPath})
1408 #   $host               IP address
1409 #
1410 # This command is only used for DHCP hosts: given an IP address, this
1411 # command should try to find its NetBios name.
1412 #
1413 $Conf{NmbLookupCmd} = '$nmbLookupPath -A $host';
1414
1415 #
1416 # NmbLookup command.  Given a netbios name, finds that host by doing
1417 # a NetBios lookup.  Several variables are substituted at run-time:
1418 #
1419 #   $nmbLookupPath      path to nmblookup ($Conf{NmbLookupPath})
1420 #   $host               NetBios name
1421 #
1422 # In some cases you might need to change the broadcast address, for
1423 # example if nmblookup uses 192.168.255.255 by default and you find
1424 # that doesn't work, try 192.168.1.255 (or your equivalent class C
1425 # address) using the -B option:
1426 #
1427 #    $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath -B 192.168.1.255 $host';
1428 #
1429 # If you use a WINS server and your machines don't respond to
1430 # multicast NetBios requests you can use this (replace 1.2.3.4
1431 # with the IP address of your WINS server):
1432 #
1433 #    $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath -R -U 1.2.3.4 $host';
1434 #
1435 # This is preferred over multicast since it minimizes network traffic.
1436 #
1437 # Experiment manually for your site to see what form of nmblookup command
1438 # works.
1439 #
1440 $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath $host';
1441
1442 #
1443 # For fixed IP address hosts, BackupPC_dump can also verify the netbios
1444 # name to ensure it matches the host name.  An error is generated if
1445 # they do not match.  Typically this flag is off.  But if you are going
1446 # to transition a bunch of machines from fixed host addresses to DHCP,
1447 # setting this flag is a great way to verify that the machines have
1448 # their netbios name set correctly before turning on DCHP.
1449 #
1450 $Conf{FixedIPNetBiosNameCheck} = 0;
1451
1452 #
1453 # Full path to the ping command.  Security caution: normal users
1454 # should not be allowed to write to this file or directory.
1455 #
1456 # If you want to disable ping checking, set this to some program
1457 # that exits with 0 status, eg:
1458 #
1459 #     $Conf{PingPath} = '/bin/echo';
1460 #
1461 $Conf{PingPath} = '/bin/ping';
1462
1463 #
1464 # Ping command.  The following variables are substituted at run-time:
1465 #
1466 #   $pingPath      path to ping ($Conf{PingPath})
1467 #   $host          host name
1468 #
1469 # Wade Brown reports that on solaris 2.6 and 2.7 ping -s returns the wrong
1470 # exit status (0 even on failure).  Replace with "ping $host 1", which
1471 # gets the correct exit status but we don't get the round-trip time.
1472 #
1473 $Conf{PingCmd} = '$pingPath -c 1 $host';
1474
1475 #
1476 # Maximum round-trip ping time in milliseconds.  This threshold is set
1477 # to avoid backing up PCs that are remotely connected through WAN or
1478 # dialup connections.  The output from ping -s (assuming it is supported
1479 # on your system) is used to check the round-trip packet time.  On your
1480 # local LAN round-trip times should be much less than 20msec.  On most
1481 # WAN or dialup connections the round-trip time will be typically more
1482 # than 20msec.  Tune if necessary.
1483 #
1484 $Conf{PingMaxMsec} = 20;
1485
1486 #
1487 # Compression level to use on files.  0 means no compression.  Compression
1488 # levels can be from 1 (least cpu time, slightly worse compression) to
1489 # 9 (most cpu time, slightly better compression).  The recommended value
1490 # is 3.  Changing to 5, for example, will take maybe 20% more cpu time
1491 # and will get another 2-3% additional compression. See the zlib
1492 # documentation for more information about compression levels.
1493 #
1494 # Changing compression on or off after backups have already been done
1495 # will require both compressed and uncompressed pool files to be stored.
1496 # This will increase the pool storage requirements, at least until all
1497 # the old backups expire and are deleted.
1498 #
1499 # It is ok to change the compression value (from one non-zero value to
1500 # another non-zero value) after dumps are already done.  Since BackupPC
1501 # matches pool files by comparing the uncompressed versions, it will still
1502 # correctly match new incoming files against existing pool files.  The
1503 # new compression level will take effect only for new files that are
1504 # newly compressed and added to the pool.
1505 #
1506 # If compression was off and you are enabling compression for the first
1507 # time you can use the BackupPC_compressPool utility to compress the
1508 # pool.  This avoids having the pool grow to accommodate both compressed
1509 # and uncompressed backups.  See the documentation for more information.
1510 #
1511 # Note: compression needs the Compress::Zlib perl library.  If the
1512 # Compress::Zlib library can't be found then $Conf{CompressLevel} is
1513 # forced to 0 (compression off).
1514 #
1515 $Conf{CompressLevel} = 0;
1516
1517 #
1518 # Timeout in seconds when listening for the transport program's
1519 # (smbclient, tar etc) stdout. If no output is received during this
1520 # time, then it is assumed that something has wedged during a backup,
1521 # and the backup is terminated.
1522 #
1523 # Note that stdout buffering combined with huge files being backed up
1524 # could cause longish delays in the output from smbclient that
1525 # BackupPC_dump sees, so in rare cases you might want to increase
1526 # this value.
1527 #
1528 # Despite the name, this parameter sets the timeout for all transport
1529 # methods (tar, smb etc).
1530 #
1531 $Conf{ClientTimeout} = 72000;
1532
1533 #
1534 # Maximum number of log files we keep around in each PC's directory
1535 # (ie: pc/$host).  These files are aged monthly.  A setting of 12
1536 # means there will be at most the files LOG, LOG.0, LOG.1, ... LOG.11
1537 # in the pc/$host directory (ie: about a years worth).  (Except this
1538 # month's LOG, these files will have a .z extension if compression
1539 # is on).
1540 #
1541 # If you decrease this number after BackupPC has been running for a
1542 # while you will have to manually remove the older log files.
1543 #
1544 $Conf{MaxOldPerPCLogFiles} = 12;
1545
1546 #
1547 # Optional commands to run before and after dumps and restores,
1548 # and also before and after each share of a dump.
1549 #
1550 # Stdout from these commands will be written to the Xfer (or Restore)
1551 # log file.  One example of using these commands would be to
1552 # shut down and restart a database server, dump a database
1553 # to files for backup, or doing a snapshot of a share prior
1554 # to a backup.  Example:
1555 #
1556 #    $Conf{DumpPreUserCmd} = '$sshPath -q -x -l root $host /usr/bin/dumpMysql';
1557 #
1558 # The following variable substitutions are made at run time for
1559 # $Conf{DumpPreUserCmd}, $Conf{DumpPostUserCmd}, $Conf{DumpPreShareCmd}
1560 # and $Conf{DumpPostShareCmd}:
1561 #
1562 #        $type         type of dump (incr or full)
1563 #        $xferOK       1 if the dump succeeded, 0 if it didn't
1564 #        $client       client name being backed up
1565 #        $host         host name (could be different from client name if
1566 #                                 $Conf{ClientNameAlias} is set)
1567 #        $hostIP       IP address of host
1568 #        $user         user name from the hosts file
1569 #        $moreUsers    list of additional users from the hosts file
1570 #        $share        the first share name (or current share for
1571 #                        $Conf{DumpPreShareCmd} and $Conf{DumpPostShareCmd})
1572 #        $shares       list of all the share names
1573 #        $XferMethod   value of $Conf{XferMethod} (eg: tar, rsync, smb)
1574 #        $sshPath      value of $Conf{SshPath},
1575 #        $cmdType      set to DumpPreUserCmd or DumpPostUserCmd
1576 #
1577 # The following variable substitutions are made at run time for
1578 # $Conf{RestorePreUserCmd} and $Conf{RestorePostUserCmd}:
1579 #
1580 #        $client       client name being backed up
1581 #        $xferOK       1 if the restore succeeded, 0 if it didn't
1582 #        $host         host name (could be different from client name if
1583 #                                 $Conf{ClientNameAlias} is set)
1584 #        $hostIP       IP address of host
1585 #        $user         user name from the hosts file
1586 #        $moreUsers    list of additional users from the hosts file
1587 #        $share        the first share name
1588 #        $XferMethod   value of $Conf{XferMethod} (eg: tar, rsync, smb)
1589 #        $sshPath      value of $Conf{SshPath},
1590 #        $type         set to "restore"
1591 #        $bkupSrcHost  host name of the restore source
1592 #        $bkupSrcShare share name of the restore source
1593 #        $bkupSrcNum   backup number of the restore source
1594 #        $pathHdrSrc   common starting path of restore source
1595 #        $pathHdrDest  common starting path of destination
1596 #        $fileList     list of files being restored
1597 #        $cmdType      set to RestorePreUserCmd or RestorePostUserCmd
1598 #
1599 # The following variable substitutions are made at run time for
1600 # $Conf{ArchivePreUserCmd} and $Conf{ArchivePostUserCmd}:
1601 #
1602 #        $client       client name being backed up
1603 #        $xferOK       1 if the archive succeeded, 0 if it didn't
1604 #        $host         Name of the archive host
1605 #        $user         user name from the hosts file
1606 #        $share        the first share name
1607 #        $XferMethod   value of $Conf{XferMethod} (eg: tar, rsync, smb)
1608 #        $HostList     list of hosts being archived
1609 #        $BackupList   list of backup numbers for the hosts being archived
1610 #        $archiveloc   location where the archive is sent to
1611 #        $parfile      amount of parity data being generated (percentage)
1612 #        $compression  compression program being used (eg: cat, gzip, bzip2)
1613 #        $compext      extension used for compression type (eg: raw, gz, bz2)
1614 #        $splitsize    size of the files that the archive creates
1615 #        $sshPath      value of $Conf{SshPath},
1616 #        $type         set to "archive"
1617 #        $cmdType      set to ArchivePreUserCmd or ArchivePostUserCmd
1618 #
1619 $Conf{DumpPreUserCmd}     = undef;
1620 $Conf{DumpPostUserCmd}    = undef;
1621 $Conf{DumpPreShareCmd}    = undef;
1622 $Conf{DumpPostShareCmd}   = undef;
1623 $Conf{RestorePreUserCmd}  = undef;
1624 $Conf{RestorePostUserCmd} = undef;
1625 $Conf{ArchivePreUserCmd}  = undef;
1626 $Conf{ArchivePostUserCmd} = undef;
1627
1628 #
1629 # Whether the exit status of each PreUserCmd and
1630 # PostUserCmd is checked.
1631 #
1632 # If set and the Dump/Restore/Archive Pre/Post UserCmd
1633 # returns a non-zero exit status then the dump/restore/archive
1634 # is aborted.  To maintain backward compatibility (where
1635 # the exit status in early versions was always ignored),
1636 # this flag defaults to 0.
1637 #
1638 # If this flag is set and the Dump/Restore/Archive PreUserCmd
1639 # fails then the matching Dump/Restore/Archive PostUserCmd is
1640 # not executed.  If DumpPreShareCmd returns a non-exit status,
1641 # then DumpPostShareCmd is not executed, but the DumpPostUserCmd
1642 # is still run (since DumpPreUserCmd must have previously
1643 # succeeded).
1644 #
1645 # An example of a DumpPreUserCmd that might fail is a script
1646 # that snapshots or dumps a database which fails because
1647 # of some database error.
1648 #
1649 $Conf{UserCmdCheckStatus} = 0;
1650
1651 #
1652 # Override the client's host name.  This allows multiple clients
1653 # to all refer to the same physical host.  This should only be
1654 # set in the per-PC config file and is only used by BackupPC at
1655 # the last moment prior to generating the command used to backup
1656 # that machine (ie: the value of $Conf{ClientNameAlias} is invisible
1657 # everywhere else in BackupPC).  The setting can be a host name or
1658 # IP address, eg:
1659 #
1660 #         $Conf{ClientNameAlias} = 'realHostName';
1661 #         $Conf{ClientNameAlias} = '192.1.1.15';
1662 #
1663 # will cause the relevant smb/tar/rsync backup/restore commands to be
1664 # directed to realHostName, not the client name.
1665 #
1666 # Note: this setting doesn't work for hosts with DHCP set to 1.
1667 #
1668 $Conf{ClientNameAlias} = undef;
1669
1670 ###########################################################################
1671 # Email reminders, status and messages
1672 # (can be overridden in the per-PC config.pl)
1673 ###########################################################################
1674 #
1675 # Full path to the sendmail command.  Security caution: normal users
1676 # should not allowed to write to this file or directory.
1677 #
1678 $Conf{SendmailPath} = '/usr/sbin/sendmail';
1679
1680 #
1681 # Minimum period between consecutive emails to a single user.
1682 # This tries to keep annoying email to users to a reasonable
1683 # level.  Email checks are done nightly, so this number is effectively
1684 # rounded up (ie: 2.5 means a user will never receive email more
1685 # than once every 3 days).
1686 #
1687 $Conf{EMailNotifyMinDays} = 2.5;
1688
1689 #
1690 # Name to use as the "from" name for email.  Depending upon your mail
1691 # handler this is either a plain name (eg: "admin") or a fully-qualified
1692 # name (eg: "admin@mydomain.com").
1693 #
1694 $Conf{EMailFromUserName} = '';
1695
1696 #
1697 # Destination address to an administrative user who will receive a
1698 # nightly email with warnings and errors.  If there are no warnings
1699 # or errors then no email will be sent.  Depending upon your mail
1700 # handler this is either a plain name (eg: "admin") or a fully-qualified
1701 # name (eg: "admin@mydomain.com").
1702 #
1703 $Conf{EMailAdminUserName} = '';
1704
1705 #
1706 # Destination domain name for email sent to users.  By default
1707 # this is empty, meaning email is sent to plain, unqualified
1708 # addresses.  Otherwise, set it to the destintation domain, eg:
1709 #
1710 #    $Cong{EMailUserDestDomain} = '@mydomain.com';
1711 #
1712 # With this setting user email will be set to 'user@mydomain.com'.
1713 #
1714 $Conf{EMailUserDestDomain} = '';
1715
1716 #
1717 # This subject and message is sent to a user if their PC has never been
1718 # backed up.
1719 #
1720 # These values are language-dependent.  The default versions can be
1721 # found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
1722 # need to change the message, copy it here and edit it, eg:
1723 #
1724 #   $Conf{EMailNoBackupEverMesg} = <<'EOF';
1725 #   To: $user$domain
1726 #   cc:
1727 #   Subject: $subj
1728 #   
1729 #   Dear $userName,
1730 #   
1731 #   This is a site-specific email message.
1732 #   EOF
1733 #
1734 $Conf{EMailNoBackupEverSubj} = undef;
1735 $Conf{EMailNoBackupEverMesg} = undef;
1736
1737 #
1738 # How old the most recent backup has to be before notifying user.
1739 # When there have been no backups in this number of days the user
1740 # is sent an email.
1741 #
1742 $Conf{EMailNotifyOldBackupDays} = 7.0;
1743
1744 #
1745 # This subject and message is sent to a user if their PC has not recently
1746 # been backed up (ie: more than $Conf{EMailNotifyOldBackupDays} days ago).
1747 #
1748 # These values are language-dependent.  The default versions can be
1749 # found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
1750 # need to change the message, copy it here and edit it, eg:
1751 #
1752 #   $Conf{EMailNoBackupRecentMesg} = <<'EOF';
1753 #   To: $user$domain
1754 #   cc:
1755 #   Subject: $subj
1756 #   
1757 #   Dear $userName,
1758 #   
1759 #   This is a site-specific email message.
1760 #   EOF
1761 #
1762 $Conf{EMailNoBackupRecentSubj} = undef;
1763 $Conf{EMailNoBackupRecentMesg} = undef;
1764
1765 #
1766 # How old the most recent backup of Outlook files has to be before
1767 # notifying user.
1768 #
1769 $Conf{EMailNotifyOldOutlookDays} = 5.0;
1770
1771 #
1772 # This subject and message is sent to a user if their Outlook files have
1773 # not recently been backed up (ie: more than $Conf{EMailNotifyOldOutlookDays}
1774 # days ago).
1775 #
1776 # These values are language-dependent.  The default versions can be
1777 # found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
1778 # need to change the message, copy it here and edit it, eg:
1779 #
1780 #   $Conf{EMailOutlookBackupMesg} = <<'EOF';
1781 #   To: $user$domain
1782 #   cc:
1783 #   Subject: $subj
1784 #   
1785 #   Dear $userName,
1786 #   
1787 #   This is a site-specific email message.
1788 #   EOF
1789 #
1790 $Conf{EMailOutlookBackupSubj} = undef;
1791 $Conf{EMailOutlookBackupMesg} = undef;
1792
1793 #
1794 # Additional email headers.  If you change the charset
1795 # to utf8 then BackupPC_sendEmail will use utf8 for
1796 # the email body.
1797 #
1798 $Conf{EMailHeaders} = <<EOF;
1799 MIME-Version: 1.0
1800 Content-Type: text/plain; charset="iso-8859-1"
1801 EOF
1802
1803 ###########################################################################
1804 # CGI user interface configuration settings
1805 # (can be overridden in the per-PC config.pl)
1806 ###########################################################################
1807 #
1808 # Normal users can only access information specific to their host.
1809 # They can start/stop/browse/restore backups.
1810 #
1811 # Administrative users have full access to all hosts, plus overall
1812 # status and log information.
1813 #
1814 # The administrative users are the union of the unix/linux group
1815 # $Conf{CgiAdminUserGroup} and the manual list of users, separated
1816 # by spaces, in $Conf{CgiAdminUsers}. If you don't want a group or
1817 # manual list of users set the corresponding configuration setting
1818 # to undef or an empty string.
1819 #
1820 # If you want every user to have admin privileges (careful!), set
1821 # $Conf{CgiAdminUsers} = '*'.
1822 #
1823 # Examples:
1824 #    $Conf{CgiAdminUserGroup} = 'admin';
1825 #    $Conf{CgiAdminUsers}     = 'craig celia';
1826 #    --> administrative users are the union of group admin, plus
1827 #      craig and celia.
1828 #
1829 #    $Conf{CgiAdminUserGroup} = '';
1830 #    $Conf{CgiAdminUsers}     = 'craig celia';
1831 #    --> administrative users are only craig and celia'.
1832 #
1833 $Conf{CgiAdminUserGroup} = '';
1834 $Conf{CgiAdminUsers}     = '';
1835
1836 #
1837 # URL of the BackupPC_Admin CGI script.  Used for email messages.
1838 #
1839 $Conf{CgiURL} = undef;
1840
1841 #   
1842 # Language to use.  See lib/BackupPC/Lang for the list of supported
1843 # languages, which include English (en), French (fr), Spanish (es),
1844 # German (de), Italian (it), Dutch (nl) and Portuguese Brazillian
1845 # (pt_br).
1846 #
1847 # Currently the Language setting applies to the CGI interface and email
1848 # messages sent to users.  Log files and other text are still in English.
1849 #
1850 $Conf{Language} = 'en';
1851
1852 #
1853 # User names that are rendered by the CGI interface can be turned
1854 # into links into their home page or other information about the
1855 # user.  To set this up you need to create two sprintf() strings,
1856 # that each contain a single '%s' that will be replaced by the user
1857 # name.  The default is a mailto: link.
1858 #
1859 # $Conf{CgiUserHomePageCheck} should be an absolute file path that
1860 # is used to check (via "-f") that the user has a valid home page.
1861 # Set this to undef or an empty string to turn off this check.
1862 #
1863 # $Conf{CgiUserUrlCreate} should be a full URL that points to the
1864 # user's home page.  Set this to undef or an empty string to turn
1865 # off generation of URLs for user names.
1866 #
1867 # Example:
1868 #    $Conf{CgiUserHomePageCheck} = '/var/www/html/users/%s.html';
1869 #    $Conf{CgiUserUrlCreate}     = 'http://myhost/users/%s.html';
1870 #    --> if /var/www/html/users/craig.html exists, then 'craig' will
1871 #      be rendered as a link to http://myhost/users/craig.html.
1872 #
1873 $Conf{CgiUserHomePageCheck} = '';
1874 $Conf{CgiUserUrlCreate}     = 'mailto:%s';
1875
1876 #
1877 # Date display format for CGI interface.  True for US-style dates (MM/DD)
1878 # and zero for international dates (DD/MM).
1879 #
1880 $Conf{CgiDateFormatMMDD} = 1;
1881
1882 #
1883 # If set, the complete list of hosts appears in the left navigation
1884 # bar pull-down for administrators.  Otherwise, just the hosts for which
1885 # the user is listed in the host file (as either the user or in moreUsers)
1886 # are displayed.
1887 #
1888 $Conf{CgiNavBarAdminAllHosts} = 1;
1889
1890 #
1891 # Enable/disable the search box in the navigation bar.
1892 #
1893 $Conf{CgiSearchBoxEnable} = 1;
1894
1895 #
1896 # Additional navigation bar links.  These appear for both regular users
1897 # and administrators.  This is a list of hashes giving the link (URL)
1898 # and the text (name) for the link.  Specifying lname instead of name
1899 # uses the language specific string (ie: $Lang->{lname}) instead of
1900 # just literally displaying name.
1901 #
1902 $Conf{CgiNavBarLinks} = [
1903     {
1904         link  => "?action=view&type=docs",
1905         lname => "Documentation",    # actually displays $Lang->{Documentation}
1906     },
1907     {
1908         link  => "http://backuppc.sourceforge.net/faq",
1909         name  => "FAQ",              # displays literal "FAQ"
1910     },
1911     {
1912         link  => "http://backuppc.sourceforge.net",
1913         name  => "SourceForge",      # displays literal "SourceForge"
1914     },
1915 ];
1916
1917 #
1918 # Hilight colors based on status that are used in the PC summary page.
1919 #
1920 $Conf{CgiStatusHilightColor} = {
1921     Reason_backup_failed           => '#ffcccc',
1922     Reason_backup_done             => '#ccffcc',
1923     Reason_no_ping                 => '#ffff99',
1924     Reason_backup_canceled_by_user => '#ff9900',
1925     Status_backup_in_progress      => '#66cc99',
1926 };
1927
1928 #
1929 # Additional CGI header text.
1930 #
1931 $Conf{CgiHeaders} = '<meta http-equiv="pragma" content="no-cache">';
1932
1933 #
1934 # Directory where images are stored.  This directory should be below
1935 # Apache's DocumentRoot.  This value isn't used by BackupPC but is
1936 # used by configure.pl when you upgrade BackupPC.
1937 #
1938 # Example:
1939 #     $Conf{CgiImageDir} = '/usr/local/apache/htdocs/BackupPC';
1940 #
1941 $Conf{CgiImageDir} = '';
1942
1943 #
1944 # Additional mappings of file name extenions to Content-Type for
1945 # individual file restore.  See $Ext2ContentType in BackupPC_Admin
1946 # for the default setting.  You can add additional settings here,
1947 # or override any default settings.  Example:
1948 #
1949 #     $Conf{CgiExt2ContentType} = {
1950 #                 'pl'  => 'text/plain',
1951 #          };
1952 #
1953 $Conf{CgiExt2ContentType} = { };
1954
1955 #
1956 # URL (without the leading http://host) for BackupPC's image directory.
1957 # The CGI script uses this value to serve up image files.
1958 #
1959 # Example:
1960 #     $Conf{CgiImageDirURL} = '/BackupPC';
1961 #
1962 $Conf{CgiImageDirURL} = '';
1963
1964 #
1965 # CSS stylesheet for the CGI interface.  It is stored in the
1966 # $Conf{CgiImageDir} directory and accessed via the
1967 # $Conf{CgiImageDirURL} URL.
1968 #
1969 $Conf{CgiCSSFile} = 'BackupPC_stnd.css';
1970
1971 #
1972 # Whether the user is allowed to edit their per-PC config.
1973 #
1974 $Conf{CgiUserConfigEditEnable} = 1;
1975
1976 #
1977 # Which per-host config variables a non-admin user is allowed
1978 # to edit.  Admin users can edit all per-host config variables,
1979 # even if disabled in this list.
1980 #
1981 # SECURITY WARNING: Do not let users edit any of the Cmd
1982 # config variables!  That's because a user could set a
1983 # Cmd to a shell script of their choice and it will be
1984 # run as the BackupPC user.  That script could do all
1985 # sorts of bad things.
1986 #
1987 $Conf{CgiUserConfigEdit} = {
1988         FullPeriod                => 1,
1989         IncrPeriod                => 1,
1990         FullKeepCnt               => 1,
1991         FullKeepCntMin            => 1,
1992         FullAgeMax                => 1,
1993         IncrKeepCnt               => 1,
1994         IncrKeepCntMin            => 1,
1995         IncrAgeMax                => 1,
1996         IncrLevels                => 1,
1997         IncrFill                  => 1,
1998         PartialAgeMax             => 1,
1999         RestoreInfoKeepCnt        => 1,
2000         ArchiveInfoKeepCnt        => 1,
2001         BackupFilesOnly           => 1,
2002         BackupFilesExclude        => 1,
2003         BlackoutBadPingLimit      => 1,
2004         BlackoutGoodCnt           => 1,
2005         BlackoutPeriods           => 1,
2006         BackupZeroFilesIsFatal    => 1,
2007         ClientCharset             => 1,
2008         XferMethod                => 1,
2009         XferLogLevel              => 1,
2010         SmbShareName              => 1,
2011         SmbShareUserName          => 1,
2012         SmbSharePasswd            => 1,
2013         SmbClientFullCmd          => 0,
2014         SmbClientIncrCmd          => 0,
2015         SmbClientRestoreCmd       => 0,
2016         TarShareName              => 1,
2017         TarFullArgs               => 1,
2018         TarIncrArgs               => 1,
2019         TarClientCmd              => 0,
2020         TarClientRestoreCmd       => 0,
2021         RsyncShareName            => 1,
2022         RsyncdClientPort          => 1,
2023         RsyncdPasswd              => 1,
2024         RsyncdAuthRequired        => 1,
2025         RsyncCsumCacheVerifyProb  => 1,
2026         RsyncArgs                 => 1,
2027         RsyncRestoreArgs          => 1,
2028         RsyncClientCmd            => 0,
2029         RsyncClientRestoreCmd     => 0,
2030         ArchiveDest               => 1,
2031         ArchiveComp               => 1,
2032         ArchivePar                => 1,
2033         ArchiveSplit              => 1,
2034         ArchiveClientCmd          => 0,
2035         FixedIPNetBiosNameCheck   => 1,
2036         NmbLookupCmd              => 0,
2037         NmbLookupFindHostCmd      => 0,
2038         PingMaxMsec               => 1,
2039         PingCmd                   => 0,
2040         ClientTimeout             => 1,
2041         MaxOldPerPCLogFiles       => 1,
2042         CompressLevel             => 1,
2043         ClientNameAlias           => 1,
2044         DumpPreUserCmd            => 0,
2045         DumpPostUserCmd           => 0,
2046         RestorePreUserCmd         => 0,
2047         RestorePostUserCmd        => 0,
2048         ArchivePreUserCmd         => 0,
2049         ArchivePostUserCmd        => 0,
2050         DumpPostShareCmd          => 0,
2051         DumpPreShareCmd           => 0,
2052         UserCmdCheckStatus        => 0,
2053         EMailNotifyMinDays        => 1,
2054         EMailFromUserName         => 1,
2055         EMailAdminUserName        => 1,
2056         EMailUserDestDomain       => 1,
2057         EMailNoBackupEverSubj     => 1,
2058         EMailNoBackupEverMesg     => 1,
2059         EMailNotifyOldBackupDays  => 1,
2060         EMailNoBackupRecentSubj   => 1,
2061         EMailNoBackupRecentMesg   => 1,
2062         EMailNotifyOldOutlookDays => 1,
2063         EMailOutlookBackupSubj    => 1,
2064         EMailOutlookBackupMesg    => 1,
2065         EMailHeaders              => 1,
2066 };