conf/config.pl

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