1 #============================================================= -*-perl-*-
3 # Configuration file for BackupPC.
7 # This is the main configuration file for BackupPC.
9 # This file must be valid perl source, so make sure the punctuation,
10 # quotes, and other syntax are valid.
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.
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.
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.
29 # Craig Barratt <cbarratt@users.sourceforge.net>
32 # Copyright (C) 2001-2003 Craig Barratt
34 # See http://backuppc.sourceforge.net.
36 #========================================================================
38 ###########################################################################
39 # General server configuration
40 ###########################################################################
42 # Host name on which the BackupPC server is running.
44 $Conf{ServerHost} = '';
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}
54 $Conf{ServerPort} = -1;
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).
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
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.
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
75 $Conf{ServerMesgSecret} = '';
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.
83 $Conf{MyPath} = '/bin';
86 # Permission mask for directories and files created by BackupPC.
87 # Default value prevents any access from group other, and prevents
90 $Conf{UmaskMode} = 027;
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).
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.
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
109 # The default value is every hour except midnight.
111 $Conf{WakeupSchedule} = [1..23];
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.
118 $Conf{MaxBackups} = 4;
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.
125 $Conf{MaxUserBackups} = 4;
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.
134 $Conf{MaxPendingCmds} = 10;
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).
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.
147 $Conf{MaxOldLogFiles} = 14;
150 # Full path to the df command. Security caution: normal users
151 # should not allowed to write to this file or directory.
153 $Conf{DfPath} = '/bin/df';
156 # Command to run df. Several variables are substituted at run-time:
158 # $dfPath path to df ($Conf{DfPath})
159 # $topDir top-level BackupPC data directory
161 $Conf{DfCmd} = '$dfPath $topDir';
164 # Maximum threshold for disk utilization on the __TOPDIR__ filesystem.
165 # If the output from $Conf{DfPath} reports a percentage larger than
166 # this number then no new regularly scheduled backups will be run.
167 # However, user requested backups (which are usually incremental and
168 # tend to be small) are still performed, independent of disk usage.
169 # Also, currently running backups will not be terminated when the disk
170 # usage exceeds this number.
172 $Conf{DfMaxUsagePct} = 95;
175 # How long BackupPC_trashClean sleeps in seconds between each check
176 # of the trash directory. Once every 5 minutes should be reasonable.
178 $Conf{TrashCleanSleepSec} = 300;
181 # List of DHCP address ranges we search looking for PCs to backup.
182 # This is an array of hashes for each class C address range.
183 # This is only needed if hosts in the conf/hosts file have the
187 # # to specify 192.10.10.20 to 192.10.10.250 as the DHCP address pool
188 # $Conf{DHCPAddressRanges} = [
190 # ipAddrBase => '192.10.10',
195 # # to specify two pools (192.10.10.20-250 and 192.10.11.10-50)
196 # $Conf{DHCPAddressRanges} = [
198 # ipAddrBase => '192.10.10',
203 # ipAddrBase => '192.10.11',
209 $Conf{DHCPAddressRanges} = [];
212 # These configuration settings aren't used by BackupPC, but simply
213 # remember a few settings used by configure.pl during installation.
214 # These are used by configure.pl when upgrading to new versions of
217 $Conf{BackupPCUser} = '';
219 $Conf{InstallDir} = '';
222 # Whether BackupPC and the CGI script BackupPC_Admin verify that they
223 # are really running as user $Conf{BackupPCUser}. If this flag is set
224 # and the effective user id (euid) differs from $Conf{BackupPCUser}
225 # then both scripts exit with an error. This catches cases where
226 # BackupPC might be accidently started as root or the wrong user,
227 # or if the CGI script is not installed correctly.
229 $Conf{BackupPCUserVerify} = 1;
232 # Maximum number of hardlinks supported by the $TopDir file system
233 # that BackupPC uses. Most linux or unix file systems should support
234 # at least 32000 hardlinks per file, or 64K in other cases. If a pool
235 # file already has this number of hardlinks, a new pool file is created
236 # so that new hardlinks can be accommodated. This limit will only
237 # be hit if an identical file appears at least this number of times
238 # across all the backups.
240 $Conf{HardLinkMax} = 31999;
242 ###########################################################################
243 # What to backup and when to do it
244 # (can be overridden in the per-PC config.pl)
245 ###########################################################################
247 # Name of the host share that is backed up when using SMB. This can be a
248 # string or an array of strings if there are multiple shares per host.
251 # $Conf{SmbShareName} = 'c'; # backup 'c' share
252 # $Conf{SmbShareName} = ['c', 'd']; # backup 'c' and 'd' shares
254 # This setting only matters if $Conf{XferMethod} = 'smb'.
256 $Conf{SmbShareName} = 'C$';
259 # Smbclient share user name. This is passed to smbclient's -U argument.
261 # This setting only matters if $Conf{XferMethod} = 'smb'.
263 $Conf{SmbShareUserName} = '';
266 # Smbclient share password. This is passed to smbclient via its PASSWD
267 # environment variable. There are several ways you can tell BackupPC
268 # the smb share password. In each case you should be very careful about
269 # security. If you put the password here, make sure that this file is
270 # not readable by regular users! See the "Setting up config.pl" section
271 # in the documentation for more information.
273 # This setting only matters if $Conf{XferMethod} = 'smb'.
275 $Conf{SmbSharePasswd} = '';
278 # Which host directories to backup when using tar transport. This can be a
279 # string or an array of strings if there are multiple directories to
280 # backup per host. Examples:
282 # $Conf{TarShareName} = '/'; # backup everything
283 # $Conf{TarShareName} = '/home'; # only backup /home
284 # $Conf{TarShareName} = ['/home', '/src']; # backup /home and /src
286 # The fact this parameter is called 'TarShareName' is for historical
287 # consistency with the Smb transport options. You can use any valid
288 # directory on the client: there is no need for it to correspond to
289 # any Smb share or device mount point.
291 # Note also that you can also use $Conf{BackupFilesOnly} to specify
292 # a specific list of directories to backup. It's more efficient to
293 # use this option instead of $Conf{TarShareName} since a new tar is
294 # run for each entry in $Conf{TarShareName}.
296 # On the other hand, if you add --one-file-system to $Conf{TarClientCmd}
297 # you can backup each file system separately, which makes restoring one
298 # bad file system easier. In this case you would list all of the mount
299 # points here, since you can't get the same result with
300 # $Conf{BackupFilesOnly}:
302 # $Conf{TarShareName} = ['/', '/var', '/data', '/boot'];
304 # This setting only matters if $Conf{XferMethod} = 'tar'.
306 $Conf{TarShareName} = '/';
309 # Minimum period in days between full backups. A full dump will only be
310 # done if at least this much time has elapsed since the last full dump,
311 # and at least $Conf{IncrPeriod} days has elapsed since the last
314 # Typically this is set slightly less than an integer number of days. The
315 # time taken for the backup, plus the granularity of $Conf{WakeupSchedule}
316 # will make the actual backup interval a bit longer.
318 # There are two special values for $Conf{FullPeriod}:
320 # -1 Don't do any regular backups on this machine. Manually
321 # requested backups (via the CGI interface) will still occur.
323 # -2 Don't do any backups on this machine. Manually requested
324 # backups (via the CGI interface) will be ignored.
326 # These special settings are useful for a client that is no longer
327 # being backed up (eg: a retired machine), but you wish to keep the
328 # last backups available for browsing or restoring to other machines.
330 # Also, you might create a virtual client (by setting $Conf{ClientNameAlias})
331 # for restoring to a DVD or permanent media and you would set
332 # $Conf{FullPeriod} to -2 so that it is never backed up.
334 $Conf{FullPeriod} = 6.97;
337 # Minimum period in days between incremental backups (a user requested
338 # incremental backup will be done anytime on demand).
340 # Typically this is set slightly less than an integer number of days. The
341 # time taken for the backup, plus the granularity of $Conf{WakeupSchedule}
342 # will make the actual backup interval a bit longer.
344 $Conf{IncrPeriod} = 0.97;
347 # Number of full backups to keep. Must be >= 1.
349 # In the steady state, each time a full backup completes successfully
350 # the oldest one is removed. If this number is decreased, the
351 # extra old backups will be removed.
353 # If filling of incremental dumps is off the oldest backup always
354 # has to be a full (ie: filled) dump. This might mean an extra full
355 # dump is kept until the second oldest (incremental) dump expires.
357 $Conf{FullKeepCnt} = 1;
360 # Very old full backups are removed after $Conf{FullAgeMax} days. However,
361 # we keep at least $Conf{FullKeepCntMin} full backups no matter how old
364 $Conf{FullKeepCntMin} = 1;
365 $Conf{FullAgeMax} = 60;
368 # Number of incremental backups to keep. Must be >= 1.
370 # In the steady state, each time an incr backup completes successfully
371 # the oldest one is removed. If this number is decreased, the
372 # extra old backups will be removed.
374 $Conf{IncrKeepCnt} = 6;
377 # Very old incremental backups are removed after $Conf{IncrAgeMax} days.
378 # However, we keep at least $Conf{IncrKeepCntMin} incremental backups no
379 # matter how old they are.
381 $Conf{IncrKeepCntMin} = 1;
382 $Conf{IncrAgeMax} = 30;
385 # Whether incremental backups are filled. "Filling" means that the
386 # most recent full (or filled) dump is merged into the new incremental
387 # dump using hardlinks. This makes an incremental dump look like a
388 # full dump. Prior to v1.03 all incremental backups were filled.
389 # In v1.4.0 and later the default is off.
391 # BackupPC, and the cgi interface in particular, do the right thing on
392 # un-filled incremental backups. It will correctly display the merged
393 # incremental backup with the most recent filled backup, giving the
394 # un-filled incremental backups a filled appearance. That means it
395 # invisible to the user whether incremental dumps are filled or not.
397 # Filling backups takes a little extra disk space, and it does cost
398 # some extra disk activity for filling, and later removal. Filling
399 # is no longer useful, since file mangling and compression doesn't
400 # make a filled backup very useful. It's likely the filling option
401 # will be removed from future versions: filling will be delegated to
402 # the display and extraction of backup data.
404 # If filling is off, BackupPC makes sure that the oldest backup is
405 # a full, otherwise the following incremental backups will be
406 # incomplete. This might mean an extra full backup has to be
407 # kept until the following incremental backups expire.
409 # The default is off. You can turn this on or off at any
410 # time without affecting existing backups.
415 # Number of restore logs to keep. BackupPC remembers information about
416 # each restore request. This number per client will be kept around before
417 # the oldest ones are pruned.
419 # Note: files/dirs delivered via Zip or Tar downloads don't count as
420 # restores. Only the first restore option (where the files and dirs
421 # are written to the host) count as restores that are logged.
423 $Conf{RestoreInfoKeepCnt} = 10;
426 # List of directories or files to backup. If this is defined, only these
427 # directories or files will be backed up.
429 # For Smb, only one of $Conf{BackupFilesExclude} and $Conf{BackupFilesOnly}
430 # can be specified per share. If both are set for a particular share, then
431 # $Conf{BackupFilesOnly} takes precedence and $Conf{BackupFilesExclude}
434 # This can be set to a string, an array of strings, or, in the case
435 # of multiple shares, a hash of strings or arrays. A hash is used
436 # to give a list of directories or files to backup for each share
437 # (the share name is the key). If this is set to just a string or
438 # array, and $Conf{SmbShareName} contains multiple share names, then
439 # the setting is assumed to apply to only the first share name.
442 # $Conf{BackupFilesOnly} = '/myFiles';
443 # $Conf{BackupFilesOnly} = ['/myFiles']; # same as first example
444 # $Conf{BackupFilesOnly} = ['/myFiles', '/important'];
445 # $Conf{BackupFilesOnly} = {
446 # 'c' => ['/myFiles', '/important'], # these are for 'c' share
447 # 'd' => ['/moreFiles', '/archive'], # these are for 'd' share
450 $Conf{BackupFilesOnly} = undef;
453 # List of directories or files to exclude from the backup. For Smb,
454 # only one of $Conf{BackupFilesExclude} and $Conf{BackupFilesOnly}
455 # can be specified per share. If both are set for a particular share,
456 # then $Conf{BackupFilesOnly} takes precedence and
457 # $Conf{BackupFilesExclude} is ignored.
459 # This can be set to a string, an array of strings, or, in the case
460 # of multiple shares, a hash of strings or arrays. A hash is used
461 # to give a list of directories or files to exclude for each share
462 # (the share name is the key). If this is set to just a string or
463 # array, and $Conf{SmbShareName} contains multiple share names, then
464 # the setting is assumed to apply to only the first share name.
466 # The exact behavior is determined by the underlying transport program,
467 # smbclient or tar. For smbclient the exlclude file list is passed into
468 # the X option. Simple shell wild-cards using "*" or "?" are allowed.
470 # For tar, if the exclude file contains a "/" it is assumed to be anchored
471 # at the start of the string. Since all the tar paths start with "./",
472 # BackupPC prepends a "." if the exclude file starts with a "/". Note
473 # that GNU tar version >= 1.13.7 is required for the exclude option to
474 # work correctly. For linux or unix machines you should add
475 # "/proc" to $Conf{BackupFilesExclude} unless you have specified
476 # --one-file-system in $Conf{TarClientCmd} or --one-file-system in
477 # $Conf{RsyncArgs}. Also, for tar, do not use a trailing "/" in
478 # the directory name: a trailing "/" causes the name to not match
479 # and the directory will not be excluded.
482 # $Conf{BackupFilesExclude} = '/temp';
483 # $Conf{BackupFilesExclude} = ['/temp']; # same as first example
484 # $Conf{BackupFilesExclude} = ['/temp', '/winnt/tmp'];
485 # $Conf{BackupFilesExclude} = {
486 # 'c' => ['/temp', '/winnt/tmp'], # these are for 'c' share
487 # 'd' => ['/junk', '/dont_back_this_up'], # these are for 'd' share
490 $Conf{BackupFilesExclude} = undef;
493 # PCs that are always or often on the network can be backed up after
494 # hours, to reduce PC, network and server load during working hours. For
495 # each PC a count of consecutive good pings is maintained. Once a PC has
496 # at least $Conf{BlackoutGoodCnt} consecutive good pings it is subject
497 # to "blackout" and not backed up during hours and days specified by
498 # $Conf{BlackoutWeekDays}, $Conf{BlackoutHourBegin} and
499 # $Conf{BlackoutHourEnd}.
501 # To allow for periodic rebooting of a PC or other brief periods when a
502 # PC is not on the network, a number of consecutive bad pings is allowed
503 # before the good ping count is reset. This parameter is
504 # $Conf{BlackoutBadPingLimit}.
506 # Note that bad and good pings don't occur with the same interval. If a
507 # machine is always on the network, it will only be pinged roughly once
508 # every $Conf{IncrPeriod} (eg: once per day). So a setting for
509 # $Conf{BlackoutGoodCnt} of 7 means it will take around 7 days for a
510 # machine to be subject to blackout. On the other hand, if a ping is
511 # failed, it will be retried roughly every time BackupPC wakes up, eg,
512 # every one or two hours. So a setting for $Conf{BlackoutBadPingLimit} of
513 # 3 means that the PC will lose its blackout status after 3-6 hours of
516 # To disable the blackout feature set $Conf{BlackoutGoodCnt} to a negative
517 # value. A value of 0 will make all machines subject to blackout. But
518 # if you don't want to do any backups during the day it would be easier
519 # to just set $Conf{WakeupSchedule} to a restricted schedule.
521 $Conf{BlackoutBadPingLimit} = 3;
522 $Conf{BlackoutGoodCnt} = 7;
525 # The default settings specify the blackout period from 7:00am to
526 # 7:30pm local time on Mon-Fri. For $Conf{BlackoutWeekDays},
527 # 0 is Sunday, 1 is Monday etc.
529 $Conf{BlackoutHourBegin} = 7.0;
530 $Conf{BlackoutHourEnd} = 19.5;
531 $Conf{BlackoutWeekDays} = [1, 2, 3, 4, 5];
533 ###########################################################################
534 # General per-PC configuration settings
535 # (can be overridden in the per-PC config.pl)
536 ###########################################################################
538 # What transport method to use to backup each host. If you have
539 # a mixed set of WinXX and linux/unix hosts you will need to override
540 # this in the per-PC config.pl.
542 # The valid values are:
544 # - 'smb': backup and restore via smbclient and the SMB protocol.
545 # Best choice for WinXX.
547 # - 'rsync': backup and restore via rsync (via rsh or ssh).
548 # Best choice for linux/unix. Can also work on WinXX.
550 # - 'rsyncd': backup and restre via rsync daemon on the client.
551 # Best choice for linux/unix if you have rsyncd running on
552 # the client. Can also work on WinXX.
554 # - 'tar': backup and restore via tar, tar over ssh, rsh or nfs.
555 # Good choice for linux/unix.
557 # A future version should support 'rsync' as a transport method for
558 # more efficient backup of linux/unix machines (and perhaps WinXX??).
560 $Conf{XferMethod} = 'smb';
563 # Full path for smbclient. Security caution: normal users should not
564 # allowed to write to this file or directory.
566 # smbclient is from the Samba distribution. smbclient is used to
567 # actually extract the incremental or full dump of the share filesystem
570 # This setting only matters if $Conf{XferMethod} = 'smb'.
572 $Conf{SmbClientPath} = '/usr/bin/smbclient';
575 # Commands to run smbclient for a full dump, incremental dump or a restore.
576 # This setting only matters if $Conf{XferMethod} = 'smb'.
578 # Several variables are substituted at run-time:
580 # $smbClientPath same as $Conf{SmbClientPath}
581 # $host host to backup/restore
582 # $hostIP host IP address
583 # $shareName share name
584 # $userName user name
585 # $fileList list of files to backup (based on exclude/include)
586 # $I_option optional -I option to smbclient
587 # $X_option exclude option (if $fileList is an exclude list)
588 # $timeStampFile start time for incremental dump
590 $Conf{SmbClientFullCmd} = '$smbClientPath \\\\$host\\$shareName'
591 . ' $I_option -U $userName -E -N -d 1'
592 . ' -c tarmode\\ full -Tc$X_option - $fileList';
594 $Conf{SmbClientIncrCmd} = '$smbClientPath \\\\$host\\$shareName'
595 . ' $I_option -U $userName -E -N -d 1'
596 . ' -c tarmode\\ full -TcN$X_option $timeStampFile - $fileList';
598 $Conf{SmbClientRestoreCmd} = '$smbClientPath \\\\$host\\$shareName'
599 . ' $I_option -U $userName -E -N -d 1'
600 . ' -c tarmode\\ full -Tx -';
603 # Full command to run tar on the client. GNU tar is required. You will
604 # need to fill in the correct paths for ssh2 on the local host (server)
605 # and GNU tar on the client. Security caution: normal users should not
606 # allowed to write to these executable files or directories.
608 # See the documentation for more information about setting up ssh2 keys.
610 # If you plan to use NFS then tar just runs locally and ssh2 is not needed.
611 # For example, assuming the client filesystem is mounted below /mnt/hostName,
612 # you could use something like:
614 # $Conf{TarClientCmd} = '$tarPath -c -v -f - -C /mnt/$host/$shareName'
617 # In the case of NFS or rsh you need to make sure BackupPC's privileges
618 # are sufficient to read all the files you want to backup. Also, you
619 # will probably want to add "/proc" to $Conf{BackupFilesExclude}.
621 # Several variables are substituted at run-time. The following variables
622 # are substituted at run-time:
625 # $hostIP host's IP address
626 # $incrDate newer-than date for incremental backups
627 # $shareName share name to backup (ie: top-level directory path)
628 # $fileList specific files to backup or exclude
629 # $tarPath same as $Conf{TarClientPath}
630 # $sshPath same as $Conf{SshPath}
632 # If a variable is followed by a "+" it is shell escaped. This is
633 # necessary for the command part of ssh or rsh, since it ends up
634 # getting passed through the shell.
636 # This setting only matters if $Conf{XferMethod} = 'tar'.
638 $Conf{TarClientCmd} = '$sshPath -q -n -l root $host'
639 . ' $tarPath -c -v -f - -C $shareName+'
643 # Extra tar arguments for full backups. Several variables are substituted at
644 # run-time. See $Conf{TarClientCmd} for the list of variable substitutions.
646 # If you are running tar locally (ie: without rsh or ssh) then remove the
647 # "+" so that the argument is no longer shell escaped.
649 # This setting only matters if $Conf{XferMethod} = 'tar'.
651 $Conf{TarFullArgs} = '$fileList+';
654 # Extra tar arguments for incr backups. Several variables are substituted at
655 # run-time. See $Conf{TarClientCmd} for the list of variable substitutions.
657 # Note that GNU tar has several methods for specifying incremental backups,
660 # --newer-mtime $incrDate+
661 # This causes a file to be included if the modification time is
662 # later than $incrDate (meaning its contents might have changed).
663 # But changes in the ownership or modes will not qualify the
664 # file to be included in an incremental.
667 # This causes the file to be included if any attribute of the
668 # file is later than $incrDate, meaning either attributes or
669 # the modification time. This is the default method. Do
670 # not use --atime-preserve in $Conf{TarClientCmd} above,
671 # otherwise resetting the atime (access time) counts as an
672 # attribute change, meaning the file will always be included
673 # in each new incremental dump.
675 # If you are running tar locally (ie: without rsh or ssh) then remove the
676 # "+" so that the argument is no longer shell escaped.
678 # This setting only matters if $Conf{XferMethod} = 'tar'.
680 $Conf{TarIncrArgs} = '--newer=$incrDate+ $fileList+';
683 # Full command to run tar for restore on the client. GNU tar is required.
684 # This can be the same as $Conf{TarClientCmd}, with tar's -c replaced by -x
685 # and ssh's -n removed.
687 # See $Conf{TarClientCmd} for full details.
689 # This setting only matters if $Conf{XferMethod} = "tar".
691 $Conf{TarClientRestoreCmd} = '$sshPath -q -l root $host'
692 . ' $tarPath -x -p --numeric-owner --same-owner'
693 . ' -v -f - -C $shareName+';
696 # Full path for tar on the client. Security caution: normal users should not
697 # allowed to write to this file or directory.
699 # This setting only matters if $Conf{XferMethod} = 'tar'.
701 $Conf{TarClientPath} = '/bin/tar';
704 # Path to rsync executable on the client
706 $Conf{RsyncClientPath} = '/bin/rsync';
709 # Full command to run rsync on the client machine. The following variables
710 # are substituted at run-time:
712 # $host host name being backed up
713 # $hostIP host's IP address
714 # $shareName share name to backup (ie: top-level directory path)
715 # $rsyncPath same as $Conf{RsyncClientPath}
716 # $sshPath same as $Conf{SshPath}
717 # $argList argument list, built from $Conf{RsyncArgs},
718 # $shareName, $Conf{BackupFilesExclude} and
719 # $Conf{BackupFilesOnly}
721 # This setting only matters if $Conf{XferMethod} = 'rsync'.
723 $Conf{RsyncClientCmd} = '$sshPath -l root $host $rsyncPath $argList+';
726 # Full command to run rsync for restore on the client. The following
727 # variables are substituted at run-time:
729 # $host host name being backed up
730 # $hostIP host's IP address
731 # $shareName share name to backup (ie: top-level directory path)
732 # $rsyncPath same as $Conf{RsyncClientPath}
733 # $sshPath same as $Conf{SshPath}
734 # $argList argument list, built from $Conf{RsyncArgs},
735 # $shareName, $Conf{BackupFilesExclude} and
736 # $Conf{BackupFilesOnly}
738 # This setting only matters if $Conf{XferMethod} = 'rsync'.
740 $Conf{RsyncClientRestoreCmd} = '$sshPath -l root $host $rsyncPath $argList+';
743 # Share name to backup. For $Conf{XferMethod} = "rsync" this should
744 # be a file system path, eg '/' or '/home'.
746 # For $Conf{XferMethod} = "rsyncd" this should be the name of the module
747 # to backup (ie: the name from /etc/rsynd.conf).
749 # This can also be a list of multiple file system paths or modules.
750 # For example, by adding --one-file-system to $Conf{RsyncArgs} you
751 # can backup each file system separately, which makes restoring one
752 # bad file system easier. In this case you would list all of the mount
755 # $Conf{RsyncShareName} = ['/', '/var', '/data', '/boot'];
757 $Conf{RsyncShareName} = '/';
760 # Rsync daemon port on the client, for $Conf{XferMethod} = "rsyncd".
762 $Conf{RsyncdClientPort} = 873;
765 # Rsync daemon user name on client, for $Conf{XferMethod} = "rsyncd".
766 # The user name and password are stored on the client in whatever file
767 # the "secrets file" parameter in rsyncd.conf points to
768 # (eg: /etc/rsyncd.secrets).
770 $Conf{RsyncdUserName} = '';
773 # Rsync daemon user name on client, for $Conf{XferMethod} = "rsyncd".
774 # The user name and password are stored on the client in whatever file
775 # the "secrets file" parameter in rsyncd.conf points to
776 # (eg: /etc/rsyncd.secrets).
778 $Conf{RsyncdPasswd} = '';
781 # Whether authentication is mandatory when connecting to the client's
782 # rsyncd. By default this is on, ensuring that BackupPC will refuse to
783 # connect to an rsyncd on the client that is not password protected.
784 # Turn off at your own risk.
786 $Conf{RsyncdAuthRequired} = 1;
789 # Arguments to rsync for backup. Do not edit the first set unless you
790 # have a thorough understanding of how File::RsyncP works.
792 # Examples of additional arguments that should work are --exclude/--include,
795 # $Conf{RsyncArgs} = [
796 # # original arguments here
798 # '--exclude', '/proc',
799 # '--exclude', '*.tmp',
816 # Add additional arguments here
821 # Arguments to rsync for restore. Do not edit the first set unless you
822 # have a thorough understanding of how File::RsyncP works.
825 $Conf{RsyncRestoreArgs} = [
841 # Add additional arguments here
846 # Amount of verbosity in Rsync Xfer log files. 0 means be quiet,
847 # 1 will give will give one line per file, 2 will also show skipped
848 # files on incrementals, higher values give more output. 10 will
849 # include byte dumps of all data read/written, which will make the
852 $Conf{RsyncLogLevel} = 1;
855 # Full path for ssh. Security caution: normal users should not
856 # allowed to write to this file or directory.
858 $Conf{SshPath} = '/usr/bin/ssh';
861 # Full path for nmblookup. Security caution: normal users should not
862 # allowed to write to this file or directory.
864 # nmblookup is from the Samba distribution. nmblookup is used to get the
865 # netbios name, necessary for DHCP hosts.
867 $Conf{NmbLookupPath} = '/usr/bin/nmblookup';
870 # NmbLookup command. Given an IP address, does an nmblookup on that
871 # IP address. Several variables are substituted at run-time:
873 # $nmbLookupPath path to nmblookup ($Conf{NmbLookupPath})
876 # This command is only used for DHCP hosts: given an IP address, this
877 # command should try to find its NetBios name.
879 $Conf{NmbLookupCmd} = '$nmbLookupPath -A $host';
882 # NmbLookup command. Given a netbios name, finds that host by doing
883 # a NetBios lookup. Several variables are substituted at run-time:
885 # $nmbLookupPath path to nmblookup ($Conf{NmbLookupPath})
888 # In some cases you might need to change the broadcast address, for
889 # example if nmblookup uses 192.168.255.255 by default and you find
890 # that doesn't work, try 192.168.1.255 (or your equivalent class C
891 # address) using the -B option:
893 # $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath -B 192.168.1.255 $host';
895 # If you use a WINS server and your machines don't respond to
896 # multicast NetBios requests you can use this (replace 1.2.3.4
897 # with the IP address of your WINS server):
899 # $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath -R -U 1.2.3.4 $host';
901 # This is preferred over multicast since it minimizes network traffic.
903 # Experiment manually for your site to see what form of nmblookup command
906 $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath $host';
909 # For fixed IP address hosts, BackupPC_dump can also verify the netbios
910 # name to ensure it matches the host name. An error is generated if
911 # they do not match. Typically this flag is off. But if you are going
912 # to transition a bunch of machines from fixed host addresses to DHCP,
913 # setting this flag is a great way to verify that the machines have
914 # their netbios name set correctly before turning on DCHP.
916 $Conf{FixedIPNetBiosNameCheck} = 0;
919 # Full path to the ping command. Security caution: normal users
920 # should not be allowed to write to this file or directory.
922 # If you want to disable ping checking, set this to some program
923 # that exits with 0 status, eg:
925 # $Conf{PingPath} = '/bin/echo';
927 $Conf{PingPath} = '/bin/ping';
930 # Ping command. Several variables are substituted at run-time:
932 # $pingPath path to ping ($Conf{PingPath})
935 # Wade Brown reports that on solaris 2.6 and 2.7 ping -s returns the wrong
936 # exit status (0 even on failure). Replace with "ping $host 1", which
937 # gets the correct exit status but we don't get the round-trip time.
939 $Conf{PingCmd} = '$pingPath -c 1 $host';
942 # Compression level to use on files. 0 means no compression. Compression
943 # levels can be from 1 (least cpu time, slightly worse compression) to
944 # 9 (most cpu time, slightly better compression). The recommended value
945 # is 3. Changing to 5, for example, will take maybe 20% more cpu time
946 # and will get another 2-3% additional compression. See the zlib
947 # documentation for more information about compression levels.
949 # Changing compression on or off after backups have already been done
950 # will require both compressed and uncompressed pool files to be stored.
951 # This will increase the pool storage requirements, at least until all
952 # the old backups expire and are deleted.
954 # It is ok to change the compression value (from one non-zero value to
955 # another non-zero value) after dumps are already done. Since BackupPC
956 # matches pool files by comparing the uncompressed versions, it will still
957 # correctly match new incoming files against existing pool files. The
958 # new compression level will take effect only for new files that are
959 # newly compressed and added to the pool.
961 # If compression was off and you are enabling compression for the first
962 # time you can use the BackupPC_compressPool utility to compress the
963 # pool. This avoids having the pool grow to accommodate both compressed
964 # and uncompressed backups. See the documentation for more information.
966 # Note: compression needs the Compress::Zlib perl library. If the
967 # Compress::Zlib library can't be found then $Conf{CompressLevel} is
968 # forced to 0 (compression off).
970 $Conf{CompressLevel} = 0;
973 # Maximum round-trip ping time in milliseconds. This threshold is set
974 # to avoid backing up PCs that are remotely connected through WAN or
975 # dialup connections. The output from ping -s (assuming it is supported
976 # on your system) is used to check the round-trip packet time. On your
977 # local LAN round-trip times should be much less than 20msec. On most
978 # WAN or dialup connections the round-trip time will be typically more
979 # than 20msec. Tune if necessary.
981 $Conf{PingMaxMsec} = 20;
984 # Timeout in seconds when listening for the transport program's
985 # (smbclient, tar etc) stdout. If no output is received during this
986 # time, then it is assumed that something has wedged during a backup,
987 # and the backup is terminated.
989 # Note that stdout buffering combined with huge files being backed up
990 # could cause longish delays in the output from smbclient that
991 # BackupPC_dump sees, so in rare cases you might want to increase
994 # Despite the name, this parameter sets the timeout for all transport
995 # methods (tar, smb etc).
997 $Conf{ClientTimeout} = 7200;
1000 # Maximum number of log files we keep around in each PC's directory
1001 # (ie: pc/$host). These files are aged monthly. A setting of 12
1002 # means there will be at most the files LOG, LOG.0, LOG.1, ... LOG.11
1003 # in the pc/$host directory (ie: about a years worth). (Except this
1004 # month's LOG, these files will have a .z extension if compression
1007 # If you decrease this number after BackupPC has been running for a
1008 # while you will have to manually remove the older log files.
1010 $Conf{MaxOldPerPCLogFiles} = 12;
1013 # Optional commands to run before and after dumps and restores.
1014 # Stdout from these commands will be written to the Xfer (or Restore)
1015 # log file. One example of using these commands would be to
1016 # shut down and restart a database server, or to dump a database
1017 # to files for backup. Example:
1019 # $Conf{DumpPreUserCmd} = '$sshPath -l root $host /usr/bin/dumpMysql';
1021 # Various variable substitutions are available; see BackupPC_dump
1022 # or BackupPC_restore for the details.
1024 $Conf{DumpPreUserCmd} = undef;
1025 $Conf{DumpPostUserCmd} = undef;
1026 $Conf{RestorePreUserCmd} = undef;
1027 $Conf{RestorePostUserCmd} = undef;
1030 # Override the client's host name. This allows multiple clients
1031 # to all refer to the same physical host. This should only be
1032 # set in the per-PC config file and is only used by BackupPC at
1033 # the last moment prior to generating the command used to backup
1034 # that machine (ie: the value of $Conf{ClientNameAlias} is invisible
1035 # everywhere else in BackupPC). The setting can be a host name or
1038 # $Conf{ClientNameAlias} = 'realHostName';
1039 # $Conf{ClientNameAlias} = '192.1.1.15';
1041 # will cause the relevant smb/tar/rsync backup/restore commands to be
1042 # directed to realHostName, not the client name.
1044 # Note: this setting doesn't work for hosts with DHCP set to 1.
1046 $Conf{ClientNameAlias} = undef;
1049 # Advanced option for asking BackupPC to load additional perl modules.
1050 # Can be a list (array ref) of module names to load at startup.
1052 $Conf{PerlModuleLoad} = undef;
1054 ###########################################################################
1055 # Email reminders, status and messages
1056 # (can be overridden in the per-PC config.pl)
1057 ###########################################################################
1059 # Full path to the sendmail command. Security caution: normal users
1060 # should not allowed to write to this file or directory.
1062 $Conf{SendmailPath} = '/usr/sbin/sendmail';
1065 # Minimum period between consecutive emails to a single user.
1066 # This tries to keep annoying email to users to a reasonable
1067 # level. Email checks are done nightly, so this number is effectively
1068 # rounded up (ie: 2.5 means a user will never receive email more
1069 # than once every 3 days).
1071 $Conf{EMailNotifyMinDays} = 2.5;
1074 # Name to use as the "from" name for email. Depending upon your mail
1075 # handler this is either a plain name (eg: "admin") or a fully-qualified
1076 # name (eg: "admin@mydomain.com").
1078 $Conf{EMailFromUserName} = '';
1081 # Destination address to an administrative user who will receive a
1082 # nightly email with warnings and errors. If there are no warnings
1083 # or errors then no email will be sent. Depending upon your mail
1084 # handler this is either a plain name (eg: "admin") or a fully-qualified
1085 # name (eg: "admin@mydomain.com").
1087 $Conf{EMailAdminUserName} = '';
1090 # Destination domain name for email sent to users. By default
1091 # this is empty, meaning email is sent to plain, unqualified
1092 # addresses. Otherwise, set it to the destintation domain, eg:
1094 # $Cong{EMailUserDestDomain} = '@mydomain.com';
1096 # With this setting user email will be set to 'user@mydomain.com'.
1098 $Conf{EMailUserDestDomain} = '';
1101 # This subject and message is sent to a user if their PC has never been
1104 # These values are language-dependent. The default versions can be
1105 # found in the language file (eg: lib/BackupPC/Lang/en.pm). If you
1106 # need to change the message, copy it here and edit it, eg:
1108 # $Conf{EMailNoBackupEverMesg} = <<'EOF';
1115 # This is a site-specific email message.
1118 $Conf{EMailNoBackupEverSubj} = undef;
1119 $Conf{EMailNoBackupEverMesg} = undef;
1122 # How old the most recent backup has to be before notifying user.
1123 # When there have been no backups in this number of days the user
1126 $Conf{EMailNotifyOldBackupDays} = 7.0;
1129 # This subject and message is sent to a user if their PC has not recently
1130 # been backed up (ie: more than $Conf{EMailNotifyOldBackupDays} days ago).
1132 # These values are language-dependent. The default versions can be
1133 # found in the language file (eg: lib/BackupPC/Lang/en.pm). If you
1134 # need to change the message, copy it here and edit it, eg:
1136 # $Conf{EMailNoBackupRecentMesg} = <<'EOF';
1143 # This is a site-specific email message.
1146 $Conf{EMailNoBackupRecentSubj} = undef;
1147 $Conf{EMailNoBackupRecentMesg} = undef;
1150 # How old the most recent backup of Outlook files has to be before
1153 $Conf{EMailNotifyOldOutlookDays} = 5.0;
1156 # This subject and message is sent to a user if their Outlook files have
1157 # not recently been backed up (ie: more than $Conf{EMailNotifyOldOutlookDays}
1160 # These values are language-dependent. The default versions can be
1161 # found in the language file (eg: lib/BackupPC/Lang/en.pm). If you
1162 # need to change the message, copy it here and edit it, eg:
1164 # $Conf{EMailOutlookBackupMesg} = <<'EOF';
1171 # This is a site-specific email message.
1174 $Conf{EMailOutlookBackupSubj} = undef;
1175 $Conf{EMailOutlookBackupMesg} = undef;
1177 ###########################################################################
1178 # CGI user interface configuration settings
1179 # (can be overridden in the per-PC config.pl)
1180 ###########################################################################
1182 # Normal users can only access information specific to their host.
1183 # They can start/stop/browse/restore backups.
1185 # Administrative users have full access to all hosts, plus overall
1186 # status and log information.
1188 # The administrative users are the union of the unix/linux group
1189 # $Conf{CgiAdminUserGroup} and the manual list of users, separated
1190 # by spaces, in $Conf{CgiAdminUsers}. If you don't want a group or
1191 # manual list of users set the corresponding configuration setting
1192 # to undef or an empty string.
1194 # If you want every user to have admin privileges (careful!), set
1195 # $Conf{CgiAdminUsers} = '*'.
1198 # $Conf{CgiAdminUserGroup} = 'admin';
1199 # $Conf{CgiAdminUsers} = 'craig celia';
1200 # --> administrative users are the union of group admin, plus
1203 # $Conf{CgiAdminUserGroup} = '';
1204 # $Conf{CgiAdminUsers} = 'craig celia';
1205 # --> administrative users are only craig and celia'.
1207 $Conf{CgiAdminUserGroup} = '';
1208 $Conf{CgiAdminUsers} = '';
1211 # URL of the BackupPC_Admin CGI script. Used for email messages.
1213 $Conf{CgiURL} = undef;
1216 # Language to use. See lib/BackupPC/Lang for the list of supported
1217 # languages, which include English (en), French (fr), Spanish (es),
1220 # Currently the Language setting applies to the CGI interface and email
1221 # messages sent to users. Log files and other text is still in English.
1223 $Conf{Language} = 'en';
1226 # User names that are rendered by the CGI interface can be turned
1227 # into links into their home page or other information about the
1228 # user. To set this up you need to create two sprintf() strings,
1229 # that each contain a single '%s' that will be replaced by the user
1230 # name. The default is a mailto: link.
1232 # $Conf{CgiUserHomePageCheck} should be an absolute file path that
1233 # is used to check (via "-f") that the user has a valid home page.
1234 # Set this to undef or an empty string to turn off this check.
1236 # $Conf{CgiUserUrlCreate} should be a full URL that points to the
1237 # user's home page. Set this to undef or an empty string to turn
1238 # off generation of URLs for user names.
1241 # $Conf{CgiUserHomePageCheck} = '/var/www/html/users/%s.html';
1242 # $Conf{CgiUserUrlCreate} = 'http://myhost/users/%s.html';
1243 # --> if /var/www/html/users/craig.html exists, then 'craig' will
1244 # be rendered as a link to http://myhost/users/craig.html.
1246 $Conf{CgiUserHomePageCheck} = '';
1247 $Conf{CgiUserUrlCreate} = 'mailto:%s';
1250 # Date display format for CGI interface. True for US-style dates (MM/DD)
1251 # and zero for international dates (DD/MM).
1253 $Conf{CgiDateFormatMMDD} = 1;
1256 # If set, the complete list of hosts appears in the left navigation
1257 # bar for administrators. Otherwise, just the hosts for which the
1258 # user is listed in the host file (as either the user or in moreUsers)
1261 $Conf{CgiNavBarAdminAllHosts} = 0;
1264 # Header font and size for CGI interface
1266 $Conf{CgiHeaderFontType} = 'arial';
1267 $Conf{CgiHeaderFontSize} = '3';
1270 # Color scheme for CGI interface. Default values give a very light blue
1271 # for the background navigation color, green for the header background,
1272 # and white for the body background. (You call tell I should stick to
1273 # programming and not graphical design.)
1275 $Conf{CgiNavBarBgColor} = '#ddeeee';
1276 $Conf{CgiHeaderBgColor} = '#99cc33';
1277 $Conf{CgiBodyBgColor} = '#ffffff';
1280 # Hilight colors based on status that are used in the PC summary page.
1282 $Conf{CgiStatusHilightColor} = {
1283 Reason_backup_failed => '#ffcccc',
1284 Reason_backup_done => '#ccffcc',
1285 Reason_no_ping => '#ffff99',
1286 Reason_backup_canceled_by_user => '#ff9900',
1287 Status_backup_in_progress => '#66cc99',
1291 # Additional CGI header text. For example, if you wanted each CGI page
1292 # to auto refresh every 900 seconds, you could add this text:
1294 # <meta http-equiv="refresh" content="900">
1296 $Conf{CgiHeaders} = '<meta http-equiv="pragma" content="no-cache">';
1299 # Directory where images are stored. This directory should be below
1300 # Apache's DocumentRoot. This value isn't used by BackupPC but is
1301 # used by configure.pl when you upgrade BackupPC.
1304 # $Conf{CgiImageDir} = '/usr/local/apache/htdocs/BackupPC';
1306 $Conf{CgiImageDir} = '';
1309 # Additional mappings of file name extenions to Content-Type for
1310 # individual file restore. See $Ext2ContentType in BackupPC_Admin
1311 # for the default setting. You can add additional settings here,
1312 # or override any default settings. Example:
1314 # $Conf{CgiExt2ContentType} = {
1315 # 'pl' => 'text/plain',
1318 $Conf{CgiExt2ContentType} = { };
1321 # URL (without the leading http://host) for BackupPC's image directory.
1322 # The CGI script uses this value to serve up image files.
1325 # $Conf{CgiImageDirURL} = '/BackupPC';
1327 $Conf{CgiImageDirURL} = '';