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