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 the 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 $Conf{FullPeriod} = 6.97;
 319
 320 #
 321 # Minimum period in days between incremental backups (a user requested
 322 # incremental backup will be done anytime on demand).
 323 #
 324 # Typically this is set slightly less than an integer number of days. The
 325 # time taken for the backup, plus the granularity of $Conf{WakeupSchedule}
 326 # will make the actual backup interval a bit longer.
 327 #
 328 $Conf{IncrPeriod} = 0.97;
 329
 330 #
 331 # Number of full backups to keep.  Must be >= 1.
 332 #
 333 # In the steady state, each time a full backup completes successfully
 334 # the oldest one is removed.  If this number is decreased, the
 335 # extra old backups will be removed.
 336 #
 337 # If filling of incremental dumps is off the oldest backup always
 338 # has to be a full (ie: filled) dump.  This might mean an extra full
 339 # dump is kept until the second oldest (incremental) dump expires.
 340 #
 341 $Conf{FullKeepCnt} = 1;
 342
 343 #
 344 # Very old full backups are removed after $Conf{FullAgeMax} days.  However,
 345 # we keep at least $Conf{FullKeepCntMin} full backups no matter how old
 346 # they are.
 347 #
 348 $Conf{FullKeepCntMin} = 1;
 349 $Conf{FullAgeMax}     = 60;
 350
 351 #
 352 # Number of incremental backups to keep.  Must be >= 1.
 353 #
 354 # In the steady state, each time an incr backup completes successfully
 355 # the oldest one is removed.  If this number is decreased, the
 356 # extra old backups will be removed.
 357 #
 358 $Conf{IncrKeepCnt} = 6;
 359
 360 #
 361 # Very old incremental backups are removed after $Conf{IncrAgeMax} days.
 362 # However, we keep at least $Conf{IncrKeepCntMin} incremental backups no
 363 # matter how old they are.
 364 #
 365 $Conf{IncrKeepCntMin} = 1;
 366 $Conf{IncrAgeMax}     = 30;
 367
 368 #
 369 # Whether incremental backups are filled.  "Filling" means that the
 370 # most recent full (or filled) dump is merged into the new incremental
 371 # dump using hardlinks.  This makes an incremental dump look like a
 372 # full dump.  Prior to v1.03 all incremental backups were filled.
 373 # In v1.4.0 and later the default is off.
 374 #
 375 # BackupPC, and the cgi interface in particular, do the right thing on
 376 # un-filled incremental backups.  It will correctly display the merged
 377 # incremental backup with the most recent filled backup, giving the
 378 # un-filled incremental backups a filled appearance.  That means it
 379 # invisible to the user whether incremental dumps are filled or not.
 380 #
 381 # Filling backups takes a little extra disk space, and it does cost
 382 # some extra disk activity for filling, and later removal.  Filling
 383 # is no longer useful, since file mangling and compression doesn't
 384 # make a filled backup very useful. It's likely the filling option
 385 # will be removed from future versions: filling will be delegated to
 386 # the display and extraction of backup data.
 387 #
 388 # If filling is off, BackupPC makes sure that the oldest backup is
 389 # a full, otherwise the following incremental backups will be
 390 # incomplete.  This might mean an extra full backup has to be
 391 # kept until the following incremental backups expire.
 392 #
 393 # The default is off.  You can turn this on or off at any
 394 # time without affecting existing backups.
 395 #
 396 $Conf{IncrFill} = 0;
 397
 398 #
 399 # Number of restore logs to keep.  BackupPC remembers information about
 400 # each restore request.  This number per client will be kept around before
 401 # the oldest ones are pruned.
 402 #
 403 # Note: files/dirs delivered via Zip or Tar downloads don't count as
 404 # restores.  Only the first restore option (where the files and dirs
 405 # are written to the host) count as restores that are logged.
 406 #
 407 $Conf{RestoreInfoKeepCnt} = 10;
 408
 409 #
 410 # List of directories or files to backup.  If this is defined, only these
 411 # directories or files will be backed up.
 412 #
 413 # For Smb, only one of $Conf{BackupFilesExclude} and $Conf{BackupFilesOnly}
 414 # can be specified per share. If both are set for a particular share, then
 415 # $Conf{BackupFilesOnly} takes precedence and $Conf{BackupFilesExclude}
 416 # is ignored.
 417 #
 418 # This can be set to a string, an array of strings, or, in the case
 419 # of multiple shares, a hash of strings or arrays.  A hash is used
 420 # to give a list of directories or files to backup for each share
 421 # (the share name is the key).  If this is set to just a string or
 422 # array, and $Conf{SmbShareName} contains multiple share names, then
 423 # the setting is assumed to apply to only the first share name.
 424 #
 425 # Examples:
 426 #    $Conf{BackupFilesOnly} = '/myFiles';
 427 #    $Conf{BackupFilesOnly} = ['/myFiles'];     # same as first example
 428 #    $Conf{BackupFilesOnly} = ['/myFiles', '/important'];
 429 #    $Conf{BackupFilesOnly} = {
 430 #       'c' => ['/myFiles', '/important'],      # these are for 'c' share
 431 #       'd' => ['/moreFiles', '/archive'],      # these are for 'd' share
 432 #    }
 433 #
 434 $Conf{BackupFilesOnly} = undef;
 435
 436 #
 437 # List of directories or files to exclude from the backup.  For Smb,
 438 # only one of $Conf{BackupFilesExclude} and $Conf{BackupFilesOnly}
 439 # can be specified per share.  If both are set for a particular share,
 440 # then $Conf{BackupFilesOnly} takes precedence and
 441 # $Conf{BackupFilesExclude} is ignored.
 442 #
 443 # This can be set to a string, an array of strings, or, in the case
 444 # of multiple shares, a hash of strings or arrays.  A hash is used
 445 # to give a list of directories or files to exclude for each share
 446 # (the share name is the key).  If this is set to just a string or
 447 # array, and $Conf{SmbShareName} contains multiple share names, then
 448 # the setting is assumed to apply to only the first share name.
 449 #
 450 # The exact behavior is determined by the underlying transport program,
 451 # smbclient or tar.  For smbclient the exlclude file list is passed into
 452 # the X option.  Simple shell wild-cards using "*" or "?" are allowed.
 453 #
 454 # For tar, if the exclude file contains a "/" it is assumed to be anchored
 455 # at the start of the string.  Since all the tar paths start with "./",
 456 # BackupPC prepends a "." if the exclude file starts with a "/".  Note
 457 # that GNU tar version >= 1.3.7 is required for the exclude option to
 458 # work correctly.  For linux or unix machines you should add
 459 # "/proc" to $Conf{BackupFilesExclude} unless you have specified
 460 # --one-file-system in $Conf{TarClientCmd} or --one-file-system in
 461 # $Conf{RsyncArgs}.
 462 #
 463 # Examples:
 464 #    $Conf{BackupFilesExclude} = '/temp';
 465 #    $Conf{BackupFilesExclude} = ['/temp'];     # same as first example
 466 #    $Conf{BackupFilesExclude} = ['/temp', '/winnt/tmp'];
 467 #    $Conf{BackupFilesExclude} = {
 468 #       'c' => ['/temp', '/winnt/tmp'],         # these are for 'c' share
 469 #       'd' => ['/junk', '/dont_back_this_up'], # these are for 'd' share
 470 #    }
 471 #
 472 $Conf{BackupFilesExclude} = undef;
 473
 474 #
 475 # PCs that are always or often on the network can be backed up after
 476 # hours, to reduce PC, network and server load during working hours. For
 477 # each PC a count of consecutive good pings is maintained. Once a PC has
 478 # at least $Conf{BlackoutGoodCnt} consecutive good pings it is subject
 479 # to "blackout" and not backed up during hours and days specified by
 480 # $Conf{BlackoutWeekDays}, $Conf{BlackoutHourBegin} and
 481 # $Conf{BlackoutHourEnd}.
 482 #
 483 # To allow for periodic rebooting of a PC or other brief periods when a
 484 # PC is not on the network, a number of consecutive bad pings is allowed
 485 # before the good ping count is reset. This parameter is
 486 # $Conf{BlackoutBadPingLimit}.
 487 #
 488 # Note that bad and good pings don't occur with the same interval. If a
 489 # machine is always on the network, it will only be pinged roughly once
 490 # every $Conf{IncrPeriod} (eg: once per day). So a setting for
 491 # $Conf{BlackoutGoodCnt} of 7 means it will take around 7 days for a
 492 # machine to be subject to blackout. On the other hand, if a ping is
 493 # failed, it will be retried roughly every time BackupPC wakes up, eg,
 494 # every one or two hours. So a setting for $Conf{BlackoutBadPingLimit} of
 495 # 3 means that the PC will lose its blackout status after 3-6 hours of
 496 # unavailability.
 497 #
 498 # To disable the blackout feature set $Conf{BlackoutGoodCnt} to a negative
 499 # value.  A value of 0 will make all machines subject to blackout.  But
 500 # if you don't want to do any backups during the day it would be easier
 501 # to just set $Conf{WakeupSchedule} to a restricted schedule.
 502 #
 503 $Conf{BlackoutBadPingLimit} = 3;
 504 $Conf{BlackoutGoodCnt}      = 7;
 505
 506 #
 507 # The default settings specify the blackout period from 7:00am to
 508 # 7:30pm local time on Mon-Fri.  For $Conf{BlackoutWeekDays},
 509 # 0 is Sunday, 1 is Monday etc.
 510 #
 511 $Conf{BlackoutHourBegin}    = 7.0;
 512 $Conf{BlackoutHourEnd}      = 19.5;
 513 $Conf{BlackoutWeekDays}     = [1, 2, 3, 4, 5];
 514
 515 ###########################################################################
 516 # General per-PC configuration settings
 517 # (can be overridden in the per-PC config.pl)
 518 ###########################################################################
 519 #
 520 # What transport method to use to backup each host.  If you have
 521 # a mixed set of WinXX and linux/unix hosts you will need to override
 522 # this in the per-PC config.pl.
 523 #
 524 # The valid values are:
 525 #
 526 #   - 'smb':    backup and restore via smbclient and the SMB protocol.
 527 #               Best choice for WinXX.
 528 #
 529 #   - 'rsync':  backup and restore via rsync (via rsh or ssh).
 530 #               Best choice for linux/unix.  Can also work on WinXX.
 531 #
 532 #   - 'rsyncd': backup and restre via rsync daemon on the client.
 533 #               Best choice for linux/unix if you have rsyncd running on
 534 #               the client.  Can also work on WinXX.
 535 #
 536 #   - 'tar':    backup and restore via tar, tar over ssh, rsh or nfs.
 537 #               Good choice for linux/unix.
 538 #
 539 # A future version should support 'rsync' as a transport method for
 540 # more efficient backup of linux/unix machines (and perhaps WinXX??).
 541 #
 542 $Conf{XferMethod} = 'smb';
 543
 544 #
 545 # Full path for smbclient. Security caution: normal users should not
 546 # allowed to write to this file or directory.
 547 #
 548 # smbclient is from the Samba distribution. smbclient is used to
 549 # actually extract the incremental or full dump of the share filesystem
 550 # from the PC.
 551 #
 552 # This setting only matters if $Conf{XferMethod} = 'smb'.
 553 #
 554 $Conf{SmbClientPath} = '/usr/bin/smbclient';
 555
 556 #
 557 # Commands to run smbclient for a full dump, incremental dump or a restore.
 558 # This setting only matters if $Conf{XferMethod} = 'smb'.
 559 #
 560 # Several variables are substituted at run-time:
 561 #
 562 #    $smbClientPath   same as $Conf{SmbClientPath}
 563 #    $host            host to backup/restore
 564 #    $hostIP          host IP address
 565 #    $shareName       share name
 566 #    $userName        user name
 567 #    $fileList        list of files to backup (based on exclude/include)
 568 #    $I_option        optional -I option to smbclient
 569 #    $X_option        exclude option (if $fileList is an exclude list)
 570 #    $timeStampFile   start time for incremental dump
 571 #
 572 $Conf{SmbClientFullCmd} = '$smbClientPath \\\\$host\\$shareName'
 573             . ' $I_option -U $userName -E -N -d 1'
 574             . ' -c tarmode\\ full -Tc$X_option - $fileList';
 575
 576 $Conf{SmbClientIncrCmd} = '$smbClientPath \\\\$host\\$shareName'
 577             . ' $I_option -U $userName -E -N -d 1'
 578             . ' -c tarmode\\ full -TcN$X_option $timeStampFile - $fileList';
 579
 580 $Conf{SmbClientRestoreCmd} = '$smbClientPath \\\\$host\\$shareName'
 581             . ' $I_option -U $userName -E -N -d 1'
 582             . ' -c tarmode\\ full -Tx -';
 583
 584 #
 585 # Full command to run tar on the client.  GNU tar is required.  You will
 586 # need to fill in the correct paths for ssh2 on the local host (server)
 587 # and GNU tar on the client.  Security caution: normal users should not
 588 # allowed to write to these executable files or directories.
 589 #
 590 # See the documentation for more information about setting up ssh2 keys.
 591 #
 592 # If you plan to use NFS then tar just runs locally and ssh2 is not needed.
 593 # For example, assuming the client filesystem is mounted below /mnt/hostName,
 594 # you could use something like:
 595 #
 596 #    $Conf{TarClientCmd} = '$tarPath -c -v -f - -C /mnt/$host/$shareName'
 597 #                        . ' --totals';
 598 #
 599 # In the case of NFS or rsh you need to make sure BackupPC's privileges
 600 # are sufficient to read all the files you want to backup.  Also, you
 601 # will probably want to add "/proc" to $Conf{BackupFilesExclude}.
 602 #
 603 # Several variables are substituted at run-time.  The following variables
 604 # are substituted at run-time:
 605 #
 606 #   $host        host name
 607 #   $hostIP      host's IP address
 608 #   $incrDate    newer-than date for incremental backups
 609 #   $shareName   share name to backup (ie: top-level directory path)
 610 #   $fileList    specific files to backup or exclude
 611 #   $tarPath     same as $Conf{TarClientPath}
 612 #   $sshPath     same as $Conf{SshPath}
 613 #
 614 # If a variable is followed by a "+" it is shell escaped.  This is
 615 # necessary for the command part of ssh or rsh, since it ends up
 616 # getting passed through the shell.
 617 #
 618 # This setting only matters if $Conf{XferMethod} = 'tar'.
 619 #
 620 $Conf{TarClientCmd} = '$sshPath -q -n -l root $host'
 621                     . ' $tarPath -c -v -f - -C $shareName+'
 622                     . ' --totals';
 623
 624 #
 625 # Extra tar arguments for full backups.  Several variables are substituted at
 626 # run-time.  See $Conf{TarClientCmd} for the list of variable substitutions.
 627 #
 628 # If you are running tar locally (ie: without rsh or ssh) then remove the
 629 # "+" so that the argument is no longer shell escaped.
 630 #
 631 # This setting only matters if $Conf{XferMethod} = 'tar'.
 632 #
 633 $Conf{TarFullArgs} = '$fileList+';
 634
 635 #
 636 # Extra tar arguments for incr backups.  Several variables are substituted at
 637 # run-time.  See $Conf{TarClientCmd} for the list of variable substitutions.
 638 #
 639 # Note that GNU tar has several methods for specifying incremental backups,
 640 # including:
 641 #
 642 #   --newer-mtime $incrDate+
 643 #          This causes a file to be included if the modification time is
 644 #          later than $incrDate (meaning its contents might have changed).
 645 #          But changes in the ownership or modes will not qualify the
 646 #          file to be included in an incremental.
 647 #
 648 #   --newer=$incrDate+
 649 #          This causes the file to be included if any attribute of the
 650 #          file is later than $incrDate, meaning either attributes or
 651 #          the modification time.  This is the default method.  Do
 652 #          not use --atime-preserve in $Conf{TarClientCmd} above,
 653 #          otherwise resetting the atime (access time) counts as an
 654 #          attribute change, meaning the file will always be included
 655 #          in each new incremental dump.
 656 #
 657 # If you are running tar locally (ie: without rsh or ssh) then remove the
 658 # "+" so that the argument is no longer shell escaped.
 659 #
 660 # This setting only matters if $Conf{XferMethod} = 'tar'.
 661 #
 662 $Conf{TarIncrArgs} = '--newer=$incrDate+ $fileList+';
 663
 664 #
 665 # Full command to run tar for restore on the client.  GNU tar is required.
 666 # This can be the same as $Conf{TarClientCmd}, with tar's -c replaced by -x
 667 # and ssh's -n removed.
 668 #
 669 # See $Conf{TarClientCmd} for full details.
 670 #
 671 # This setting only matters if $Conf{XferMethod} = "tar".
 672 #
 673 $Conf{TarClientRestoreCmd} = '$sshPath -q -l root $host'
 674                    . ' $tarPath -x -p --numeric-owner --same-owner'
 675                    . ' -v -f - -C $shareName+';
 676
 677 #
 678 # Full path for tar on the client. Security caution: normal users should not
 679 # allowed to write to this file or directory.
 680 #
 681 # This setting only matters if $Conf{XferMethod} = 'tar'.
 682 #
 683 $Conf{TarClientPath} = '/bin/tar';
 684
 685 #
 686 # Path to rsync executable on the client
 687 #
 688 $Conf{RsyncClientPath} = '/bin/rsync';
 689
 690 #
 691 # Full command to run rsync on the client machine.  The following variables
 692 # are substituted at run-time:
 693 #
 694 #        $host           host name being backed up
 695 #        $hostIP         host's IP address
 696 #        $shareName      share name to backup (ie: top-level directory path)
 697 #        $rsyncPath      same as $Conf{RsyncClientPath}
 698 #        $sshPath        same as $Conf{SshPath}
 699 #        $argList        argument list, built from $Conf{RsyncArgs},
 700 #                        $shareName, $Conf{BackupFilesExclude} and
 701 #                        $Conf{BackupFilesOnly}
 702 #
 703 # This setting only matters if $Conf{XferMethod} = 'rsync'.
 704 #
 705 $Conf{RsyncClientCmd} = '$sshPath -l root $host $rsyncPath $argList';
 706
 707 #
 708 # Full command to run rsync for restore on the client.  The following
 709 # variables are substituted at run-time:
 710 #
 711 #        $host           host name being backed up
 712 #        $hostIP         host's IP address
 713 #        $shareName      share name to backup (ie: top-level directory path)
 714 #        $rsyncPath      same as $Conf{RsyncClientPath}
 715 #        $sshPath        same as $Conf{SshPath}
 716 #        $argList        argument list, built from $Conf{RsyncArgs},
 717 #                        $shareName, $Conf{BackupFilesExclude} and
 718 #                        $Conf{BackupFilesOnly}
 719 #
 720 # This setting only matters if $Conf{XferMethod} = 'rsync'.
 721 #
 722 $Conf{RsyncClientRestoreCmd} = '$sshPath -l root $host $rsyncPath $argList';
 723
 724 #
 725 # Share name to backup.  For $Conf{XferMethod} = "rsync" this should
 726 # be a file system path, eg '/' or '/home'.
 727 #
 728 # For $Conf{XferMethod} = "rsyncd" this should be the name of the module
 729 # to backup (ie: the name from /etc/rsynd.conf).
 730 #
 731 # This can also be a list of multiple file system paths or modules.
 732 # For example, by adding --one-file-system to $Conf{RsyncArgs} you
 733 # can backup each file system separately, which makes restoring one
 734 # bad file system easier.  In this case you would list all of the mount
 735 # points:
 736 #
 737 #     $Conf{RsyncShareName} = ['/', '/var', '/data', '/boot'];
 738 #
 739 $Conf{RsyncShareName} = '/';
 740
 741 #
 742 # Rsync daemon port on the client, for $Conf{XferMethod} = "rsyncd".
 743 #
 744 $Conf{RsyncdClientPort} = 873;
 745
 746 #
 747 # Rsync daemon user name on client, for $Conf{XferMethod} = "rsyncd".
 748 # The user name and password are stored on the client in whatever file
 749 # the "secrets file" parameter in rsyncd.conf points to
 750 # (eg: /etc/rsyncd.secrets).
 751 #
 752 $Conf{RsyncdUserName} = '';
 753
 754 #
 755 # Rsync daemon user name on client, for $Conf{XferMethod} = "rsyncd".
 756 # The user name and password are stored on the client in whatever file
 757 # the "secrets file" parameter in rsyncd.conf points to
 758 # (eg: /etc/rsyncd.secrets).
 759 #
 760 $Conf{RsyncdPasswd} = '';
 761
 762 #
 763 # Whether authentication is mandatory when connecting to the client's
 764 # rsyncd.  By default this is on, ensuring that BackupPC will refuse to
 765 # connect to an rsyncd on the client that is not password protected.
 766 # Turn off at your own risk.
 767 #
 768 $Conf{RsyncdAuthRequired} = 1;
 769
 770 #
 771 # Arguments to rsync for backup.  Do not edit the first set unless you
 772 # have a thorough understanding of how File::RsyncP works.
 773 #
 774 # Examples of additional arguments that should work are --exclude/--include,
 775 # eg:
 776 #
 777 #     $Conf{RsyncArgs} = [
 778 #           # original arguments here
 779 #           '-v',
 780 #           '--exclude', '/proc',
 781 #           '--exclude', '*.tmp',
 782 #     ];
 783 #
 784 $Conf{RsyncArgs} = [
 785             #
 786             # Do not edit these!
 787             #
 788             '--numeric-ids',
 789             '--perms',
 790             '--owner',
 791             '--group',
 792             '--devices',
 793             '--links',
 794             '--times',
 795             '--block-size=2048',
 796             '--recursive',
 797             #
 798             # Add additional arguments here
 799             #
 800 ];
 801
 802 #
 803 # Arguments to rsync for restore.  Do not edit the first set unless you
 804 # have a thorough understanding of how File::RsyncP works.
 805 #
 806 #
 807 $Conf{RsyncRestoreArgs} = [
 808             #
 809             # Do not edit these!
 810             #
 811             "--numeric-ids",
 812             "--perms",
 813             "--owner",
 814             "--group",
 815             "--devices",
 816             "--links",
 817             "--times",
 818             "--block-size=2048",
 819             "--relative",
 820             "--ignore-times",
 821             "--recursive",
 822             #
 823             # Add additional arguments here
 824             #
 825 ];
 826
 827 #
 828 # Amount of verbosity in Rsync Xfer log files.  0 means be quiet,
 829 # 1 will give will give one line per file, 2 will also show skipped
 830 # files on incrementals, higher values give more output.  10 will
 831 # include byte dumps of all data read/written, which will make the
 832 # log files huge.
 833 #
 834 $Conf{RsyncLogLevel} = 1;
 835
 836 #
 837 # Full path for ssh. Security caution: normal users should not
 838 # allowed to write to this file or directory.
 839 #
 840 $Conf{SshPath} = '/usr/bin/ssh';
 841
 842 #
 843 # Full path for nmblookup. Security caution: normal users should not
 844 # allowed to write to this file or directory.
 845 #
 846 # nmblookup is from the Samba distribution. nmblookup is used to get the
 847 # netbios name, necessary for DHCP hosts.
 848 #
 849 $Conf{NmbLookupPath} = '/usr/bin/nmblookup';
 850
 851 #
 852 # NmbLookup command.  Given an IP address, does an nmblookup on that
 853 # IP address.  Several variables are substituted at run-time:
 854 #
 855 #   $nmbLookupPath      path to nmblookup ($Conf{NmbLookupPath})
 856 #   $host               IP address
 857 #
 858 # This command is only used for DHCP hosts: given an IP address, this
 859 # command should try to find its NetBios name.
 860 #
 861 $Conf{NmbLookupCmd} = '$nmbLookupPath -A $host';
 862
 863 #
 864 # NmbLookup command.  Given a netbios name, finds that host by doing
 865 # a NetBios multicast.  Several variables are substituted at run-time:
 866 #
 867 #   $nmbLookupPath      path to nmblookup ($Conf{NmbLookupPath})
 868 #   $host               NetBios name
 869 #
 870 # In some cases you might need to change the broadcast address, for
 871 # example if nmblookup uses 192.168.255.255 by default and you find
 872 # that doesn't work, try 192.168.1.255 (or your equivalent class C
 873 # address) using the -B option:
 874 #
 875 #    $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath -B 192.168.1.255 $host';
 876 #
 877 $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath $host';
 878
 879 #
 880 # For fixed IP address hosts, BackupPC_dump can also verify the netbios
 881 # name to ensure it matches the host name.  An error is generated if
 882 # they do not match.  Typically this flag is off.  But if you are going
 883 # to transition a bunch of machines from fixed host addresses to DHCP,
 884 # setting this flag is a great way to verify that the machines have
 885 # their netbios name set correctly before turning on DCHP.
 886 #
 887 $Conf{FixedIPNetBiosNameCheck} = 0;
 888
 889 #
 890 # Full path to the ping command.  Security caution: normal users
 891 # should not be allowed to write to this file or directory.
 892 #
 893 # If you want to disable ping checking, set this to some program
 894 # that exits with 0 status, eg:
 895 #
 896 #     $Conf{PingPath} = '/bin/echo';
 897 #
 898 $Conf{PingPath} = '/bin/ping';
 899
 900 #
 901 # Ping command.  Several variables are substituted at run-time:
 902 #
 903 #   $pingPath      path to ping ($Conf{PingPath})
 904 #   $host          host name
 905 #
 906 $Conf{PingCmd} = '$pingPath -c 1 $host';
 907
 908 #
 909 # Compression level to use on files.  0 means no compression.  Compression
 910 # levels can be from 1 (least cpu time, slightly worse compression) to
 911 # 9 (most cpu time, slightly better compression).  The recommended value
 912 # is 3.  Changing to 5, for example, will take maybe 20% more cpu time
 913 # and will get another 2-3% additional compression. See the zlib
 914 # documentation for more information about compression levels.
 915 #
 916 # Changing compression on or off after backups have already been done
 917 # will require both compressed and uncompressed pool files to be stored.
 918 # This will increase the pool storage requirements, at least until all
 919 # the old backups expire and are deleted.
 920 #
 921 # It is ok to change the compression value (from one non-zero value to
 922 # another non-zero value) after dumps are already done.  Since BackupPC
 923 # matches pool files by comparing the uncompressed versions, it will still
 924 # correctly match new incoming files against existing pool files.  The
 925 # new compression level will take effect only for new files that are
 926 # newly compressed and added to the pool.
 927 #
 928 # If compression was off and you are enabling compression for the first
 929 # time you can use the BackupPC_compressPool utility to compress the
 930 # pool.  This avoids having the pool grow to accommodate both compressed
 931 # and uncompressed backups.  See the documentation for more information.
 932 #
 933 # Note: compression needs the Compress::Zlib perl library.  If the
 934 # Compress::Zlib library can't be found then $Conf{CompressLevel} is
 935 # forced to 0 (compression off).
 936 #
 937 $Conf{CompressLevel} = 0;
 938
 939 #
 940 # Maximum round-trip ping time in milliseconds.  This threshold is set
 941 # to avoid backing up PCs that are remotely connected through WAN or
 942 # dialup connections.  The output from ping -s (assuming it is supported
 943 # on your system) is used to check the round-trip packet time.  On your
 944 # local LAN round-trip times should be much less than 20msec.  On most
 945 # WAN or dialup connections the round-trip time will be typically more
 946 # than 20msec.  Tune if necessary.
 947 #
 948 $Conf{PingMaxMsec} = 20;
 949
 950 #
 951 # Timeout in seconds when listening for the transport program's
 952 # (smbclient, tar etc) stdout. If no output is received during this
 953 # time, then it is assumed that something has wedged during a backup,
 954 # and the backup is terminated.
 955 #
 956 # Note that stdout buffering combined with huge files being backed up
 957 # could cause longish delays in the output from smbclient that
 958 # BackupPC_dump sees, so in rare cases you might want to increase
 959 # this value.
 960 #
 961 # Despite the name, this parameter sets the timeout for all transport
 962 # methods (tar, smb etc).
 963 #
 964 $Conf{ClientTimeout} = 7200;
 965
 966 #
 967 # Maximum number of log files we keep around in each PC's directory
 968 # (ie: pc/$host).  These files are aged monthly.  A setting of 12
 969 # means there will be at most the files LOG, LOG.0, LOG.1, ... LOG.11
 970 # in the pc/$host directory (ie: about a years worth).  (Except this
 971 # month's LOG, these files will have a .z extension if compression
 972 # is on).
 973 #
 974 # If you decrease this number after BackupPC has been running for a
 975 # while you will have to manually remove the older log files.
 976 #
 977 $Conf{MaxOldPerPCLogFiles} = 12;
 978
 979 #
 980 # Optional commands to run before and after dumps and restores.
 981 # Stdout from these commands will be written to the Xfer (or Restore)
 982 # log file.  One example of using these commands would be to
 983 # shut down and restart a database server, or to dump a database
 984 # to files for backup.  Example:
 985 #
 986 #    $Conf{DumpPreUserCmd} = '$sshPath -l root $host /usr/bin/dumpMysql';
 987 #
 988 # Various variable substitutions are available; see BackupPC_dump
 989 # or BackupPC_restore for the details.
 990 #
 991 $Conf{DumpPreUserCmd}     = undef;
 992 $Conf{DumpPostUserCmd}    = undef;
 993 $Conf{RestorePreUserCmd}  = undef;
 994 $Conf{RestorePostUserCmd} = undef;
 995
 996 #
 997 # Override the client's host name.  This allows multiple clients
 998 # to all refer to the same physical hostj.  This should only be
 999 # set in the per-PC config file and is only used by BackupPC at
