X-Git-Url: http://git.rot13.org/?p=BackupPC.git;a=blobdiff_plain;f=conf%2Fconfig.pl;h=7113463f9d556bf38e9edcf32613af40a134fa2c;hp=03c28b527b3e67fdba23ae58c05f272b55915bbe;hb=197383fe39b33180b648de9e4bcc1fd7b7ca6a66;hpb=546f9691f118c9ea2d164f377994b4a018a60d02 diff --git a/conf/config.pl b/conf/config.pl index 03c28b5..7113463 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-2007 Craig Barratt # # See http://backuppc.sourceforge.net. # @@ -98,24 +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. # -# The first entry of $Conf{WakeupSchedule} is when BackupPC_nightly -# is run. No other backups can run while BackupPC_nightly is -# running. 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). +# 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..23]; +$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 @@ -201,7 +199,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: @@ -214,12 +212,11 @@ $Conf{DfCmd} = '$dfPath $topDir'; # # Full path to various commands for archiving # - -$Conf{SplitPath} = '/usr/bin/split'; -$Conf{ParPath} = '/usr/bin/par2'; -$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. @@ -270,14 +267,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 +350,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 +466,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 @@ -548,7 +645,7 @@ $Conf{ArchiveInfoKeepCnt} = 10; # the setting is assumed to apply all shares. # # If a hash is used, a special key "*" means it applies to all -# shares. +# shares that don't have a specific entry. # # Examples: # $Conf{BackupFilesOnly} = '/myFiles'; @@ -598,7 +695,7 @@ $Conf{BackupFilesOnly} = undef; # followed by "/*", eg: "/proc/*", instead of just "/proc". # # If a hash is used, a special key "*" means it applies to all -# shares. +# shares that don't have a specific entry. # # Examples: # $Conf{BackupFilesExclude} = '/temp'; @@ -740,6 +837,48 @@ $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 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'; + # # 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. @@ -781,7 +920,7 @@ $Conf{SmbSharePasswd} = ''; # # This setting only matters if $Conf{XferMethod} = 'smb'. # -$Conf{SmbClientPath} = '/usr/bin/smbclient'; +$Conf{SmbClientPath} = ''; # # Command to run smbclient for a full dump. @@ -960,12 +1099,12 @@ $Conf{TarClientRestoreCmd} = '$sshPath -q -x -l root $host' # # This setting only matters if $Conf{XferMethod} = 'tar'. # -$Conf{TarClientPath} = '/bin/tar'; +$Conf{TarClientPath} = ''; # # 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 @@ -1050,7 +1189,7 @@ $Conf{RsyncdAuthRequired} = 1; # # When rsync checksum caching is enabled (by adding the # --checksum-seed=32761 option to $Conf{RsyncArgs}), the cached -# checksums can be occaisonally verified to make sure the file +# 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 @@ -1092,16 +1231,19 @@ $Conf{RsyncArgs} = [ '--perms', '--owner', '--group', - '--devices', + '-D', '--links', + '--hard-links', '--times', '--block-size=2048', '--recursive', # - # If you are using a patched client rsync that supports the - # --checksum-seed option (see http://backuppc.sourceforge.net), - # then uncomment this to enabled rsync checksum cachcing + # 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', @@ -1126,8 +1268,9 @@ $Conf{RsyncRestoreArgs} = [ '--perms', '--owner', '--group', - '--devices', + '-D', '--links', + '--hard-links', '--times', '--block-size=2048', '--relative', @@ -1135,9 +1278,11 @@ $Conf{RsyncRestoreArgs} = [ '--recursive', # - # If you are using a patched client rsync that supports the - # --checksum-seed option (see http://backuppc.sourceforge.net), - # then uncomment this to enabled rsync checksum cachcing + # 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', @@ -1146,6 +1291,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} = ''; + +# +# 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 # @@ -1219,7 +1421,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 @@ -1228,7 +1430,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 @@ -1288,7 +1490,7 @@ $Conf{FixedIPNetBiosNameCheck} = 0; # # $Conf{PingPath} = '/bin/echo'; # -$Conf{PingPath} = '/bin/ping'; +$Conf{PingPath} = ''; # # Ping command. The following variables are substituted at run-time: @@ -1455,6 +1657,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 @@ -1482,7 +1707,7 @@ $Conf{ClientNameAlias} = 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. @@ -1598,7 +1823,9 @@ $Conf{EMailOutlookBackupSubj} = undef; $Conf{EMailOutlookBackupMesg} = undef; # -# Additional email headers +# Additional email headers. If you change the charset +# to utf8 then BackupPC_sendEmail will use utf8 for +# the email body. # $Conf{EMailHeaders} = < '#ffff99', Reason_backup_canceled_by_user => '#ff9900', Status_backup_in_progress => '#66cc99', + Disabled_OnlyManualBackups => '#d1d1d1', + Disabled_AllBackupsDisabled => '#d1d1d1', }; # @@ -1767,10 +1997,14 @@ $Conf{CgiExt2ContentType} = { }; $Conf{CgiImageDirURL} = ''; # -# CSS stylesheet for the CGI interface. It is stored in the -# $Conf{CgiImageDir} directory and accessed via the +# 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'; # @@ -1780,7 +2014,14 @@ $Conf{CgiUserConfigEditEnable} = 1; # # Which per-host config variables a non-admin user is allowed -# to edit. +# 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, @@ -1791,41 +2032,68 @@ $Conf{CgiUserConfigEdit} = { IncrKeepCnt => 1, IncrKeepCntMin => 1, IncrAgeMax => 1, - PartialAgeMax => 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, RsyncRestoreArgs => 1, + RsyncClientCmd => 0, + RsyncClientRestoreCmd => 0, + RsyncClientPath => 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,