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