1000 # the last moment prior to generating the command used to backup
1001 # that machine (ie: the value of $Conf{ClientNameAlias} is invisible
1002 # everywhere else in BackupPC).  Eg:
1003 #
1004 #         $Conf{ClientNameAlias} = 'realHostName';
1005 #
1006 # will cause the relevant smb/tar/rsync backup/restore commands to be
1007 # directed to realHostName, not the client name.
1008 #
1009 # Note: this setting doesn't work for hosts with DHCP set to 1.
1010 #
1011 $Conf{ClientNameAlias} = undef;
1012
1013 #
1014 # Advanced option for asking BackupPC to load additional perl modules.
1015 # Can be a list (array ref) of module names to load at startup.
1016 #
1017 $Conf{PerlModuleLoad}     = undef;
1018
1019 ###########################################################################
1020 # Email reminders, status and messages
1021 # (can be overridden in the per-PC config.pl)
1022 ###########################################################################
1023 #
1024 # Full path to the sendmail command.  Security caution: normal users
1025 # should not allowed to write to this file or directory.
1026 #
1027 $Conf{SendmailPath} = '/usr/sbin/sendmail';
1028
1029 #
1030 # Minimum period between consecutive emails to a single user.
1031 # This tries to keep annoying email to users to a reasonable
1032 # level.  Email checks are done nightly, so this number is effectively
1033 # rounded up (ie: 2.5 means a user will never receive email more
1034 # than once every 3 days).
1035 #
1036 $Conf{EMailNotifyMinDays} = 2.5;
1037
1038 #
1039 # Name to use as the "from" name for email.  Depending upon your mail
1040 # handler this is either a plain name (eg: "admin") or a fully-qualified
1041 # name (eg: "admin@mydomain.com").
1042 #
1043 $Conf{EMailFromUserName} = '';
1044
1045 #
1046 # Destination address to an administrative user who will receive a
1047 # nightly email with warnings and errors.  If there are no warnings
1048 # or errors then no email will be sent.  Depending upon your mail
1049 # handler this is either a plain name (eg: "admin") or a fully-qualified
1050 # name (eg: "admin@mydomain.com").
1051 #
1052 $Conf{EMailAdminUserName} = '';
1053
1054 #
1055 # Destination domain name for email sent to users.  By default
1056 # this is empty, meaning email is sent to plain, unqualified
1057 # addresses.  Otherwise, set it to the destintation domain, eg:
1058 #
1059 #    $Cong{EMailUserDestDomain} = '@mydomain.com';
1060 #
1061 # With this setting user email will be set to 'user@mydomain.com'.
1062 #
1063 $Conf{EMailUserDestDomain} = '';
1064
1065 #
1066 # This subject and message is sent to a user if their PC has never been
1067 # backed up.
1068 #
1069 # These values are language-dependent.  The default versions can be
1070 # found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
1071 # need to change the message, copy it here and edit it, eg:
1072 #
1073 #   $Conf{EMailNoBackupEverMesg} = <<'EOF';
1074 #   To: $user$domain
1075 #   cc:
1076 #   Subject: $subj
1077 #
1078 #   Dear $userName,
1079 #
1080 #   This is a site-specific email message.
1081 #   EOF
1082 #
1083 $Conf{EMailNoBackupEverSubj} = undef;
1084 $Conf{EMailNoBackupEverMesg} = undef;
1085
1086 #
1087 # How old the most recent backup has to be before notifying user.
1088 # When there have been no backups in this number of days the user
1089 # is sent an email.
1090 #
1091 $Conf{EMailNotifyOldBackupDays} = 7.0;
1092
1093 #
1094 # This subject and message is sent to a user if their PC has not recently
1095 # been backed up (ie: more than $Conf{EMailNotifyOldBackupDays} days ago).
1096 #
1097 # These values are language-dependent.  The default versions can be
1098 # found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
1099 # need to change the message, copy it here and edit it, eg:
1100 #
1101 #   $Conf{EMailNoBackupRecentMesg} = <<'EOF';
1102 #   To: $user$domain
1103 #   cc:
1104 #   Subject: $subj
1105 #
1106 #   Dear $userName,
1107 #
1108 #   This is a site-specific email message.
1109 #   EOF
1110 #
1111 $Conf{EMailNoBackupRecentSubj} = undef;
1112 $Conf{EMailNoBackupRecentMesg} = undef;
1113
1114 #
1115 # How old the most recent backup of Outlook files has to be before
1116 # notifying user.
1117 #
1118 $Conf{EMailNotifyOldOutlookDays} = 5.0;
1119
1120 #
1121 # This subject and message is sent to a user if their Outlook files have
1122 # not recently been backed up (ie: more than $Conf{EMailNotifyOldOutlookDays}
1123 # days ago).
1124 #
1125 # These values are language-dependent.  The default versions can be
1126 # found in the language file (eg: lib/BackupPC/Lang/en.pm).  If you
1127 # need to change the message, copy it here and edit it, eg:
1128 #
1129 #   $Conf{EMailOutlookBackupMesg} = <<'EOF';
1130 #   To: $user$domain
1131 #   cc:
1132 #   Subject: $subj
1133 #
1134 #   Dear $userName,
1135 #
1136 #   This is a site-specific email message.
1137 #   EOF
1138 #
1139 $Conf{EMailOutlookBackupSubj} = undef;
1140 $Conf{EMailOutlookBackupMesg} = undef;
1141
1142 ###########################################################################
1143 # CGI user interface configuration settings
1144 # (can be overridden in the per-PC config.pl)
1145 ###########################################################################
1146 #
1147 # Normal users can only access information specific to their host.
1148 # They can start/stop/browse/restore backups.
1149 #
1150 # Administrative users have full access to all hosts, plus overall
1151 # status and log information.
1152 #
1153 # The administrative users are the union of the unix/linux group
1154 # $Conf{CgiAdminUserGroup} and the manual list of users, separated
1155 # by spaces, in $Conf{CgiAdminUsers}. If you don't want a group or
1156 # manual list of users set the corresponding configuration setting
1157 # to undef or an empty string.
1158 #
1159 # If you want every user to have admin privileges (careful!), set
1160 # $Conf{CgiAdminUsers} = '*'.
1161 #
1162 # Examples:
1163 #    $Conf{CgiAdminUserGroup} = 'admin';
1164 #    $Conf{CgiAdminUsers}     = 'craig celia';
1165 #    --> administrative users are the union of group admin, plus
1166 #      craig and celia.
1167 #
1168 #    $Conf{CgiAdminUserGroup} = '';
1169 #    $Conf{CgiAdminUsers}     = 'craig celia';
1170 #    --> administrative users are only craig and celia'.
1171 #
1172 $Conf{CgiAdminUserGroup} = '';
1173 $Conf{CgiAdminUsers}     = '';
1174
1175 #
1176 # URL of the BackupPC_Admin CGI script.  Used for email messages.
1177 #
1178 $Conf{CgiURL} = undef;
1179
1180 #
1181 # Language to use.  See lib/BackupPC/Lang for the list of supported
1182 # languages, which includes English (en) and French (fr).  Currently
1183 # this applies mainly to the CGI interface, but over time it might
1184 # also include log files and other text output.
1185 #
1186 $Conf{Language} = 'en';
1187
1188 #
1189 # User names that are rendered by the CGI interface can be turned
1190 # into links into their home page or other information about the
1191 # user.  To set this up you need to create two sprintf() strings,
1192 # that each contain a single '%s' that will be replaced by the user
1193 # name.  The default is a mailto: link.
1194 #
1195 # $Conf{CgiUserHomePageCheck} should be an absolute file path that
1196 # is used to check (via "-f") that the user has a valid home page.
1197 # Set this to undef or an empty string to turn off this check.
1198 #
1199 # $Conf{CgiUserUrlCreate} should be a full URL that points to the
1200 # user's home page.  Set this to undef or an empty string to turn
1201 # off generation of URLs for user names.
1202 #
1203 # Example:
1204 #    $Conf{CgiUserHomePageCheck} = '/var/www/html/users/%s.html';
1205 #    $Conf{CgiUserUrlCreate}     = 'http://myhost/users/%s.html';
1206 #    --> if /var/www/html/users/craig.html exists, then 'craig' will
1207 #      be rendered as a link to http://myhost/users/craig.html.
1208 #
1209 $Conf{CgiUserHomePageCheck} = '';
1210 $Conf{CgiUserUrlCreate}     = 'mailto:%s';
1211
1212 #
1213 # Date display format for CGI interface.  True for US-style dates (MM/DD)
1214 # and zero for international dates (DD/MM).
1215 #
1216 $Conf{CgiDateFormatMMDD} = 1;
1217
1218 #
1219 # If set, the complete list of hosts appears in the left navigation
1220 # bar for administrators.  Otherwise, just the hosts for which the
1221 # user is listed in the host file (as either the user or in moreUsers)
1222 # are displayed.
1223 #
1224 $Conf{CgiNavBarAdminAllHosts} = 0;
1225
1226 #
1227 # Header font and size for CGI interface
1228 #
1229 $Conf{CgiHeaderFontType} = 'arial';
1230 $Conf{CgiHeaderFontSize} = '3';
1231
1232 #
1233 # Color scheme for CGI interface.  Default values give a very light blue
1234 # for the background navigation color, green for the header background,
1235 # and white for the body background.  (You call tell I should stick to
1236 # programming and not graphical design.)
1237 #
1238 $Conf{CgiNavBarBgColor} = '#ddeeee';
1239 $Conf{CgiHeaderBgColor} = '#99cc33';
1240 $Conf{CgiBodyBgColor}   = '#ffffff';
1241
1242 #
1243 # Additional CGI header text.  For example, if you wanted each CGI page
1244 # to auto refresh every 900 seconds, you could add this text:
1245 #
1246 #       <meta http-equiv="refresh" content="900">
1247 #
1248 $Conf{CgiHeaders} = '<meta http-equiv="pragma" content="no-cache">';
1249
1250 #
1251 # Directory where images are stored.  This directory should be below
1252 # Apache's DocumentRoot.  This value isn't used by BackupPC but is
1253 # used by configure.pl when you upgrade BackupPC.
1254 #
1255 # Example:
1256 #     $Conf{CgiImageDir} = '/usr/local/apache/htdocs/BackupPC';
1257 #
1258 $Conf{CgiImageDir} = '';
1259
1260 #
1261 # Additional mappings of file name extenions to Content-Type for
1262 # individual file restore.  See $Ext2ContentType in BackupPC_Admin
1263 # for the default setting.  You can add additional settings here,
1264 # or override any default settings.  Example:
1265 #
1266 #     $Conf{CgiExt2ContentType} = {
1267 #                 'pl'  => 'text/plain',
1268 #          };
1269 #
1270 $Conf{CgiExt2ContentType} = { };
1271
1272 #
1273 # URL (without the leading http://host) for BackupPC's image directory.
1274 # The CGI script uses this value to serve up image files.
1275 #
1276 # Example:
1277 #     $Conf{CgiImageDirURL} = '/BackupPC';
1278 #
1279 $Conf{CgiImageDirURL} = '';