X-Git-Url: http://git.rot13.org/?p=BackupPC.git;a=blobdiff_plain;f=conf%2Fconfig.pl;h=d0b1a684a82f74d51bed8290b76874f41af8f14c;hp=5b0cd9456c523ad22e665282443aeb900d8a5d1e;hb=38abb9a20f4f9562df117185570646049ce126fb;hpb=2c14784ad71874ec850d189060fe63d6eb9eba95 diff --git a/conf/config.pl b/conf/config.pl index 5b0cd94..d0b1a68 100644 --- a/conf/config.pl +++ b/conf/config.pl @@ -29,7 +29,7 @@ # Craig Barratt # # COPYRIGHT -# Copyright (C) 2001-2003 Craig Barratt +# Copyright (C) 2001-2009 Craig Barratt # # See http://backuppc.sourceforge.net. # @@ -98,17 +98,22 @@ $Conf{UmaskMode} = 027; # you might have only one or two wakeups each night. This will keep # the backup activity after hours. On the other hand, if you are backing # up laptops that are only intermittently connected to the network you -# will want to have frequent wakeups (eg: hourly) to maximized the chance +# will want to have frequent wakeups (eg: hourly) to maximize the chance # that each laptop is backed up. # # Examples: # $Conf{WakeupSchedule} = [22.5]; # once per day at 10:30 pm. -# $Conf{WakeupSchedule} = [1..23]; # every hour except midnight # $Conf{WakeupSchedule} = [2,4,6,8,10,12,14,16,18,20,22]; # every 2 hours # # The default value is every hour except midnight. # -$Conf{WakeupSchedule} = [1..23]; +# The first entry of $Conf{WakeupSchedule} is when BackupPC_nightly is run. +# You might want to re-arrange the entries in $Conf{WakeupSchedule} +# (they don't have to be ascending) so that the first entry is when +# you want BackupPC_nightly to run (eg: when you don't expect a lot +# of regular backups to run). +# +$Conf{WakeupSchedule} = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23]; # # Maximum number of simultaneous backups to run. If there @@ -131,7 +136,58 @@ $Conf{MaxUserBackups} = 4; # This limit is to make sure BackupPC doesn't fall too far behind in # running BackupPC_link commands. # -$Conf{MaxPendingCmds} = 10; +$Conf{MaxPendingCmds} = 15; + +# +# Nice level at which CmdQueue commands (eg: BackupPC_link and +# BackupPC_nightly) are run at. +# +$Conf{CmdQueueNice} = 10; + +# +# How many BackupPC_nightly processes to run in parallel. +# +# Each night, at the first wakeup listed in $Conf{WakeupSchedule}, +# BackupPC_nightly is run. Its job is to remove unneeded files +# in the pool, ie: files that only have one link. To avoid race +# conditions, BackupPC_nightly and BackupPC_link cannot run at +# the same time. Starting in v3.0.0, BackupPC_nightly can run +# concurrently with backups (BackupPC_dump). +# +# So to reduce the elapsed time, you might want to increase this +# setting to run several BackupPC_nightly processes in parallel +# (eg: 4, or even 8). +# +$Conf{MaxBackupPCNightlyJobs} = 2; + +# +# How many days (runs) it takes BackupPC_nightly to traverse the +# entire pool. Normally this is 1, which means every night it runs, +# it does traverse the entire pool removing unused pool files. +# +# Other valid values are 2, 4, 8, 16. This causes BackupPC_nightly to +# traverse 1/2, 1/4, 1/8 or 1/16th of the pool each night, meaning it +# takes 2, 4, 8 or 16 days to completely traverse the pool. The +# advantage is that each night the running time of BackupPC_nightly +# is reduced roughly in proportion, since the total job is split +# over multiple days. The disadvantage is that unused pool files +# take longer to get deleted, which will slightly increase disk +# usage. +# +# Note that even when $Conf{BackupPCNightlyPeriod} > 1, BackupPC_nightly +# still runs every night. It just does less work each time it runs. +# +# Examples: +# +# $Conf{BackupPCNightlyPeriod} = 1; # entire pool is checked every night +# +# $Conf{BackupPCNightlyPeriod} = 2; # two days to complete pool check +# # (different half each night) +# +# $Conf{BackupPCNightlyPeriod} = 4; # four days to complete pool check +# # (different quarter each night) +# +$Conf{BackupPCNightlyPeriod} = 1; # # Maximum number of log files we keep around in log directory. @@ -150,7 +206,7 @@ $Conf{MaxOldLogFiles} = 14; # Full path to the df command. Security caution: normal users # should not allowed to write to this file or directory. # -$Conf{DfPath} = '/bin/df'; +$Conf{DfPath} = ''; # # Command to run df. The following variables are substituted at run-time: @@ -158,17 +214,20 @@ $Conf{DfPath} = '/bin/df'; # $dfPath path to df ($Conf{DfPath}) # $topDir top-level BackupPC data directory # +# Note: all Cmds are executed directly without a shell, so the prog name +# needs to be a full path and you can't include shell syntax like +# redirection and pipes; put that in a script if you need it. +# $Conf{DfCmd} = '$dfPath $topDir'; # # Full path to various commands for archiving # - -$Conf{SplitPath} = '/usr/bin/split'; -$Conf{ParPath} = '/usr/bin/par'; -$Conf{CatPath} = '/bin/cat'; -$Conf{GzipPath} = '/bin/gzip'; -$Conf{Bzip2Path} = '/usr/bin/bzip2'; +$Conf{SplitPath} = ''; +$Conf{ParPath} = ''; +$Conf{CatPath} = ''; +$Conf{GzipPath} = ''; +$Conf{Bzip2Path} = ''; # # Maximum threshold for disk utilization on the __TOPDIR__ filesystem. @@ -219,14 +278,35 @@ $Conf{TrashCleanSleepSec} = 300; $Conf{DHCPAddressRanges} = []; # -# These configuration settings aren't used by BackupPC, but simply -# remember a few settings used by configure.pl during installation. -# These are used by configure.pl when upgrading to new versions of -# BackupPC. +# The BackupPC user. # $Conf{BackupPCUser} = ''; -$Conf{CgiDir} = ''; -$Conf{InstallDir} = ''; + +# +# Important installation directories: +# +# TopDir - where all the backup data is stored +# ConfDir - where the main config and hosts files resides +# LogDir - where log files and other transient information +# InstallDir - where the bin, lib and doc installation dirs reside. +# Note: you cannot change this value since all the +# perl scripts include this path. You must reinstall +# with configure.pl to change InstallDir. +# CgiDir - Apache CGI directory for BackupPC_Admin +# +# Note: it is STRONGLY recommended that you don't change the +# values here. These are set at installation time and are here +# for reference and are used during upgrades. +# +# Instead of changing TopDir here it is recommended that you use +# a symbolic link to the new location, or mount the new BackupPC +# store at the existing $Conf{TopDir} setting. +# +$Conf{TopDir} = ''; +$Conf{ConfDir} = ''; +$Conf{LogDir} = ''; +$Conf{InstallDir} = ''; +$Conf{CgiDir} = ''; # # Whether BackupPC and the CGI script BackupPC_Admin verify that they @@ -249,72 +329,40 @@ $Conf{BackupPCUserVerify} = 1; # $Conf{HardLinkMax} = 31999; -########################################################################### -# What to backup and when to do it -# (can be overridden in the per-PC config.pl) -########################################################################### -# -# Name of the host share that is backed up when using SMB. This can be a -# string or an array of strings if there are multiple shares per host. -# Examples: # -# $Conf{SmbShareName} = 'c'; # backup 'c' share -# $Conf{SmbShareName} = ['c', 'd']; # backup 'c' and 'd' shares -# -# This setting only matters if $Conf{XferMethod} = 'smb'. +# Advanced option for asking BackupPC to load additional perl modules. +# Can be a list (array ref) of module names to load at startup. # -$Conf{SmbShareName} = 'C$'; +$Conf{PerlModuleLoad} = undef; # -# Smbclient share user name. This is passed to smbclient's -U argument. +# Path to init.d script and command to use that script to start the +# server from the CGI interface. The following variables are substituted +# at run-time: # -# This setting only matters if $Conf{XferMethod} = 'smb'. +# $sshPath path to ssh ($Conf{SshPath}) +# $serverHost same as $Conf{ServerHost} +# $serverInitdPath path to init.d script ($Conf{ServerInitdPath}) # -$Conf{SmbShareUserName} = ''; - +# Example: # -# Smbclient share password. This is passed to smbclient via its PASSWD -# environment variable. There are several ways you can tell BackupPC -# the smb share password. In each case you should be very careful about -# security. If you put the password here, make sure that this file is -# not readable by regular users! See the "Setting up config.pl" section -# in the documentation for more information. +# $Conf{ServerInitdPath} = '/etc/init.d/backuppc'; +# $Conf{ServerInitdStartCmd} = '$sshPath -q -x -l root $serverHost' +# . ' $serverInitdPath start' +# . ' < /dev/null >& /dev/null'; # -# This setting only matters if $Conf{XferMethod} = 'smb'. +# Note: all Cmds are executed directly without a shell, so the prog name +# needs to be a full path and you can't include shell syntax like +# redirection and pipes; put that in a script if you need it. # -$Conf{SmbSharePasswd} = ''; +$Conf{ServerInitdPath} = ''; +$Conf{ServerInitdStartCmd} = ''; -# -# Which host directories to backup when using tar transport. This can be a -# string or an array of strings if there are multiple directories to -# backup per host. Examples: -# -# $Conf{TarShareName} = '/'; # backup everything -# $Conf{TarShareName} = '/home'; # only backup /home -# $Conf{TarShareName} = ['/home', '/src']; # backup /home and /src -# -# The fact this parameter is called 'TarShareName' is for historical -# consistency with the Smb transport options. You can use any valid -# directory on the client: there is no need for it to correspond to -# any Smb share or device mount point. -# -# Note also that you can also use $Conf{BackupFilesOnly} to specify -# a specific list of directories to backup. It's more efficient to -# use this option instead of $Conf{TarShareName} since a new tar is -# run for each entry in $Conf{TarShareName}. -# -# On the other hand, if you add --one-file-system to $Conf{TarClientCmd} -# you can backup each file system separately, which makes restoring one -# bad file system easier. In this case you would list all of the mount -# points here, since you can't get the same result with -# $Conf{BackupFilesOnly}: -# -# $Conf{TarShareName} = ['/', '/var', '/data', '/boot']; -# -# This setting only matters if $Conf{XferMethod} = 'tar'. -# -$Conf{TarShareName} = '/'; +########################################################################### +# What to backup and when to do it +# (can be overridden in the per-PC config.pl) +########################################################################### # # Minimum period in days between full backups. A full dump will only be # done if at least this much time has elapsed since the last full dump, @@ -325,22 +373,6 @@ $Conf{TarShareName} = '/'; # time taken for the backup, plus the granularity of $Conf{WakeupSchedule} # will make the actual backup interval a bit longer. # -# There are two special values for $Conf{FullPeriod}: -# -# -1 Don't do any regular backups on this machine. Manually -# requested backups (via the CGI interface) will still occur. -# -# -2 Don't do any backups on this machine. Manually requested -# backups (via the CGI interface) will be ignored. -# -# These special settings are useful for a client that is no longer -# being backed up (eg: a retired machine), but you wish to keep the -# last backups available for browsing or restoring to other machines. -# -# Also, you might create a virtual client (by setting $Conf{ClientNameAlias}) -# for restoring to a DVD or permanent media and you would set -# $Conf{FullPeriod} to -2 so that it is never backed up. -# $Conf{FullPeriod} = 6.97; # @@ -361,8 +393,70 @@ $Conf{IncrPeriod} = 0.97; # extra old backups will be removed. # # If filling of incremental dumps is off the oldest backup always -# has to be a full (ie: filled) dump. This might mean an extra full -# dump is kept until the second oldest (incremental) dump expires. +# has to be a full (ie: filled) dump. This might mean one or two +# extra full dumps are kept until the oldest incremental backups expire. +# +# Exponential backup expiry is also supported. This allows you to specify: +# +# - num fulls to keep at intervals of 1 * $Conf{FullPeriod}, followed by +# - num fulls to keep at intervals of 2 * $Conf{FullPeriod}, +# - num fulls to keep at intervals of 4 * $Conf{FullPeriod}, +# - num fulls to keep at intervals of 8 * $Conf{FullPeriod}, +# - num fulls to keep at intervals of 16 * $Conf{FullPeriod}, +# +# and so on. This works by deleting every other full as each expiry +# boundary is crossed. +# +# Exponential expiry is specified using an array for $Conf{FullKeepCnt}: +# +# $Conf{FullKeepCnt} = [4, 2, 3]; +# +# Entry #n specifies how many fulls to keep at an interval of +# 2^n * $Conf{FullPeriod} (ie: 1, 2, 4, 8, 16, 32, ...). +# +# The example above specifies keeping 4 of the most recent full backups +# (1 week interval) two full backups at 2 week intervals, and 3 full +# backups at 4 week intervals, eg: +# +# full 0 19 weeks old \ +# full 1 15 weeks old >--- 3 backups at 4 * $Conf{FullPeriod} +# full 2 11 weeks old / +# full 3 7 weeks old \____ 2 backups at 2 * $Conf{FullPeriod} +# full 4 5 weeks old / +# full 5 3 weeks old \ +# full 6 2 weeks old \___ 4 backups at 1 * $Conf{FullPeriod} +# full 7 1 week old / +# full 8 current / +# +# On a given week the spacing might be less than shown as each backup +# ages through each expiry period. For example, one week later, a +# new full is completed and the oldest is deleted, giving: +# +# full 0 16 weeks old \ +# full 1 12 weeks old >--- 3 backups at 4 * $Conf{FullPeriod} +# full 2 8 weeks old / +# full 3 6 weeks old \____ 2 backups at 2 * $Conf{FullPeriod} +# full 4 4 weeks old / +# full 5 3 weeks old \ +# full 6 2 weeks old \___ 4 backups at 1 * $Conf{FullPeriod} +# full 7 1 week old / +# full 8 current / +# +# You can specify 0 as a count (except in the first entry), and the +# array can be as long as you wish. For example: +# +# $Conf{FullKeepCnt} = [4, 0, 4, 0, 0, 2]; +# +# This will keep 10 full dumps, 4 most recent at 1 * $Conf{FullPeriod}, +# followed by 4 at an interval of 4 * $Conf{FullPeriod} (approx 1 month +# apart), and then 2 at an interval of 32 * $Conf{FullPeriod} (approx +# 7-8 months apart). +# +# Example: these two settings are equivalent and both keep just +# the four most recent full dumps: +# +# $Conf{FullKeepCnt} = 4; +# $Conf{FullKeepCnt} = [4]; # $Conf{FullKeepCnt} = 1; @@ -371,8 +465,12 @@ $Conf{FullKeepCnt} = 1; # we keep at least $Conf{FullKeepCntMin} full backups no matter how old # they are. # +# Note that $Conf{FullAgeMax} will be increased to $Conf{FullKeepCnt} +# times $Conf{FullPeriod} if $Conf{FullKeepCnt} specifies enough +# full backups to exceed $Conf{FullAgeMax}. +# $Conf{FullKeepCntMin} = 1; -$Conf{FullAgeMax} = 60; +$Conf{FullAgeMax} = 90; # # Number of incremental backups to keep. Must be >= 1. @@ -391,6 +489,120 @@ $Conf{IncrKeepCnt} = 6; $Conf{IncrKeepCntMin} = 1; $Conf{IncrAgeMax} = 30; +# +# Level of each incremental. "Level" follows the terminology +# of dump(1). A full backup has level 0. A new incremental +# of level N will backup all files that have changed since +# the most recent backup of a lower level. +# +# The entries of $Conf{IncrLevels} apply in order to each +# incremental after each full backup. It wraps around until +# the next full backup. For example, these two settings +# have the same effect: +# +# $Conf{IncrLevels} = [1, 2, 3]; +# $Conf{IncrLevels} = [1, 2, 3, 1, 2, 3]; +# +# This means the 1st and 4th incrementals (level 1) go all +# the way back to the full. The 2nd and 3rd (and 5th and +# 6th) backups just go back to the immediate preceeding +# incremental. +# +# Specifying a sequence of multi-level incrementals will +# usually mean more than $Conf{IncrKeepCnt} incrementals will +# need to be kept, since lower level incrementals are needed +# to merge a complete view of a backup. For example, with +# +# $Conf{FullPeriod} = 7; +# $Conf{IncrPeriod} = 1; +# $Conf{IncrKeepCnt} = 6; +# $Conf{IncrLevels} = [1, 2, 3, 4, 5, 6]; +# +# there will be up to 11 incrementals in this case: +# +# backup #0 (full, level 0, oldest) +# backup #1 (incr, level 1) +# backup #2 (incr, level 2) +# backup #3 (incr, level 3) +# backup #4 (incr, level 4) +# backup #5 (incr, level 5) +# backup #6 (incr, level 6) +# backup #7 (full, level 0) +# backup #8 (incr, level 1) +# backup #9 (incr, level 2) +# backup #10 (incr, level 3) +# backup #11 (incr, level 4) +# backup #12 (incr, level 5, newest) +# +# Backup #1 (the oldest level 1 incremental) can't be deleted +# since backups 2..6 depend on it. Those 6 incrementals can't +# all be deleted since that would only leave 5 (#8..12). +# When the next incremental happens (level 6), the complete +# set of 6 older incrementals (#1..6) will be deleted, since +# that maintains the required number ($Conf{IncrKeepCnt}) +# of incrementals. This situation is reduced if you set +# shorter chains of multi-level incrementals, eg: +# +# $Conf{IncrLevels} = [1, 2, 3]; +# +# would only have up to 2 extra incremenals before all 3 +# are deleted. +# +# BackupPC as usual merges the full and the sequence +# of incrementals together so each incremental can be +# browsed and restored as though it is a complete backup. +# If you specify a long chain of incrementals then more +# backups need to be merged when browsing, restoring, +# or getting the starting point for rsync backups. +# In the example above (levels 1..6), browing backup +# #6 requires 7 different backups (#0..6) to be merged. +# +# Because of this merging and the additional incrementals +# that need to be kept, it is recommended that some +# level 1 incrementals be included in $Conf{IncrLevels}. +# +# Prior to version 3.0 incrementals were always level 1, +# meaning each incremental backed up all the files that +# changed since the last full. +# +$Conf{IncrLevels} = [1]; + +# +# Disable all full and incremental backups. These settings are +# useful for a client that is no longer being backed up +# (eg: a retired machine), but you wish to keep the last +# backups available for browsing or restoring to other machines. +# +# There are three values for $Conf{BackupsDisable}: +# +# 0 Backups are enabled. +# +# 1 Don't do any regular backups on this client. Manually +# requested backups (via the CGI interface) will still occur. +# +# 2 Don't do any backups on this client. Manually requested +# backups (via the CGI interface) will be ignored. +# +# In versions prior to 3.0 Backups were disabled by setting +# $Conf{FullPeriod} to -1 or -2. +# +$Conf{BackupsDisable} = 0; + +# +# A failed full backup is saved as a partial backup. The rsync +# XferMethod can take advantage of the partial full when the next +# backup is run. This parameter sets the age of the partial full +# in days: if the partial backup is older than this number of +# days, then rsync will ignore (not use) the partial full when +# the next backup is run. If you set this to a negative value +# then no partials will be saved. If you set this to 0, partials +# will be saved, but will not be used by the next backup. +# +# The default setting of 3 days means that a partial older than +# 3 days is ignored when the next full backup is done. +# +$Conf{PartialAgeMax} = 3; + # # Whether incremental backups are filled. "Filling" means that the # most recent full (or filled) dump is merged into the new incremental @@ -453,7 +665,10 @@ $Conf{ArchiveInfoKeepCnt} = 10; # to give a list of directories or files to backup for each share # (the share name is the key). If this is set to just a string or # array, and $Conf{SmbShareName} contains multiple share names, then -# the setting is assumed to apply to only the first share name. +# the setting is assumed to apply all shares. +# +# If a hash is used, a special key "*" means it applies to all +# shares that don't have a specific entry. # # Examples: # $Conf{BackupFilesOnly} = '/myFiles'; @@ -463,6 +678,10 @@ $Conf{ArchiveInfoKeepCnt} = 10; # 'c' => ['/myFiles', '/important'], # these are for 'c' share # 'd' => ['/moreFiles', '/archive'], # these are for 'd' share # }; +# $Conf{BackupFilesOnly} = { +# 'c' => ['/myFiles', '/important'], # these are for 'c' share +# '*' => ['/myFiles', '/important'], # these are other shares +# }; # $Conf{BackupFilesOnly} = undef; @@ -478,7 +697,7 @@ $Conf{BackupFilesOnly} = undef; # to give a list of directories or files to exclude for each share # (the share name is the key). If this is set to just a string or # array, and $Conf{SmbShareName} contains multiple share names, then -# the setting is assumed to apply to only the first share name. +# the setting is assumed to apply to all shares. # # The exact behavior is determined by the underlying transport program, # smbclient or tar. For smbclient the exlclude file list is passed into @@ -495,6 +714,18 @@ $Conf{BackupFilesOnly} = undef; # the directory name: a trailing "/" causes the name to not match # and the directory will not be excluded. # +# Users report that for smbclient you should specify a directory +# followed by "/*", eg: "/proc/*", instead of just "/proc". +# +# FTP servers are traversed recursively so excluding directories will +# also exclude its contents. You can use the wildcard characters "*" +# and "?" to define files for inclusion and exclusion. Both +# attributes $Conf{BackupFilesOnly} and $Conf{BackupFilesExclude} can +# be defined for the same share. +# +# If a hash is used, a special key "*" means it applies to all +# shares that don't have a specific entry. +# # Examples: # $Conf{BackupFilesExclude} = '/temp'; # $Conf{BackupFilesExclude} = ['/temp']; # same as first example @@ -503,6 +734,10 @@ $Conf{BackupFilesOnly} = undef; # 'c' => ['/temp', '/winnt/tmp'], # these are for 'c' share # 'd' => ['/junk', '/dont_back_this_up'], # these are for 'd' share # }; +# $Conf{BackupFilesExclude} = { +# 'c' => ['/temp', '/winnt/tmp'], # these are for 'c' share +# '*' => ['/junk', '/dont_back_this_up'], # these are for other shares +# }; # $Conf{BackupFilesExclude} = undef; @@ -512,8 +747,7 @@ $Conf{BackupFilesExclude} = undef; # each PC a count of consecutive good pings is maintained. Once a PC has # at least $Conf{BlackoutGoodCnt} consecutive good pings it is subject # to "blackout" and not backed up during hours and days specified by -# $Conf{BlackoutWeekDays}, $Conf{BlackoutHourBegin} and -# $Conf{BlackoutHourEnd}. +# $Conf{BlackoutPeriods}. # # To allow for periodic rebooting of a PC or other brief periods when a # PC is not on the network, a number of consecutive bad pings is allowed @@ -539,13 +773,52 @@ $Conf{BlackoutBadPingLimit} = 3; $Conf{BlackoutGoodCnt} = 7; # -# The default settings specify the blackout period from 7:00am to -# 7:30pm local time on Mon-Fri. For $Conf{BlackoutWeekDays}, -# 0 is Sunday, 1 is Monday etc. +# One or more blackout periods can be specified. If a client is +# subject to blackout then no regular (non-manual) backups will +# be started during any of these periods. hourBegin and hourEnd +# specify hours fro midnight and weekDays is a list of days of +# the week where 0 is Sunday, 1 is Monday etc. +# +# For example: +# +# $Conf{BlackoutPeriods} = [ +# { +# hourBegin => 7.0, +# hourEnd => 19.5, +# weekDays => [1, 2, 3, 4, 5], +# }, +# ]; +# +# specifies one blackout period from 7:00am to 7:30pm local time +# on Mon-Fri. +# +# The blackout period can also span midnight by setting +# hourBegin > hourEnd, eg: +# +# $Conf{BlackoutPeriods} = [ +# { +# hourBegin => 7.0, +# hourEnd => 19.5, +# weekDays => [1, 2, 3, 4, 5], +# }, +# { +# hourBegin => 23, +# hourEnd => 5, +# weekDays => [5, 6], +# }, +# ]; +# +# This specifies one blackout period from 7:00am to 7:30pm local time +# on Mon-Fri, and a second period from 11pm to 5am on Friday and +# Saturday night. # -$Conf{BlackoutHourBegin} = 7.0; -$Conf{BlackoutHourEnd} = 19.5; -$Conf{BlackoutWeekDays} = [1, 2, 3, 4, 5]; +$Conf{BlackoutPeriods} = [ + { + hourBegin => 7.0, + hourEnd => 19.5, + weekDays => [1, 2, 3, 4, 5], + }, +]; # # A backup of a share that has zero files is considered fatal. This is @@ -556,7 +829,7 @@ $Conf{BlackoutWeekDays} = [1, 2, 3, 4, 5]; $Conf{BackupZeroFilesIsFatal} = 1; ########################################################################### -# General per-PC configuration settings +# How to backup a client # (can be overridden in the per-PC config.pl) ########################################################################### # @@ -566,21 +839,110 @@ $Conf{BackupZeroFilesIsFatal} = 1; # # The valid values are: # -# - 'smb': backup and restore via smbclient and the SMB protocol. -# Best choice for WinXX. +# - 'smb': backup and restore via smbclient and the SMB protocol. +# Easiest choice for WinXX. # -# - 'rsync': backup and restore via rsync (via rsh or ssh). -# Best choice for linux/unix. Can also work on WinXX. +# - 'rsync': backup and restore via rsync (via rsh or ssh). +# Best choice for linux/unix. Good choice also for WinXX. # -# - 'rsyncd': backup and restre via rsync daemon on the client. -# Best choice for linux/unix if you have rsyncd running on -# the client. Can also work on WinXX. +# - 'rsyncd': backup and restore via rsync daemon on the client. +# Best choice for linux/unix if you have rsyncd running on +# the client. Good choice also for WinXX. # # - 'tar': backup and restore via tar, tar over ssh, rsh or nfs. # Good choice for linux/unix. # +# - 'archive': host is a special archive host. Backups are not done. +# An archive host is used to archive other host's backups +# to permanent media, such as tape, CDR or DVD. +# +# $Conf{XferMethod} = 'smb'; +# +# Level of verbosity in Xfer log files. 0 means be quiet, 1 will give +# will give one line per file, 2 will also show skipped files on +# incrementals, higher values give more output. +# +$Conf{XferLogLevel} = 1; + +# +# Filename charset encoding on the client. BackupPC uses utf8 +# on the server for filename encoding. If this is empty, then +# utf8 is assumed and client filenames will not be modified. +# If set to a different encoding then filenames will converted +# to/from utf8 automatically during backup and restore. +# +# If the file names displayed in the browser (eg: accents or special +# characters) don't look right then it is likely you haven't set +# $Conf{ClientCharset} correctly. +# +# If you are using smbclient on a WinXX machine, smbclient will convert +# to the "unix charset" setting in smb.conf. The default is utf8, +# in which case leave $Conf{ClientCharset} empty since smbclient does +# the right conversion. +# +# If you are using rsync on a WinXX machine then it does no conversion. +# A typical WinXX encoding for latin1/western europe is 'cp1252', +# so in this case set $Conf{ClientCharset} to 'cp1252'. +# +# On a linux or unix client, run "locale charmap" to see the client's +# charset. Set $Conf{ClientCharset} to this value. A typical value +# for english/US is 'ISO-8859-1'. +# +# Do "perldoc Encode::Supported" to see the list of possible charset +# values. The FAQ at http://www.cl.cam.ac.uk/~mgk25/unicode.html +# is excellent, and http://czyborra.com/charsets/iso8859.html +# provides more information on the iso-8859 charsets. +# +$Conf{ClientCharset} = ''; + +# +# Prior to 3.x no charset conversion was done by BackupPC. Backups were +# stored in what ever charset the XferMethod provided - typically utf8 +# for smbclient and the client's locale settings for rsync and tar (eg: +# cp1252 for rsync on WinXX and perhaps iso-8859-1 with rsync on linux). +# This setting tells BackupPC the charset that was used to store file +# names in old backups taken with BackupPC 2.x, so that non-ascii file +# names in old backups can be viewed and restored. +# +$Conf{ClientCharsetLegacy} = 'iso-8859-1'; + +########################################################################### +# Samba Configuration +# (can be overwritten in the per-PC log file) +########################################################################### +# +# Name of the host share that is backed up when using SMB. This can be a +# string or an array of strings if there are multiple shares per host. +# Examples: +# +# $Conf{SmbShareName} = 'c'; # backup 'c' share +# $Conf{SmbShareName} = ['c', 'd']; # backup 'c' and 'd' shares +# +# This setting only matters if $Conf{XferMethod} = 'smb'. +# +$Conf{SmbShareName} = 'C$'; + +# +# Smbclient share user name. This is passed to smbclient's -U argument. +# +# This setting only matters if $Conf{XferMethod} = 'smb'. +# +$Conf{SmbShareUserName} = ''; + +# +# Smbclient share password. This is passed to smbclient via its PASSWD +# environment variable. There are several ways you can tell BackupPC +# the smb share password. In each case you should be very careful about +# security. If you put the password here, make sure that this file is +# not readable by regular users! See the "Setting up config.pl" section +# in the documentation for more information. +# +# This setting only matters if $Conf{XferMethod} = 'smb'. +# +$Conf{SmbSharePasswd} = ''; + # # Full path for smbclient. Security caution: normal users should not # allowed to write to this file or directory. @@ -591,10 +953,10 @@ $Conf{XferMethod} = 'smb'; # # This setting only matters if $Conf{XferMethod} = 'smb'. # -$Conf{SmbClientPath} = '/usr/bin/smbclient'; +$Conf{SmbClientPath} = ''; # -# Commands to run smbclient for a full dump, incremental dump or a restore. +# Command to run smbclient for a full dump. # This setting only matters if $Conf{XferMethod} = 'smb'. # # The following variables are substituted at run-time: @@ -609,18 +971,81 @@ $Conf{SmbClientPath} = '/usr/bin/smbclient'; # $X_option exclude option (if $fileList is an exclude list) # $timeStampFile start time for incremental dump # +# Note: all Cmds are executed directly without a shell, so the prog name +# needs to be a full path and you can't include shell syntax like +# redirection and pipes; put that in a script if you need it. +# $Conf{SmbClientFullCmd} = '$smbClientPath \\\\$host\\$shareName' . ' $I_option -U $userName -E -N -d 1' . ' -c tarmode\\ full -Tc$X_option - $fileList'; +# +# Command to run smbclient for an incremental dump. +# This setting only matters if $Conf{XferMethod} = 'smb'. +# +# Same variable substitutions are applied as $Conf{SmbClientFullCmd}. +# +# Note: all Cmds are executed directly without a shell, so the prog name +# needs to be a full path and you can't include shell syntax like +# redirection and pipes; put that in a script if you need it. +# $Conf{SmbClientIncrCmd} = '$smbClientPath \\\\$host\\$shareName' . ' $I_option -U $userName -E -N -d 1' . ' -c tarmode\\ full -TcN$X_option $timeStampFile - $fileList'; +# +# Command to run smbclient for a restore. +# This setting only matters if $Conf{XferMethod} = 'smb'. +# +# Same variable substitutions are applied as $Conf{SmbClientFullCmd}. +# +# If your smb share is read-only then direct restores will fail. +# You should set $Conf{SmbClientRestoreCmd} to undef and the +# corresponding CGI restore option will be removed. +# +# Note: all Cmds are executed directly without a shell, so the prog name +# needs to be a full path and you can't include shell syntax like +# redirection and pipes; put that in a script if you need it. +# $Conf{SmbClientRestoreCmd} = '$smbClientPath \\\\$host\\$shareName' . ' $I_option -U $userName -E -N -d 1' . ' -c tarmode\\ full -Tx -'; +########################################################################### +# Tar Configuration +# (can be overwritten in the per-PC log file) +########################################################################### +# +# Which host directories to backup when using tar transport. This can be a +# string or an array of strings if there are multiple directories to +# backup per host. Examples: +# +# $Conf{TarShareName} = '/'; # backup everything +# $Conf{TarShareName} = '/home'; # only backup /home +# $Conf{TarShareName} = ['/home', '/src']; # backup /home and /src +# +# The fact this parameter is called 'TarShareName' is for historical +# consistency with the Smb transport options. You can use any valid +# directory on the client: there is no need for it to correspond to +# any Smb share or device mount point. +# +# Note also that you can also use $Conf{BackupFilesOnly} to specify +# a specific list of directories to backup. It's more efficient to +# use this option instead of $Conf{TarShareName} since a new tar is +# run for each entry in $Conf{TarShareName}. +# +# On the other hand, if you add --one-file-system to $Conf{TarClientCmd} +# you can backup each file system separately, which makes restoring one +# bad file system easier. In this case you would list all of the mount +# points here, since you can't get the same result with +# $Conf{BackupFilesOnly}: +# +# $Conf{TarShareName} = ['/', '/var', '/data', '/boot']; +# +# This setting only matters if $Conf{XferMethod} = 'tar'. +# +$Conf{TarShareName} = '/'; + # # Full command to run tar on the client. GNU tar is required. You will # need to fill in the correct paths for ssh2 on the local host (server) @@ -656,8 +1081,12 @@ $Conf{SmbClientRestoreCmd} = '$smbClientPath \\\\$host\\$shareName' # # This setting only matters if $Conf{XferMethod} = 'tar'. # -$Conf{TarClientCmd} = '$sshPath -q -n -l root $host' - . ' $tarPath -c -v -f - -C $shareName+' +# Note: all Cmds are executed directly without a shell, so the prog name +# needs to be a full path and you can't include shell syntax like +# redirection and pipes; put that in a script if you need it. +# +$Conf{TarClientCmd} = '$sshPath -q -x -n -l root $host' + . ' env LC_ALL=C $tarPath -c -v -f - -C $shareName+' . ' --totals'; # @@ -709,8 +1138,16 @@ $Conf{TarIncrArgs} = '--newer=$incrDate+ $fileList+'; # # This setting only matters if $Conf{XferMethod} = "tar". # -$Conf{TarClientRestoreCmd} = '$sshPath -q -l root $host' - . ' $tarPath -x -p --numeric-owner --same-owner' +# If you want to disable direct restores using tar, you should set +# $Conf{TarClientRestoreCmd} to undef and the corresponding CGI +# restore option will be removed. +# +# Note: all Cmds are executed directly without a shell, so the prog name +# needs to be a full path and you can't include shell syntax like +# redirection and pipes; put that in a script if you need it. +# +$Conf{TarClientRestoreCmd} = '$sshPath -q -x -l root $host' + . ' env LC_ALL=C $tarPath -x -p --numeric-owner --same-owner' . ' -v -f - -C $shareName+'; # @@ -719,12 +1156,16 @@ $Conf{TarClientRestoreCmd} = '$sshPath -q -l root $host' # # This setting only matters if $Conf{XferMethod} = 'tar'. # -$Conf{TarClientPath} = '/bin/tar'; +$Conf{TarClientPath} = ''; +########################################################################### +# Rsync/Rsyncd Configuration +# (can be overwritten in the per-PC log file) +########################################################################### # # Path to rsync executable on the client # -$Conf{RsyncClientPath} = '/bin/rsync'; +$Conf{RsyncClientPath} = ''; # # Full command to run rsync on the client machine. The following variables @@ -741,7 +1182,7 @@ $Conf{RsyncClientPath} = '/bin/rsync'; # # This setting only matters if $Conf{XferMethod} = 'rsync'. # -$Conf{RsyncClientCmd} = '$sshPath -l root $host $rsyncPath $argList+'; +$Conf{RsyncClientCmd} = '$sshPath -q -x -l root $host $rsyncPath $argList+'; # # Full command to run rsync for restore on the client. The following @@ -758,7 +1199,11 @@ $Conf{RsyncClientCmd} = '$sshPath -l root $host $rsyncPath $argList+'; # # This setting only matters if $Conf{XferMethod} = 'rsync'. # -$Conf{RsyncClientRestoreCmd} = '$sshPath -l root $host $rsyncPath $argList+'; +# Note: all Cmds are executed directly without a shell, so the prog name +# needs to be a full path and you can't include shell syntax like +# redirection and pipes; put that in a script if you need it. +# +$Conf{RsyncClientRestoreCmd} = '$sshPath -q -x -l root $host $rsyncPath $argList+'; # # Share name to backup. For $Conf{XferMethod} = "rsync" this should @@ -806,20 +1251,33 @@ $Conf{RsyncdPasswd} = ''; # $Conf{RsyncdAuthRequired} = 1; +# +# When rsync checksum caching is enabled (by adding the +# --checksum-seed=32761 option to $Conf{RsyncArgs}), the cached +# checksums can be occasionally verified to make sure the file +# contents matches the cached checksums. This is to avoid the +# risk that disk problems might cause the pool file contents to +# get corrupted, but the cached checksums would make BackupPC +# think that the file still matches the client. +# +# This setting is the probability (0 means never and 1 means always) +# that a file will be rechecked. Setting it to 0 means the checksums +# will not be rechecked (unless there is a phase 0 failure). Setting +# it to 1 (ie: 100%) means all files will be checked, but that is +# not a desirable setting since you are better off simply turning +# caching off (ie: remove the --checksum-seed option). +# +# The default of 0.01 means 1% (on average) of the files during a full +# backup will have their cached checksum re-checked. +# +# This setting has no effect unless checksum caching is turned on. +# +$Conf{RsyncCsumCacheVerifyProb} = 0.01; + # # Arguments to rsync for backup. Do not edit the first set unless you # have a thorough understanding of how File::RsyncP works. # -# Examples of additional arguments that should work are --exclude/--include, -# eg: -# -# $Conf{RsyncArgs} = [ -# # original arguments here -# '-v', -# '--exclude', '/proc', -# '--exclude', '*.tmp', -# ]; -# $Conf{RsyncArgs} = [ # # Do not edit these! @@ -828,50 +1286,202 @@ $Conf{RsyncArgs} = [ '--perms', '--owner', '--group', - '--devices', + '-D', '--links', + '--hard-links', '--times', '--block-size=2048', '--recursive', + # - # Add additional arguments here + # Rsync >= 2.6.3 supports the --checksum-seed option + # which allows rsync checksum caching on the server. + # Uncomment this to enable rsync checksum caching if + # you have a recent client rsync version and you want + # to enable checksum caching. # + #'--checksum-seed=32761', ]; +# +# Additional arguments added to RsyncArgs. This can be used in +# conbination with $Conf{RsyncArgs} to allow customization of +# the rsync arguments on a part-client basis. The standard +# arguments go in $Conf{RsyncArgs} and $Conf{RsyncArgsExtra} +# can be set on a per-client basis. +# +# Examples of additional arguments that should work are --exclude/--include, +# eg: +# +# $Conf{RsyncArgsExtra} = [ +# '--exclude', '/proc', +# '--exclude', '*.tmp', +# ]; +# +# Both $Conf{RsyncArgs} and $Conf{RsyncArgsExtra} are subject +# to the following variable substitutions: +# +# $client client name being backed up +# $host host name (could be different from client name if +# $Conf{ClientNameAlias} is set) +# $hostIP IP address of host +# $confDir configuration directory path +# +# This allows settings of the form: +# +# $Conf{RsyncArgsExtra} = [ +# '--exclude-from=$confDir/pc/$host.exclude', +# ]; +# +$Conf{RsyncArgsExtra} = []; + # # Arguments to rsync for restore. Do not edit the first set unless you # have a thorough understanding of how File::RsyncP works. # +# If you want to disable direct restores using rsync (eg: is the module +# is read-only), you should set $Conf{RsyncRestoreArgs} to undef and +# the corresponding CGI restore option will be removed. +# +# $Conf{RsyncRestoreArgs} is subject to the following variable +# substitutions: +# +# $client client name being backed up +# $host host name (could be different from client name if +# $Conf{ClientNameAlias} is set) +# $hostIP IP address of host +# $confDir configuration directory path +# +# Note: $Conf{RsyncArgsExtra} doesn't apply to $Conf{RsyncRestoreArgs}. # $Conf{RsyncRestoreArgs} = [ # # Do not edit these! # - "--numeric-ids", - "--perms", - "--owner", - "--group", - "--devices", - "--links", - "--times", - "--block-size=2048", - "--relative", - "--ignore-times", - "--recursive", + '--numeric-ids', + '--perms', + '--owner', + '--group', + '-D', + '--links', + '--hard-links', + '--times', + '--block-size=2048', + '--relative', + '--ignore-times', + '--recursive', + + # + # Rsync >= 2.6.3 supports the --checksum-seed option + # which allows rsync checksum caching on the server. + # Uncomment this to enable rsync checksum caching if + # you have a recent client rsync version and you want + # to enable checksum caching. + # + #'--checksum-seed=32761', + # # Add additional arguments here # ]; +########################################################################### +# FTP Configuration +# (can be overwritten in the per-PC log file) +########################################################################## +# +# Which host directories to backup when using FTP. This can be a +# string or an array of strings if there are multiple shares per host. +# +# This value must be specified in one of two ways: either as a +# subdirectory of the 'share root' on the server, or as the absolute +# path of the directory. +# +# In the following example, if the directory /home/username is the +# root share of the ftp server with the given username, the following +# two values will back up the same directory: +# +# $Conf{FtpShareName} = 'www'; # www directory +# $Conf{FtpShareName} = '/home/username/www'; # same directory +# +# Path resolution is not supported; i.e.; you may not have an ftp +# share path defined as '../otheruser' or '~/games'. +# +# Multiple shares may also be specified, as with other protocols: +# +# $Conf{FtpShareName} = [ 'www', +# 'bin', +# 'config' ]; +# +# Note also that you can also use $Conf{BackupFilesOnly} to specify +# a specific list of directories to backup. It's more efficient to +# use this option instead of $Conf{FtpShareName} since a new tar is +# run for each entry in $Conf{FtpShareName}. +# +# This setting only matters if $Conf{XferMethod} = 'ftp'. +# +$Conf{FtpShareName} = ''; + +# +# FTP user name. This is used to log into the server. +# +# This setting is used only if $Conf{XferMethod} = 'ftp'. +# +$Conf{FtpUserName} = ''; + +# +# FTP user password. This is used to log into the server. +# +# This setting is used only if $Conf{XferMethod} = 'ftp'. +# +$Conf{FtpPasswd} = ''; + +# +# Whether passive mode is used. The correct setting depends upon +# whether local or remote ports are accessible from the other machine, +# which is affected by any firewall or routers between the FTP server +# on the client and the BackupPC server. +# +# This setting is used only if $Conf{XferMethod} = 'ftp'. +# +$Conf{FtpPassive} = 1; + +# +# Transfer block size. This sets the size of the amounts of data in +# each frame. While undefined, this value takes the default value. +# +# This setting is used only if $Conf{XferMethod} = 'ftp'. +# +$Conf{FtpBlockSize} = 10240; + +# +# The port of the ftp server. If undefined, 21 is used. +# +# This setting is used only if $Conf{XferMethod} = 'ftp'. +# +$Conf{FtpPort} = 21; + +# +# Connection timeout for FTP. When undefined, the default is 120 seconds. +# +# This setting is used only if $Conf{XferMethod} = 'ftp'. +# +$Conf{FtpTimeout} = 120; + # -# Amount of verbosity in Rsync Xfer log files. 0 means be quiet, -# 1 will give will give one line per file, 2 will also show skipped -# files on incrementals, higher values give more output. 10 will -# include byte dumps of all data read/written, which will make the -# log files huge. +# Behaviour when BackupPC encounters symlinks on the FTP share. # -$Conf{RsyncLogLevel} = 1; +# Symlinks cannot be restored via FTP, so the desired behaviour will +# be different depending on the setup of the share. The default for +# this behavor is 1. Directory shares with more complicated directory +# structures should consider other protocols. +# +$Conf{FtpFollowSymlinks} = 0; +########################################################################### +# Archive Configuration +# (can be overwritten in the per-PC log file) +########################################################################### # # Archive Destination # @@ -896,8 +1506,9 @@ $Conf{ArchiveComp} = 'gzip'; # # Archive Parity Files # -# The number of Parity Files to generate. -# Uses the commandline par available from +# The amount of Parity data to generate, as a percentage +# of the archive size. +# Uses the commandline par2 (par2cmdline) available from # http://parchive.sourceforge.net # # Only useful for file dumps. @@ -912,8 +1523,11 @@ $Conf{ArchivePar} = 0; # Only for file archives. Splits the output into # the specified size * 1,000,000. # e.g. to split into 650,000,000 bytes, specify 650 below. +# +# If the value is 0, or if $Conf{ArchiveDest} is an existing file or +# device (e.g. a streaming tape drive), this feature is disabled. # -$Conf{ArchiveSplit} = 650; +$Conf{ArchiveSplit} = 0; # # Archive Command @@ -924,14 +1538,18 @@ $Conf{ArchiveSplit} = 650; # $Installdir The installation directory of BackupPC # $tarCreatePath The path to BackupPC_tarCreate # $splitpath The path to the split program -# $parpath The path to the par program +# $parpath The path to the par2 program # $host The host to archive # $backupnumber The backup number of the host to archive # $compression The path to the compression program # $compext The extension assigned to the compression type # $splitsize The number of bytes to split archives into # $archiveloc The location to put the archive -# $parfile The number of par files to create +# $parfile The amount of parity data to create (percentage) +# +# Note: all Cmds are executed directly without a shell, so the prog name +# needs to be a full path and you can't include shell syntax like +# redirection and pipes; put that in a script if you need it. # $Conf{ArchiveClientCmd} = '$Installdir/bin/BackupPC_archiveHost' . ' $tarCreatePath $splitpath $parpath $host $backupnumber' @@ -941,7 +1559,7 @@ $Conf{ArchiveClientCmd} = '$Installdir/bin/BackupPC_archiveHost' # Full path for ssh. Security caution: normal users should not # allowed to write to this file or directory. # -$Conf{SshPath} = '/usr/bin/ssh'; +$Conf{SshPath} = ''; # # Full path for nmblookup. Security caution: normal users should not @@ -950,7 +1568,7 @@ $Conf{SshPath} = '/usr/bin/ssh'; # nmblookup is from the Samba distribution. nmblookup is used to get the # netbios name, necessary for DHCP hosts. # -$Conf{NmbLookupPath} = '/usr/bin/nmblookup'; +$Conf{NmbLookupPath} = ''; # # NmbLookup command. Given an IP address, does an nmblookup on that @@ -962,6 +1580,10 @@ $Conf{NmbLookupPath} = '/usr/bin/nmblookup'; # This command is only used for DHCP hosts: given an IP address, this # command should try to find its NetBios name. # +# Note: all Cmds are executed directly without a shell, so the prog name +# needs to be a full path and you can't include shell syntax like +# redirection and pipes; put that in a script if you need it. +# $Conf{NmbLookupCmd} = '$nmbLookupPath -A $host'; # @@ -989,6 +1611,10 @@ $Conf{NmbLookupCmd} = '$nmbLookupPath -A $host'; # Experiment manually for your site to see what form of nmblookup command # works. # +# Note: all Cmds are executed directly without a shell, so the prog name +# needs to be a full path and you can't include shell syntax like +# redirection and pipes; put that in a script if you need it. +# $Conf{NmbLookupFindHostCmd} = '$nmbLookupPath $host'; # @@ -1010,7 +1636,7 @@ $Conf{FixedIPNetBiosNameCheck} = 0; # # $Conf{PingPath} = '/bin/echo'; # -$Conf{PingPath} = '/bin/ping'; +$Conf{PingPath} = ''; # # Ping command. The following variables are substituted at run-time: @@ -1022,26 +1648,22 @@ $Conf{PingPath} = '/bin/ping'; # exit status (0 even on failure). Replace with "ping $host 1", which # gets the correct exit status but we don't get the round-trip time. # +# Note: all Cmds are executed directly without a shell, so the prog name +# needs to be a full path and you can't include shell syntax like +# redirection and pipes; put that in a script if you need it. +# $Conf{PingCmd} = '$pingPath -c 1 $host'; # -# Path to init.d script and command to use that script to start the -# server from the CGI interface. The following variables are substituted -# at run-time: -# -# $sshPath path to ssh ($Conf{SshPath}) -# $serverHost same as $Conf{ServerHost} -# $serverInitdPath path to init.d script ($Conf{ServerInitdPath}) -# -# Example: -# -# $Conf{ServerInitdPath} = '/etc/init.d/backuppc'; -# $Conf{ServerInitdStartCmd} = '$sshPath -l root $serverHost' -# . ' $serverInitdPath start' -# . ' < /dev/null >& /dev/null'; +# Maximum round-trip ping time in milliseconds. This threshold is set +# to avoid backing up PCs that are remotely connected through WAN or +# dialup connections. The output from ping -s (assuming it is supported +# on your system) is used to check the round-trip packet time. On your +# local LAN round-trip times should be much less than 20msec. On most +# WAN or dialup connections the round-trip time will be typically more +# than 20msec. Tune if necessary. # -$Conf{ServerInitdPath} = ''; -$Conf{ServerInitdStartCmd} = ''; +$Conf{PingMaxMsec} = 20; # # Compression level to use on files. 0 means no compression. Compression @@ -1074,17 +1696,6 @@ $Conf{ServerInitdStartCmd} = ''; # $Conf{CompressLevel} = 0; -# -# Maximum round-trip ping time in milliseconds. This threshold is set -# to avoid backing up PCs that are remotely connected through WAN or -# dialup connections. The output from ping -s (assuming it is supported -# on your system) is used to check the round-trip packet time. On your -# local LAN round-trip times should be much less than 20msec. On most -# WAN or dialup connections the round-trip time will be typically more -# than 20msec. Tune if necessary. -# -$Conf{PingMaxMsec} = 20; - # # Timeout in seconds when listening for the transport program's # (smbclient, tar etc) stdout. If no output is received during this @@ -1099,7 +1710,7 @@ $Conf{PingMaxMsec} = 20; # Despite the name, this parameter sets the timeout for all transport # methods (tar, smb etc). # -$Conf{ClientTimeout} = 7200; +$Conf{ClientTimeout} = 72000; # # Maximum number of log files we keep around in each PC's directory @@ -1115,16 +1726,20 @@ $Conf{ClientTimeout} = 7200; $Conf{MaxOldPerPCLogFiles} = 12; # -# Optional commands to run before and after dumps and restores. +# Optional commands to run before and after dumps and restores, +# and also before and after each share of a dump. +# # Stdout from these commands will be written to the Xfer (or Restore) # log file. One example of using these commands would be to -# shut down and restart a database server, or to dump a database -# to files for backup. Example: +# shut down and restart a database server, dump a database +# to files for backup, or doing a snapshot of a share prior +# to a backup. Example: # -# $Conf{DumpPreUserCmd} = '$sshPath -l root $host /usr/bin/dumpMysql'; +# $Conf{DumpPreUserCmd} = '$sshPath -q -x -l root $host /usr/bin/dumpMysql'; # # The following variable substitutions are made at run time for -# $Conf{DumpPreUserCmd} and $Conf{DumpPostUserCmd}: +# $Conf{DumpPreUserCmd}, $Conf{DumpPostUserCmd}, $Conf{DumpPreShareCmd} +# and $Conf{DumpPostShareCmd}: # # $type type of dump (incr or full) # $xferOK 1 if the dump succeeded, 0 if it didn't @@ -1134,10 +1749,12 @@ $Conf{MaxOldPerPCLogFiles} = 12; # $hostIP IP address of host # $user user name from the hosts file # $moreUsers list of additional users from the hosts file -# $share the first share name +# $share the first share name (or current share for +# $Conf{DumpPreShareCmd} and $Conf{DumpPostShareCmd}) # $shares list of all the share names # $XferMethod value of $Conf{XferMethod} (eg: tar, rsync, smb) # $sshPath value of $Conf{SshPath}, +# $cmdType set to DumpPreUserCmd or DumpPostUserCmd # # The following variable substitutions are made at run time for # $Conf{RestorePreUserCmd} and $Conf{RestorePostUserCmd}: @@ -1159,6 +1776,7 @@ $Conf{MaxOldPerPCLogFiles} = 12; # $pathHdrSrc common starting path of restore source # $pathHdrDest common starting path of destination # $fileList list of files being restored +# $cmdType set to RestorePreUserCmd or RestorePostUserCmd # # The following variable substitutions are made at run time for # $Conf{ArchivePreUserCmd} and $Conf{ArchivePostUserCmd}: @@ -1172,20 +1790,50 @@ $Conf{MaxOldPerPCLogFiles} = 12; # $HostList list of hosts being archived # $BackupList list of backup numbers for the hosts being archived # $archiveloc location where the archive is sent to -# $parfile number of par files being generated +# $parfile amount of parity data being generated (percentage) # $compression compression program being used (eg: cat, gzip, bzip2) # $compext extension used for compression type (eg: raw, gz, bz2) # $splitsize size of the files that the archive creates # $sshPath value of $Conf{SshPath}, # $type set to "archive" +# $cmdType set to ArchivePreUserCmd or ArchivePostUserCmd +# +# Note: all Cmds are executed directly without a shell, so the prog name +# needs to be a full path and you can't include shell syntax like +# redirection and pipes; put that in a script if you need it. # $Conf{DumpPreUserCmd} = undef; $Conf{DumpPostUserCmd} = undef; +$Conf{DumpPreShareCmd} = undef; +$Conf{DumpPostShareCmd} = undef; $Conf{RestorePreUserCmd} = undef; $Conf{RestorePostUserCmd} = undef; $Conf{ArchivePreUserCmd} = undef; $Conf{ArchivePostUserCmd} = undef; +# +# Whether the exit status of each PreUserCmd and +# PostUserCmd is checked. +# +# If set and the Dump/Restore/Archive Pre/Post UserCmd +# returns a non-zero exit status then the dump/restore/archive +# is aborted. To maintain backward compatibility (where +# the exit status in early versions was always ignored), +# this flag defaults to 0. +# +# If this flag is set and the Dump/Restore/Archive PreUserCmd +# fails then the matching Dump/Restore/Archive PostUserCmd is +# not executed. If DumpPreShareCmd returns a non-exit status, +# then DumpPostShareCmd is not executed, but the DumpPostUserCmd +# is still run (since DumpPreUserCmd must have previously +# succeeded). +# +# An example of a DumpPreUserCmd that might fail is a script +# that snapshots or dumps a database which fails because +# of some database error. +# +$Conf{UserCmdCheckStatus} = 0; + # # Override the client's host name. This allows multiple clients # to all refer to the same physical host. This should only be @@ -1205,12 +1853,6 @@ $Conf{ArchivePostUserCmd} = undef; # $Conf{ClientNameAlias} = undef; -# -# Advanced option for asking BackupPC to load additional perl modules. -# Can be a list (array ref) of module names to load at startup. -# -$Conf{PerlModuleLoad} = undef; - ########################################################################### # Email reminders, status and messages # (can be overridden in the per-PC config.pl) @@ -1219,7 +1861,7 @@ $Conf{PerlModuleLoad} = undef; # Full path to the sendmail command. Security caution: normal users # should not allowed to write to this file or directory. # -$Conf{SendmailPath} = '/usr/sbin/sendmail'; +$Conf{SendmailPath} = ''; # # Minimum period between consecutive emails to a single user. @@ -1334,6 +1976,15 @@ $Conf{EMailNotifyOldOutlookDays} = 5.0; $Conf{EMailOutlookBackupSubj} = undef; $Conf{EMailOutlookBackupMesg} = undef; +# +# Additional email headers. This sets to charset to +# utf8. +# +$Conf{EMailHeaders} = <{lname}) instead of +# just literally displaying name. +# +$Conf{CgiNavBarLinks} = [ + { + link => "?action=view&type=docs", + lname => "Documentation", # actually displays $Lang->{Documentation} + }, + { + link => "http://backuppc.wiki.sourceforge.net", + name => "Wiki", # displays literal "Wiki" + }, + { + link => "http://backuppc.sourceforge.net", + name => "SourceForge", # displays literal "SourceForge" + }, +]; # # Hilight colors based on status that are used in the PC summary page. @@ -1429,6 +2109,8 @@ $Conf{CgiStatusHilightColor} = { Reason_no_ping => '#ffff99', Reason_backup_canceled_by_user => '#ff9900', Status_backup_in_progress => '#66cc99', + Disabled_OnlyManualBackups => '#d1d1d1', + Disabled_AllBackupsDisabled => '#d1d1d1', }; # @@ -1442,7 +2124,7 @@ $Conf{CgiHeaders} = ''; # used by configure.pl when you upgrade BackupPC. # # Example: -# $Conf{CgiImageDir} = '/usr/local/apache/htdocs/BackupPC'; +# $Conf{CgiImageDir} = '/var/www/htdocs/BackupPC'; # $Conf{CgiImageDir} = ''; @@ -1468,171 +2150,216 @@ $Conf{CgiExt2ContentType} = { }; $Conf{CgiImageDirURL} = ''; # -# CSS stylesheet for the CGI interface. -# -$Conf{CSSstylesheet} = <<'EOF'; - -EOF +# CSS stylesheet "skin" for the CGI interface. It is stored +# in the $Conf{CgiImageDir} directory and accessed via the +# $Conf{CgiImageDirURL} URL. +# +# For BackupPC v3.x several color, layout and font changes were made. +# The previous v2.x version is available as BackupPC_stnd_orig.css, so +# if you prefer the old skin, change this to BackupPC_stnd_orig.css. +# +$Conf{CgiCSSFile} = 'BackupPC_stnd.css'; + +# +# Whether the user is allowed to edit their per-PC config. +# +$Conf{CgiUserConfigEditEnable} = 1; + +# +# Which per-host config variables a non-admin user is allowed +# to edit. Admin users can edit all per-host config variables, +# even if disabled in this list. +# +# SECURITY WARNING: Do not let users edit any of the Cmd +# config variables! That's because a user could set a +# Cmd to a shell script of their choice and it will be +# run as the BackupPC user. That script could do all +# sorts of bad things. +# +$Conf{CgiUserConfigEdit} = { + FullPeriod => 1, + IncrPeriod => 1, + FullKeepCnt => 1, + FullKeepCntMin => 1, + FullAgeMax => 1, + IncrKeepCnt => 1, + IncrKeepCntMin => 1, + IncrAgeMax => 1, + IncrLevels => 1, + IncrFill => 1, + PartialAgeMax => 1, + RestoreInfoKeepCnt => 1, + ArchiveInfoKeepCnt => 1, + BackupFilesOnly => 1, + BackupFilesExclude => 1, + BackupsDisable => 1, + BlackoutBadPingLimit => 1, + BlackoutGoodCnt => 1, + BlackoutPeriods => 1, + BackupZeroFilesIsFatal => 1, + ClientCharset => 1, + ClientCharsetLegacy => 1, + XferMethod => 1, + XferLogLevel => 1, + SmbShareName => 1, + SmbShareUserName => 1, + SmbSharePasswd => 1, + SmbClientFullCmd => 0, + SmbClientIncrCmd => 0, + SmbClientRestoreCmd => 0, + TarShareName => 1, + TarFullArgs => 1, + TarIncrArgs => 1, + TarClientCmd => 0, + TarClientRestoreCmd => 0, + TarClientPath => 0, + RsyncShareName => 1, + RsyncdClientPort => 1, + RsyncdPasswd => 1, + RsyncdUserName => 1, + RsyncdAuthRequired => 1, + RsyncCsumCacheVerifyProb => 1, + RsyncArgs => 1, + RsyncArgsExtra => 1, + RsyncRestoreArgs => 1, + RsyncClientCmd => 0, + RsyncClientRestoreCmd => 0, + RsyncClientPath => 0, + FtpShareName => 1, + FtpUserName => 1, + FtpPasswd => 1, + FtpBlockSize => 1, + FtpPort => 1, + FtpTimeout => 1, + FtpFollowSymlinks => 1, + FtpRestoreEnabled => 1, + ArchiveDest => 1, + ArchiveComp => 1, + ArchivePar => 1, + ArchiveSplit => 1, + ArchiveClientCmd => 0, + FixedIPNetBiosNameCheck => 1, + NmbLookupCmd => 0, + NmbLookupFindHostCmd => 0, + PingMaxMsec => 1, + PingCmd => 0, + ClientTimeout => 1, + MaxOldPerPCLogFiles => 1, + CompressLevel => 1, + ClientNameAlias => 1, + DumpPreUserCmd => 0, + DumpPostUserCmd => 0, + RestorePreUserCmd => 0, + RestorePostUserCmd => 0, + ArchivePreUserCmd => 0, + ArchivePostUserCmd => 0, + DumpPostShareCmd => 0, + DumpPreShareCmd => 0, + UserCmdCheckStatus => 0, + EMailNotifyMinDays => 1, + EMailFromUserName => 1, + EMailAdminUserName => 1, + EMailUserDestDomain => 1, + EMailNoBackupEverSubj => 1, + EMailNoBackupEverMesg => 1, + EMailNotifyOldBackupDays => 1, + EMailNoBackupRecentSubj => 1, + EMailNoBackupRecentMesg => 1, + EMailNotifyOldOutlookDays => 1, + EMailOutlookBackupSubj => 1, + EMailOutlookBackupMesg => 1, + EMailHeaders => 1, +}; + + +# XXX XXX XXX XXX XXX XXX XXX +# XXX support for search + + +# add search database dsn +# +#$Conf{SearchDSN} = 'dbi:SQLite:dbname=$TopDir/search.db'; +$Conf{SearchDSN} = 'dbi:Pg:dbname=backuppc'; +$Conf{SearchUser} = 'dpavlin'; +# + +# if you want to use experimental Hyper Estraier support (which require +# installation of Search::Estraier perl module from CPAN) select +# path to index (relative to $TopDir) or node URI +# use following line to disable Hyper Estraier and prevent upgrades +# from overwriting it +#$Conf{SearchModule} = 'BackupPC::Search::Estraier'; +#$Conf{HyperEstraierIndex} = 'http://localhost:1978/node/backuppc'; + +# which search engine to use +$Conf{SearchModule} = 'BackupPC::Search::KinoSearch'; +$Conf{KinoPath} = '/tmp/kinosearch'; + +# +# temp directory for storing gzip and iso files when createing iso images +# +$Conf{GzipTempDir} = "$Conf{TopDir}/temp"; + +# +# nameing schema for snapshots (.tar.gz will be added) +# \h - hostname +# \s - share +# \n - increment numer +# +$Conf{GzipSchema} = '\\h_\\s_\\n'; +# + +# +# archive media size (in bytes) +# default: 4.2Gb for DVD +# +#$Conf{MaxArchiveSize} = 4200 * 1024 * 1024; +$Conf{MaxArchiveSize} = 4404019200; + +# +# maximum size of one (uncompressed) file on archive medium (in bytes) +# default: 2Gb - 2k for DVD +#$Conf{MaxArchiveFileSize} = (2048 - 2) * 1024 * 1024; +$Conf{MaxArchiveFileSize} = 2145386496; + +# +# Temporary directory for ISO images (relative to install dir) +# +$Conf{ISOTempDir} = 'temp/iso'; + +#### +# configuration data for burning +#### +#$Conf{CDRecordBin} = 'cdrecord'; +#$Conf{CDRecordOpts} = 'dev=/dev/hdc blank=fast -dao -v -eject -dummy'; + +#$Conf{CDRecordBin} = 'dvdrecord'; +#$Conf{CDRecordOpts} = 'dev=0,0,0 -dao -v -eject -dummy'; + +# gzip level for creating tar.gz increments +# default is -6, -1 is fast, -9 is slow +#$Conf{GzipLevel} = '-6'; +$Conf{GzipLevel} = '-1'; + +# number of archive copies to burn +$Conf{BurnMultipleCopies} = 2; + +# Other command-line utilities used +#$Conf{ejectBin} = 'eject'; +#$Conf{ejectOpts} = '/dev/cdrom'; +$Conf{ejectBin} = 'true'; +$Conf{ejectOpts} = ' '; + + +# FIXME disable burning +$Conf{ejectBin} = 'true'; +$Conf{ejectOpts} = ' '; +$Conf{CDRecordBin} = 'cat'; +$Conf{CDRecordOpts} = '>/dev/null <'; + + +$Conf{mkisofsBin} = 'mkisofs'; + +# temporary path used when recovering of increments +# (you might put this into tmpfs if you have enough RAM) +$Conf{IncrementTempDir} = '/tmp/increment-restore/';