conf/config.pl

   1 #============================================================= -*-perl-*-
   2 #
   3 # Configuration file for BackupPC.
   4 #
   5 # DESCRIPTION
   6 #
   7 #   This is the main configuration file for BackupPC.
   8 #
   9 #   This file must be valid perl source, so make sure the punctuation,
  10 #   quotes, and other syntax are valid.
  11 #
  12 #   This file is read by BackupPC at startup, when a HUP (-1) signal
  13 #   is sent to BackupPC and also at each wakeup time whenever the
  14 #   modification time of this file changes.
  15 #
  16 #   The configuration parameters are divided into four general groups.
  17 #   The first group (general server configuration) provides general
  18 #   configuration for BackupPC.  The next two groups describe what
  19 #   to backup, when to do it, and how long to keep it.  The fourth
  20 #   group are settings for the CGI http interface.
  21 #
  22 #   Configuration settings can also be specified on a per-PC basis.
  23 #   Simply put the relevant settings in a config.pl file in the
  24 #   PC's backup directory (ie: in __TOPDIR__/pc/hostName).
  25 #   All configuration settings in the second, third and fourth
  26 #   groups can be overridden by the per-PC config.pl file.
  27 #
  28 # AUTHOR
  29 #   Craig Barratt  <cbarratt@users.sourceforge.net>
  30 #
  31 # COPYRIGHT
  32 #   Copyright (C) 2001-2003  Craig Barratt
  33 #
  34 #   See http://backuppc.sourceforge.net.
  35 #
  36 #========================================================================
  37
  38 ###########################################################################
  39 # General server configuration
  40 ###########################################################################
  41 #
  42 # Host name on which the BackupPC server is running.
  43 #
  44 $Conf{ServerHost} = '';
  45
  46 #
  47 # TCP port number on which the BackupPC server listens for and accepts
  48 # connections.  Normally this should be disabled (set to -1).  The TCP
  49 # port is only needed if apache runs on a different machine from BackupPC.
  50 # In that case, set this to any spare port number over 1024 (eg: 2359).
  51 # If you enable the TCP port, make sure you set $Conf{ServerMesgSecret}
  52 # too!
  53 #
  54 $Conf{ServerPort} = -1;
  55
  56 #
  57 # Shared secret to make the TCP port secure.  Set this to a hard to guess
  58 # string if you enable the TCP port (ie: $Conf{ServerPort} > 0).
  59 #
  60 # To avoid possible attacks via the TCP socket interface, every client
  61 # message is protected by an MD5 digest. The MD5 digest includes four
  62 # items:
  63 #   - a seed that is sent to the client when the connection opens
  64 #   - a sequence number that increments for each message
  65 #   - a shared secret that is stored in $Conf{ServerMesgSecret}
  66 #   - the message itself.
  67 #
  68 # The message is sent in plain text preceded by the MD5 digest.  A
  69 # snooper can see the plain-text seed sent by BackupPC and plain-text
  70 # message from the client, but cannot construct a valid MD5 digest since
  71 # the secret $Conf{ServerMesgSecret} is unknown.  A replay attack is
  72 # not possible since the seed changes on a per-connection and
  73 # per-message basis.
  74 #
  75 $Conf{ServerMesgSecret} = '';
  76
  77 #
  78 # PATH setting for BackupPC.  An explicit value is necessary
  79 # for taint mode.  Value shouldn't matter too much since
  80 # all execs use explicit paths.  However, taint mode in perl
  81 # will complain if this directory is world writable.
  82 #
  83 $Conf{MyPath} = '/bin';
  84
  85 #
  86 # Permission mask for directories and files created by BackupPC.
  87 # Default value prevents any access from group other, and prevents
  88 # group write.
  89 #
  90 $Conf{UmaskMode} = 027;
  91
  92 #
  93 # Times at which we wake up, check all the PCs, and schedule necessary
  94 # backups.  Times are measured in hours since midnight.  Can be
  95 # fractional if necessary (eg: 4.25 means 4:15am).
  96 #
  97 # If the hosts you are backing up are always connected to the network
  98 # you might have only one or two wakeups each night.  This will keep
  99 # the backup activity after hours.  On the other hand, if you are backing
 100 # up laptops that are only intermittently connected to the network you
 101 # will want to have frequent wakeups (eg: hourly) to maximized the chance
 102 # that each laptop is backed up.
 103 #
 104 # Examples:
 105 #     $Conf{WakeupSchedule} = [22.5];         # once per day at 10:30 pm.
 106 #     $Conf{WakeupSchedule} = [1..23];        # every hour except midnight
 107 #     $Conf{WakeupSchedule} = [2,4,6,8,10,12,14,16,18,20,22];  # every 2 hours
 108 #
 109 # The default value is every hour except midnight.
 110 #
 111 $Conf{WakeupSchedule} = [1..23];
 112
 113 #
 114 # Maximum number of simultaneous backups to run.  If there
 115 # are no user backup requests then this is the maximum number
 116 # of simultaneous backups.
 117 #
 118 $Conf{MaxBackups} = 4;
 119
 120 #
 121 # Additional number of simultaneous backups that users can run.
 122 # As many as $Conf{MaxBackups} + $Conf{MaxUserBackups} requests can
 123 # run at the same time.
 124 #
 125 $Conf{MaxUserBackups} = 4;
 126
 127 #
 128 # Maximum number of pending link commands. New backups will only be
 129 # started if there are no more than $Conf{MaxPendingCmds} plus
 130 # $Conf{MaxBackups} number of pending link commands, plus running jobs.
 131 # This limit is to make sure BackupPC doesn't fall too far behind in
 132 # running BackupPC_link commands.
 133 #
 134 $Conf{MaxPendingCmds} = 10;
 135
 136 #
 137 # Maximum number of log files we keep around in log directory.
 138 # These files are aged nightly.  A setting of 14 means the log
 139 # directory will contain about 2 weeks of old log files, in
 140 # particular at most the files LOG, LOG.0, LOG.1, ... LOG.13
 141 # (except today's LOG, these files will have a .z extension if
 142 # compression is on).
 143 #
 144 # If you decrease this number after BackupPC has been running for a
 145 # while you will have to manually remove the older log files.
 146 #
 147 $Conf{MaxOldLogFiles} = 14;
 148
 149 #
 150 # Full path to the df command.  Security caution: normal users
 151 # should not allowed to write to this file or directory.
 152 #
 153 $Conf{DfPath} = '/bin/df';
 154
 155 #
 156 # Command to run df.  Several variables are substituted at run-time:
 157 #
 158 #   $dfPath      path to df ($Conf{DfPath})
 159 #   $topDir      top-level BackupPC data directory
 160 #
 161 $Conf{DfCmd} = '$dfPath $topDir';
 162
 163 #
 164 # 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.
 171 #
 172 $Conf{DfMaxUsagePct} = 95;
 173
 174 #
 175 # How long BackupPC_trashClean sleeps in seconds between each check
 176 # of the trash directory.  Once every 5 minutes should be reasonable.
 177 #
 178 $Conf{TrashCleanSleepSec} = 300;
 179
 180 #
 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
 184 # dhcp flag set.
 185 #
 186 # Examples:
 187 #    # to specify 192.10.10.20 to 192.10.10.250 as the DHCP address pool
 188 #    $Conf{DHCPAddressRanges} = [
 189 #        {
 190 #            ipAddrBase => '192.10.10',
 191 #            first => 20,
 192 #            last  => 250,
 193 #        },
 194 #    ];
 195 #    # to specify two pools (192.10.10.20-250 and 192.10.11.10-50)
 196 #    $Conf{DHCPAddressRanges} = [
 197 #        {
 198 #            ipAddrBase => '192.10.10',
 199 #            first => 20,
 200 #            last  => 250,
 201 #        },
 202 #        {
 203 #            ipAddrBase => '192.10.11',
 204 #            first => 10,
 205 #            last  => 50,
 206 #        },
 207 #    ];
 208 #
 209 $Conf{DHCPAddressRanges} = [];
 210
 211 #
 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
 215 # BackupPC.
 216 #
 217 $Conf{BackupPCUser} = '';
 218 $Conf{CgiDir}       = '';
 219 $Conf{InstallDir}   = '';
 220
 221 #
 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.
 228 #
 229 $Conf{BackupPCUserVerify} = 1;
 230
 231 #
 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.
 239 #
 240 $Conf{HardLinkMax} = 31999;
 241
 242 ###########################################################################
 243 # What to backup and when to do it
 244 # (can be overridden in the per-PC config.pl)
 245 ###########################################################################
 246 #
 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.
 249 # Examples:
 250 #
 251 #   $Conf{SmbShareName} = 'c';          # backup 'c' share
 252 #   $Conf{SmbShareName} = ['c', 'd'];   # backup 'c' and 'd' shares
 253 #
 254 # This setting only matters if $Conf{XferMethod} = 'smb'.
 255 #
 256 $Conf{SmbShareName} = 'C$';
 257
 258 #
 259 # Smbclient share user name.  This is passed to smbclient's -U argument.
 260 #
 261 # This setting only matters if $Conf{XferMethod} = 'smb'.
 262 #
 263 $Conf{SmbShareUserName} = '';
 264
 265 #
 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.
 272 #
 273 # This setting only matters if $Conf{XferMethod} = 'smb'.
 274 #
 275 $Conf{SmbSharePasswd} = '';
 276
 277 #
 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:
 281 #
 282 #   $Conf{TarShareName} = '/';                  # backup everything
 283 #   $Conf{TarShareName} = '/home';              # only backup /home
 284 #   $Conf{TarShareName} = ['/home', '/src'];    # backup /home and /src
 285 #
 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.
 290 #
 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}.
 295 #
 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}:
 301 #
 302 #     $Conf{TarShareName} = ['/', '/var', '/data', '/boot'];
 303 #
 304 # This setting only matters if $Conf{XferMethod} = 'tar'.
 305 #
 306 $Conf{TarShareName} = '/';
 307
 308 #
 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
 312 # successful dump.
 313 #
 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.
 317 #
 318 # There are two special values for $Conf{FullPeriod}:
 319 #
 320 #   -1   Don't do any regular backups on this machine.  Manually
 321 #        requested backups (via the CGI interface) will still occur.
 322 #
 323 #   -2   Don't do any backups on this machine.  Manually requested
 324 #        backups (via the CGI interface) will be ignored.
 325 #
 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.
 329 #
 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.
 333 #
 334 $Conf{FullPeriod} = 6.97;
 335
 336 #
 337 # Minimum period in days between incremental backups (a user requested
 338 # incremental backup will be done anytime on demand).
 339 #
 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.
 343 #
 344 $Conf{IncrPeriod} = 0.97;
 345
 346 #
 347 # Number of full backups to keep.  Must be >= 1.
 348 #
 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.
 352 #
 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.
 356 #
 357 $Conf{FullKeepCnt} = 1;
 358
 359 #
 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
 362 # they are.
 363 #
 364 $Conf{FullKeepCntMin} = 1;
 365 $Conf{FullAgeMax}     = 60;
 366
 367 #
 368 # Number of incremental backups to keep.  Must be >= 1.
 369 #
 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.
 373 #
 374 $Conf{IncrKeepCnt} = 6;
 375
 376 #
 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.
 380 #
 381 $Conf{IncrKeepCntMin} = 1;
 382 $Conf{IncrAgeMax}     = 30;
 383
 384 #
 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.
 390 #
 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.
 396 #
 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.
 403 #
 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.
 408 #
 409 # The default is off.  You can turn this on or off at any
 410 # time without affecting existing backups.
 411 #
 412 $Conf{IncrFill} = 0;
 413
 414 #
 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.
 418 #
 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.
 422 #
 423 $Conf{RestoreInfoKeepCnt} = 10;
 424
 425 #
 426 # List of directories or files to backup.  If this is defined, only these
 427 # directories or files will be backed up.
 428 #
 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}
 432 # is ignored.
 433 #
 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.
 440 #
 441 # Examples:
 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
 448 #    };
 449 #
 450 $Conf{BackupFilesOnly} = undef;
 451
 452 #
 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.
 458 #
 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.
 465 #
 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.
 469 #
 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.
 480 #
 481 # Examples:
 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
 488 #    };
 489 #
 490 $Conf{BackupFilesExclude} = undef;
 491
 492 #
 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}.
 500 #
 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}.
 505 #
 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
 514 # unavailability.
 515 #
 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.
 520 #
 521 $Conf{BlackoutBadPingLimit} = 3;
 522 $Conf{BlackoutGoodCnt}      = 7;
 523
 524 #
 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.
 528 #
 529 $Conf{BlackoutHourBegin}    = 7.0;
 530 $Conf{BlackoutHourEnd}      = 19.5;
 531 $Conf{BlackoutWeekDays}     = [1, 2, 3, 4, 5];
 532
 533 ###########################################################################
 534 # General per-PC configuration settings
 535 # (can be overridden in the per-PC config.pl)
 536 ###########################################################################
 537 #
 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.
 541 #
 542 # The valid values are:
 543 #
 544 #   - 'smb':    backup and restore via smbclient and the SMB protocol.
 545 #               Best choice for WinXX.
 546 #
 547 #   - 'rsync':  backup and restore via rsync (via rsh or ssh).
 548 #               Best choice for linux/unix.  Can also work on WinXX.
 549 #
 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.
 553 #
 554 #   - 'tar':    backup and restore via tar, tar over ssh, rsh or nfs.
 555 #               Good choice for linux/unix.
 556 #
 557 # A future version should support 'rsync' as a transport method for
 558 # more efficient backup of linux/unix machines (and perhaps WinXX??).
 559 #
 560 $Conf{XferMethod} = 'smb';
 561
 562 #
 563 # Full path for smbclient. Security caution: normal users should not
 564 # allowed to write to this file or directory.
 565 #
 566 # smbclient is from the Samba distribution. smbclient is used to
 567 # actually extract the incremental or full dump of the share filesystem
 568 # from the PC.
 569 #
 570 # This setting only matters if $Conf{XferMethod} = 'smb'.
 571 #
 572 $Conf{SmbClientPath} = '/usr/bin/smbclient';
 573
 574 #
 575 # Commands to run smbclient for a full dump, incremental dump or a restore.
 576 # This setting only matters if $Conf{XferMethod} = 'smb'.
 577 #
 578 # Several variables are substituted at run-time:
 579 #
 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
 589 #
 590 $Conf{SmbClientFullCmd} = '$smbClientPath \\\\$host\\$shareName'
 591             . ' $I_option -U $userName -E -N -d 1'
 592             . ' -c tarmode\\ full -Tc$X_option - $fileList';
 593
 594 $Conf{SmbClientIncrCmd} = '$smbClientPath \\\\$host\\$shareName'
 595             . ' $I_option -U $userName -E -N -d 1'
 596             . ' -c tarmode\\ full -TcN$X_option $timeStampFile - $fileList';
 597
 598 $Conf{SmbClientRestoreCmd} = '$smbClientPath \\\\$host\\$shareName'
 599             . ' $I_option -U $userName -E -N -d 1'
 600             . ' -c tarmode\\ full -Tx -';
 601
 602 #
 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.
 607 #
 608 # See the documentation for more information about setting up ssh2 keys.
 609 #
 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:
 613 #
 614 #    $Conf{TarClientCmd} = '$tarPath -c -v -f - -C /mnt/$host/$shareName'
 615 #                        . ' --totals';
 616 #
 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}.
 620 #
 621 # Several variables are substituted at run-time.  The following variables
 622 # are substituted at run-time:
 623 #
 624 #   $host        host name
 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}
 631 #
 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.
 635 #
 636 # This setting only matters if $Conf{XferMethod} = 'tar'.
 637 #
 638 $Conf{TarClientCmd} = '$sshPath -q -n -l root $host'
 639                     . ' $tarPath -c -v -f - -C $shareName+'
 640                     . ' --totals';
 641
 642 #
 643 # Extra tar arguments for full backups.  Several variables are substituted at
 644 # run-time.  See $Conf{TarClientCmd} for the list of variable substitutions.
 645 #
 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.
 648 #
 649 # This setting only matters if $Conf{XferMethod} = 'tar'.
 650 #
 651 $Conf{TarFullArgs} = '$fileList+';
 652
 653 #
 654 # Extra tar arguments for incr backups.  Several variables are substituted at
 655 # run-time.  See $Conf{TarClientCmd} for the list of variable substitutions.
 656 #
 657 # Note that GNU tar has several methods for specifying incremental backups,
 658 # including:
 659 #
 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.
 665 #
 666 #   --newer=$incrDate+
 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.
 674 #
 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.
 677 #
 678 # This setting only matters if $Conf{XferMethod} = 'tar'.
 679 #
 680 $Conf{TarIncrArgs} = '--newer=$incrDate+ $fileList+';
 681
 682 #
 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.
 686 #
 687 # See $Conf{TarClientCmd} for full details.
 688 #
 689 # This setting only matters if $Conf{XferMethod} = "tar".
 690 #
 691 $Conf{TarClientRestoreCmd} = '$sshPath -q -l root $host'
 692                    . ' $tarPath -x -p --numeric-owner --same-owner'
 693                    . ' -v -f - -C $shareName+';
 694
 695 #
 696 # Full path for tar on the client. Security caution: normal users should not
 697 # allowed to write to this file or directory.
 698 #
 699 # This setting only matters if $Conf{XferMethod} = 'tar'.
 700 #
 701 $Conf{TarClientPath} = '/bin/tar';
 702
 703 #
 704 # Path to rsync executable on the client
 705 #
 706 $Conf{RsyncClientPath} = '/bin/rsync';
 707
 708 #
 709 # Full command to run rsync on the client machine.  The following variables
 710 # are substituted at run-time:
 711 #
 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}
 720 #
 721 # This setting only matters if $Conf{XferMethod} = 'rsync'.
 722 #
 723 $Conf{RsyncClientCmd} = '$sshPath -l root $host $rsyncPath $argList+';
 724
 725 #
 726 # Full command to run rsync for restore on the client.  The following
 727 # variables are substituted at run-time:
 728 #
 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}
 737 #
 738 # This setting only matters if $Conf{XferMethod} = 'rsync'.
 739 #
 740 $Conf{RsyncClientRestoreCmd} = '$sshPath -l root $host $rsyncPath $argList+';
 741
 742 #
 743 # Share name to backup.  For $Conf{XferMethod} = "rsync" this should
 744 # be a file system path, eg '/' or '/home'.
 745 #
 746 # For $Conf{XferMethod} = "rsyncd" this should be the name of the module
 747 # to backup (ie: the name from /etc/rsynd.conf).
 748 #
 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
 753 # points:
 754 #
 755 #     $Conf{RsyncShareName} = ['/', '/var', '/data', '/boot'];
 756 #
 757 $Conf{RsyncShareName} = '/';
 758
 759 #
 760 # Rsync daemon port on the client, for $Conf{XferMethod} = "rsyncd".
 761 #
 762 $Conf{RsyncdClientPort} = 873;
 763
 764 #
 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).
 769 #
 770 $Conf{RsyncdUserName} = '';
 771
 772 #
 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).
 777 #
 778 $Conf{RsyncdPasswd} = '';
 779
 780 #
 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.
 785 #
 786 $Conf{RsyncdAuthRequired} = 1;
 787
 788 #
 789 # Arguments to rsync for backup.  Do not edit the first set unless you
 790 # have a thorough understanding of how File::RsyncP works.
 791 #
 792 # Examples of additional arguments that should work are --exclude/--include,
 793 # eg:
 794 #
 795 #     $Conf{RsyncArgs} = [
 796 #           # original arguments here
 797 #           '-v',
 798 #           '--exclude', '/proc',
 799 #           '--exclude', '*.tmp',
 800 #     ];
 801 #
 802 $Conf{RsyncArgs} = [
 803             #
 804             # Do not edit these!
 805             #
 806             '--numeric-ids',
 807             '--perms',
 808             '--owner',
 809             '--group',
 810             '--devices',
 811             '--links',
 812             '--times',
 813             '--block-size=2048',
 814             '--recursive',
 815             #
 816             # Add additional arguments here
 817             #
 818 ];
 819
 820 #
 821 # Arguments to rsync for restore.  Do not edit the first set unless you
 822 # have a thorough understanding of how File::RsyncP works.
 823 #
 824 #
 825 $Conf{RsyncRestoreArgs} = [
 826             #
 827             # Do not edit these!
 828             #
 829             "--numeric-ids",
 830             "--perms",
 831             "--owner",
 832             "--group",
 833             "--devices",
 834             "--links",
 835             "--times",
 836             "--block-size=2048",
 837             "--relative",
 838             "--ignore-times",
 839             "--recursive",
 840             #
 841             # Add additional arguments here
 842             #
 843 ];
 844
 845 #
 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
 850 # log files huge.
 851 #
 852 $Conf{RsyncLogLevel} = 1;
 853
 854 #
 855 # Full path for ssh. Security caution: normal users should not
 856 # allowed to write to this file or directory.
 857 #
 858 $Conf{SshPath} = '/usr/bin/ssh';
 859
 860 #
 861 # Full path for nmblookup. Security caution: normal users should not
 862 # allowed to write to this file or directory.
 863 #
 864 # nmblookup is from the Samba distribution. nmblookup is used to get the
 865 # netbios name, necessary for DHCP hosts.
 866 #
 867 $Conf{NmbLookupPath} = '/usr/bin/nmblookup';
 868
 869 #
 870 # NmbLookup command.  Given an IP address, does an nmblookup on that
 871 # IP address.  Several variables are substituted at run-time:
 872 #
 873 #   $nmbLookupPath      path to nmblookup ($Conf{NmbLookupPath})
 874 #   $host               IP address
 875 #
 876 # This command is only used for DHCP hosts: given an IP address, this
 877 # command should try to find its NetBios name.
 878 #
 879 $Conf{NmbLookupCmd} = '$nmbLookupPath -A $host';
 880
 881 #
 882 # NmbLookup command.  Given a netbios name, finds that host by doing
 883 # a NetBios lookup.  Several variables are substituted at run-time:
 884 #
 885 #   $nmbLookupPath      path to nmblookup ($Conf{NmbLookupPath})
 886 #   $host               NetBios name
 887 #
 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:
 892 #
 893 #    $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath -B 192.168.1.255 $host';
 894 #
 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):
 898 #
 899 #    $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath -R -U 1.2.3.4 $host';
 900 #
 901 # This is preferred over multicast since it minimizes network traffic.
 902 #
 903 # Experiment manually for your site to see what form of nmblookup command
 904 # works.
 905 #
 906 $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath $host';
 907
 908 #
 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.
 915 #
 916 $Conf{FixedIPNetBiosNameCheck} = 0;
 917
 918 #
 919 # Full path to the ping command.  Security caution: normal users
 920 # should not be allowed to write to this file or directory.
 921 #
 922 # If you want to disable ping checking, set this to some program
 923 # that exits with 0 status, eg:
 924 #
 925 #     $Conf{PingPath} = '/bin/echo';
 926 #
 927 $Conf{PingPath} = '/bin/ping';
 928
 929 #
 930 # Ping command.  Several variables are substituted at run-time:
 931 #
 932 #   $pingPath      path to ping ($Conf{PingPath})
 933 #   $host          host name
 934 #
 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.
 938 #
 939 $Conf{PingCmd} = '$pingPath -c 1 $host';
 940
 941 #
 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.
 948 #
 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.
 953 #
 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.
 960 #
 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.
 965 #
 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).
 969 #
 970 $Conf{CompressLevel} = 0;
 971
 972 #
 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.
 980 #
 981 $Conf{PingMaxMsec} = 20;
 982
 983 #
 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.
 988 #
 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
 992 # this value.
 993 #
 994 # Despite the name, this parameter sets the timeout for all transport
 995 # methods (tar, smb etc).
 996 #
 997 $Conf{ClientTimeout} = 7200;
 998
 999 #
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
1005 # is on).
1006 #
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.
1009 #
1010 $Conf{MaxOldPerPCLogFiles} = 12;
1011
1012 #
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:
1018 #
1019 #    $Conf{DumpPreUserCmd} = '$sshPath -l root $host /usr/bin/dumpMysql';
1020 #
1021 # Various variable substitutions are available; see BackupPC_dump
1022 # or BackupPC_restore for the details.
1023 #
1024 $Conf{DumpPreUserCmd}     = undef;
1025 $Conf{DumpPostUserCmd}    = undef;
1026 $Conf{RestorePreUserCmd}  = undef;
1027 $Conf{RestorePostUserCmd} = undef;
1028
1029 #
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
1036 # IP address, eg:
1037 #
1038 #         $Conf{ClientNameAlias} = 'realHostName';
1039 #         $Conf{ClientNameAlias} = '192.1.1.15';
1040 #
1041 # will cause the relevant smb/tar/rsync backup/restore commands to be
1042 # directed to realHostName, not the client name.
1043 #
1044 # Note: this setting doesn't work for hosts with DHCP set to 1.
1045 #
1046 $Conf{ClientNameAlias} = undef;
1047
1048 #
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.
1051 #
1052 $Conf{PerlModuleLoad}     = undef;
1053
1054 ###########################################################################
1055 # Email reminders, status and messages
1056 # (can be overridden in the per-PC config.pl)
1057 ###########################################################################
1058 #
1059 # Full path to the sendmail command.  Security caution: normal users
1060 # should not allowed to write to this file or directory.
1061 #
1062 $Conf{SendmailPath} = '/usr/sbin/sendmail';
1063
1064 #
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).
1070 #
1071 $Conf{EMailNotifyMinDays} = 2.5;
1072
1073 #
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").
1077 #
1078 $Conf{EMailFromUserName} = '';
1079
1080 #
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").
1086 #
1087 $Conf{EMailAdminUserName} = '';
1088
1089 #
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:
1093 #
1094 #    $Cong{EMailUserDestDomain} = '@mydomain.com';
1095 #
1096 # With this setting user email will be set to 'user@mydomain.com'.
1097 #
1098 $Conf{EMailUserDestDomain} = '';
1099
1100 #
1101 # This subject and message is sent to a user if their PC has never been
1102 # backed up.
1103 #
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:
1107 #
1108 #   $Conf{EMailNoBackupEverMesg} = <<'EOF';
1109 #   To: $user$domain
1110 #   cc:
1111 #   Subject: $subj
1112 #
1113 #   Dear $userName,
1114 #
1115 #   This is a site-specific email message.
1116 #   EOF
1117 #
1118 $Conf{EMailNoBackupEverSubj} = undef;
1119 $Conf{EMailNoBackupEverMesg} = undef;
1120
1121 #
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
1124 # is sent an email.
1125 #
1126 $Conf{EMailNotifyOldBackupDays} = 7.0;
1127
1128 #
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).
1131 #
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:
1135 #
1136 #   $Conf{EMailNoBackupRecentMesg} = <<'EOF';
1137 #   To: $user$domain
1138 #   cc:
1139 #   Subject: $subj
1140 #
1141 #   Dear $userName,
1142 #
1143 #   This is a site-specific email message.
1144 #   EOF
1145 #
1146 $Conf{EMailNoBackupRecentSubj} = undef;
1147 $Conf{EMailNoBackupRecentMesg} = undef;
1148
1149 #
1150 # How old the most recent backup of Outlook files has to be before
1151 # notifying user.
1152 #
1153 $Conf{EMailNotifyOldOutlookDays} = 5.0;
1154
1155 #
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}
1158 # days ago).
1159 #
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:
1163 #
1164 #   $Conf{EMailOutlookBackupMesg} = <<'EOF';
1165 #   To: $user$domain
1166 #   cc:
1167 #   Subject: $subj
1168 #
1169 #   Dear $userName,
1170 #
1171 #   This is a site-specific email message.
1172 #   EOF
1173 #
1174 $Conf{EMailOutlookBackupSubj} = undef;
1175 $Conf{EMailOutlookBackupMesg} = undef;
1176
1177 ###########################################################################
1178 # CGI user interface configuration settings
1179 # (can be overridden in the per-PC config.pl)
1180 ###########################################################################
1181 #
1182 # Normal users can only access information specific to their host.
1183 # They can start/stop/browse/restore backups.
1184 #
1185 # Administrative users have full access to all hosts, plus overall
1186 # status and log information.
1187 #
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.
1193 #
1194 # If you want every user to have admin privileges (careful!), set
1195 # $Conf{CgiAdminUsers} = '*'.
1196 #
1197 # Examples:
1198 #    $Conf{CgiAdminUserGroup} = 'admin';
1199 #    $Conf{CgiAdminUsers}     = 'craig celia';
1200 #    --> administrative users are the union of group admin, plus
1201 #      craig and celia.
1202 #
1203 #    $Conf{CgiAdminUserGroup} = '';
1204 #    $Conf{CgiAdminUsers}     = 'craig celia';
1205 #    --> administrative users are only craig and celia'.
1206 #
1207 $Conf{CgiAdminUserGroup} = '';
1208 $Conf{CgiAdminUsers}     = '';
1209
1210 #
1211 # URL of the BackupPC_Admin CGI script.  Used for email messages.
1212 #
1213 $Conf{CgiURL} = undef;
1214
1215 #
1216 # Language to use.  See lib/BackupPC/Lang for the list of supported
1217 # languages, which include English (en), French (fr), Spanish (es),
1218 # and German (de).
1219 #
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.
1222 #
1223 $Conf{Language} = 'en';
1224
1225 #
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.
1231 #
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.
1235 #
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.
1239 #
1240 # Example:
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.
1245 #
1246 $Conf{CgiUserHomePageCheck} = '';
1247 $Conf{CgiUserUrlCreate}     = 'mailto:%s';
1248
1249 #
1250 # Date display format for CGI interface.  True for US-style dates (MM/DD)
1251 # and zero for international dates (DD/MM).
1252 #
1253 $Conf{CgiDateFormatMMDD} = 1;
1254
1255 #
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)
1259 # are displayed.
1260 #
1261 $Conf{CgiNavBarAdminAllHosts} = 0;
1262
1263 #
1264 # Header font and size for CGI interface
1265 #
1266 $Conf{CgiHeaderFontType} = 'arial';
1267 $Conf{CgiHeaderFontSize} = '3';
1268
1269 #
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.)
1274 #
1275 $Conf{CgiNavBarBgColor} = '#ddeeee';
1276 $Conf{CgiHeaderBgColor} = '#99cc33';
1277 $Conf{CgiBodyBgColor}   = '#ffffff';
1278
1279 #
1280 # Hilight colors based on status that are used in the PC summary page.
1281 #
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',
1288 };
1289
1290 #
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:
1293 #
1294 #       <meta http-equiv="refresh" content="900">
1295 #
1296 $Conf{CgiHeaders} = '<meta http-equiv="pragma" content="no-cache">';
1297
1298 #
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.
1302 #
1303 # Example:
1304 #     $Conf{CgiImageDir} = '/usr/local/apache/htdocs/BackupPC';
1305 #
1306 $Conf{CgiImageDir} = '';
1307
1308 #
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:
1313 #
1314 #     $Conf{CgiExt2ContentType} = {
1315 #                 'pl'  => 'text/plain',
1316 #          };
1317 #
1318 $Conf{CgiExt2ContentType} = { };
1319
1320 #
1321 # URL (without the leading http://host) for BackupPC's image directory.
1322 # The CGI script uses this value to serve up image files.
1323 #
1324 # Example:
1325 #     $Conf{CgiImageDirURL} = '/BackupPC';
1326 #
1327 $Conf{CgiImageDirURL} = '';