X-Git-Url: http://git.rot13.org/?p=BackupPC.git;a=blobdiff_plain;f=conf%2Fconfig.pl;h=824ae779bb10cfcf4a98cdf2d86456da42175a91;hp=d8b6ac9d188492572d8cedb77f60ded0190a9435;hb=617af75f7419e95a9c3ea05b05cf21957acc331c;hpb=d13d57e035dac9362ca393991b978530402969b7 diff --git a/conf/config.pl b/conf/config.pl index d8b6ac9..824ae77 100644 --- a/conf/config.pl +++ b/conf/config.pl @@ -270,14 +270,27 @@ $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 +# +$Conf{TopDir} = ''; +$Conf{ConfDir} = ''; +$Conf{LogDir} = ''; +$Conf{InstallDir} = ''; +$Conf{CgiDir} = ''; # # Whether BackupPC and the CGI script BackupPC_Admin verify that they @@ -340,18 +353,6 @@ $Conf{ServerInitdStartCmd} = ''; # 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. -# $Conf{FullPeriod} = 6.97; # @@ -468,6 +469,105 @@ $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 @@ -547,6 +647,9 @@ $Conf{ArchiveInfoKeepCnt} = 10; # array, and $Conf{SmbShareName} contains multiple share names, then # the setting is assumed to apply all shares. # +# If a hash is used, a special key "*" means it applies to all +# shares. +# # Examples: # $Conf{BackupFilesOnly} = '/myFiles'; # $Conf{BackupFilesOnly} = ['/myFiles']; # same as first example @@ -555,6 +658,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; @@ -590,6 +697,9 @@ $Conf{BackupFilesOnly} = undef; # Users report that for smbclient you should specify a directory # followed by "/*", eg: "/proc/*", instead of just "/proc". # +# If a hash is used, a special key "*" means it applies to all +# shares. +# # Examples: # $Conf{BackupFilesExclude} = '/temp'; # $Conf{BackupFilesExclude} = ['/temp']; # same as first example @@ -598,6 +708,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; @@ -705,7 +819,7 @@ $Conf{BackupZeroFilesIsFatal} = 1; # - '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. +# - '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. # @@ -726,6 +840,17 @@ $Conf{XferMethod} = 'smb'; # $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 be re-encoded in utf8. +# A typical WinXX encoding for latin1/western europe is 'cp1252'. +# Do "perldoc Encode::Supported" to see the list of possible charset +# values, and also see http://czyborra.com/charsets/iso8859.html. +# +$Conf{ClientCharset} = ''; + # # 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. @@ -880,7 +1005,7 @@ $Conf{TarShareName} = '/'; # This setting only matters if $Conf{XferMethod} = 'tar'. # $Conf{TarClientCmd} = '$sshPath -q -x -n -l root $host' - . ' $tarPath -c -v -f - -C $shareName+' + . ' env LC_ALL=C $tarPath -c -v -f - -C $shareName+' . ' --totals'; # @@ -937,7 +1062,7 @@ $Conf{TarIncrArgs} = '--newer=$incrDate+ $fileList+'; # restore option will be removed. # $Conf{TarClientRestoreCmd} = '$sshPath -q -x -l root $host' - . ' $tarPath -x -p --numeric-owner --same-owner' + . ' env LC_ALL=C $tarPath -x -p --numeric-owner --same-owner' . ' -v -f - -C $shareName+'; # @@ -1078,7 +1203,7 @@ $Conf{RsyncArgs} = [ '--perms', '--owner', '--group', - '--devices', + '-D', '--links', '--times', '--block-size=2048', @@ -1112,7 +1237,7 @@ $Conf{RsyncRestoreArgs} = [ '--perms', '--owner', '--group', - '--devices', + '-D', '--links', '--times', '--block-size=2048', @@ -1132,6 +1257,63 @@ $Conf{RsyncRestoreArgs} = [ # ]; +# +# Share name to backup. For $Conf{XferMethod} = "backuppcd" this should +# be a file system path, eg '/' or '/home'. +# +# This can also be a list of multiple file system paths or modules. +# (Can it??) +# +# $Conf{BackupPCdShareName} = ['/', '/var', '/data', '/boot']; +# +$Conf{BackupPCdShareName} = '/'; + +# +# Path to backuppcd executable on the server +# +$Conf{BackupPCdPath} = '/usr/bin/backuppcd'; + +# +# Full command to run backuppcd on the server to backup a given +# client machine. The following variables are substituted at +# run-time (TODO: update this list) +# +# $host host name being backed up +# $hostIP host's IP address +# $shareName share name to backup (ie: top-level directory path) +# $backuppcdPath same as $Conf{BackupPCdPath} +# $sshPath same as $Conf{SshPath} +# +# This setting only matters if $Conf{XferMethod} = 'backuppcd'. +# +# Arguments to backupcpd are: +# +# - the host name to backup +# - the share name to backup +# - the directory where the pool is +# - the directory where the last run was (NOT DONE YET) +# - a boolean value indicating whether or not the pool is +# compressed or not +# - the directory where the new run should occur (currently it assumes ".") +# +$Conf{BackupPCdCmd} = '$bpcdPath $host $shareName $poolDir XXXX $poolCompress $topDir/pc/$client/new'; + +# +# Full command to run backuppcd on the server for restore to a +# client machine. The following variables are substituted at +# run-time (TODO: update this list) +# +# $host host name being backed up +# $hostIP host's IP address +# $shareName share name to backup (ie: top-level directory path) +# $backuppcdPath same as $Conf{BackupPCdPath} +# $sshPath same as $Conf{SshPath} +# +# This setting only matters if $Conf{XferMethod} = 'backuppcd'. +# +$Conf{BackupPCdRestoreCmd} = '$bpcdPath TODO'; + + # # Archive Destination # @@ -1344,7 +1526,7 @@ $Conf{CompressLevel} = 0; # 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 @@ -1441,6 +1623,29 @@ $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 @@ -1583,6 +1788,14 @@ $Conf{EMailNotifyOldOutlookDays} = 5.0; $Conf{EMailOutlookBackupSubj} = undef; $Conf{EMailOutlookBackupMesg} = undef; +# +# Additional email headers +# +$Conf{EMailHeaders} = < 1, @@ -1764,8 +1989,9 @@ $Conf{CgiUserConfigEdit} = { IncrKeepCnt => 1, IncrKeepCntMin => 1, IncrAgeMax => 1, - PartialAgeMax => 1, + IncrLevels => 1, IncrFill => 1, + PartialAgeMax => 1, RestoreInfoKeepCnt => 1, ArchiveInfoKeepCnt => 1, BackupFilesOnly => 1, @@ -1774,14 +2000,20 @@ $Conf{CgiUserConfigEdit} = { BlackoutGoodCnt => 1, BlackoutPeriods => 1, BackupZeroFilesIsFatal => 1, + ClientCharset => 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, RsyncShareName => 1, RsyncdClientPort => 1, RsyncdPasswd => 1, @@ -1789,16 +2021,31 @@ $Conf{CgiUserConfigEdit} = { RsyncCsumCacheVerifyProb => 1, RsyncArgs => 1, RsyncRestoreArgs => 1, + RsyncClientCmd => 0, + RsyncClientRestoreCmd => 0, 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, @@ -1811,4 +2058,5 @@ $Conf{CgiUserConfigEdit} = { EMailNotifyOldOutlookDays => 1, EMailOutlookBackupSubj => 1, EMailOutlookBackupMesg => 1, + EMailHeaders => 1, };