X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=conf%2Fconfig.pl;h=e0b682e2f3559cd2ff36bcbc19e6888804fa0c42;hb=5b9aa3bc5fec586b44508ecaab8db9cb47f1c35b;hp=e02fe277efab9584395532785c7f5b35b2222b47;hpb=27f513f89d885d24bf1a01242fba676c7a840fd5;p=BackupPC.git diff --git a/conf/config.pl b/conf/config.pl index e02fe27..e0b682e 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,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 @@ -138,7 +136,13 @@ $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. @@ -146,8 +150,9 @@ $Conf{MaxPendingCmds} = 10; # 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 runs only when there are no backups -# running, and no backups will start while it runs. +# 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 @@ -201,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: @@ -209,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/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. @@ -286,6 +294,14 @@ $Conf{BackupPCUser} = ''; # 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} = ''; @@ -335,6 +351,10 @@ $Conf{PerlModuleLoad} = undef; # . ' $serverInitdPath start' # . ' < /dev/null >& /dev/null'; # +# 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{ServerInitdPath} = ''; $Conf{ServerInitdStartCmd} = ''; @@ -353,18 +373,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; # @@ -481,6 +489,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 @@ -561,7 +668,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'; @@ -610,8 +717,14 @@ $Conf{BackupFilesOnly} = undef; # 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. +# shares that don't have a specific entry. # # Examples: # $Conf{BackupFilesExclude} = '/temp'; @@ -756,14 +869,49 @@ $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'. +# 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, and also see http://czyborra.com/charsets/iso8859.html. -# +# 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. @@ -805,7 +953,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. @@ -823,6 +971,10 @@ $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'; @@ -833,6 +985,10 @@ $Conf{SmbClientFullCmd} = '$smbClientPath \\\\$host\\$shareName' # # 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'; @@ -847,10 +1003,18 @@ $Conf{SmbClientIncrCmd} = '$smbClientPath \\\\$host\\$shareName' # 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 @@ -917,6 +1081,10 @@ $Conf{TarShareName} = '/'; # # This setting only matters if $Conf{XferMethod} = 'tar'. # +# 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'; @@ -974,6 +1142,10 @@ $Conf{TarIncrArgs} = '--newer=$incrDate+ $fileList+'; # $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+'; @@ -984,12 +1156,16 @@ $Conf{TarClientRestoreCmd} = '$sshPath -q -x -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 @@ -1023,6 +1199,10 @@ $Conf{RsyncClientCmd} = '$sshPath -q -x -l root $host $rsyncPath $argList+'; # # This setting only matters if $Conf{XferMethod} = 'rsync'. # +# 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+'; # @@ -1074,7 +1254,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 @@ -1098,16 +1278,6 @@ $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! @@ -1116,24 +1286,55 @@ $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', - - # - # Add additional arguments here - # ]; +# +# 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. @@ -1142,6 +1343,17 @@ $Conf{RsyncArgs} = [ # 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! @@ -1150,8 +1362,9 @@ $Conf{RsyncRestoreArgs} = [ '--perms', '--owner', '--group', - '--devices', + '-D', '--links', + '--hard-links', '--times', '--block-size=2048', '--relative', @@ -1159,9 +1372,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', @@ -1170,63 +1385,103 @@ $Conf{RsyncRestoreArgs} = [ # ]; +########################################################################### +# FTP Configuration +# (can be overwritten in the per-PC log file) +########################################################################## # -# Share name to backup. For $Conf{XferMethod} = "backuppcd" this should -# be a file system path, eg '/' or '/home'. +# 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 can also be a list of multiple file system paths or modules. -# (Can it??) +# 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 # -# $Conf{BackupPCdShareName} = ['/', '/var', '/data', '/boot']; +# 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}. # -$Conf{BackupPCdShareName} = '/'; +# This setting only matters if $Conf{XferMethod} = 'ftp'. +# +$Conf{FtpShareName} = ''; # -# Path to backuppcd executable on the server +# FTP user name. This is used to log into the server. +# +# This setting is used only if $Conf{XferMethod} = 'ftp'. # -$Conf{BackupPCdPath} = '/usr/bin/backuppcd'; +$Conf{FtpUserName} = ''; # -# 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) +# FTP user password. This is used to log into the server. # -# $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 is used only if $Conf{XferMethod} = 'ftp'. # -# This setting only matters if $Conf{XferMethod} = 'backuppcd'. +$Conf{FtpPasswd} = ''; + # -# Arguments to backupcpd are: +# 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. # -# - 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 ".") +# This setting is used only if $Conf{XferMethod} = 'ftp'. # -$Conf{BackupPCdCmd} = '$bpcdPath $host $shareName $poolDir XXXX $poolCompress $topDir/pc/$client/new'; +$Conf{FtpPassive} = 1; # -# 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) +# Transfer block size. This sets the size of the amounts of data in +# each frame. While undefined, this value takes the default value. # -# $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 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'. # -# This setting only matters if $Conf{XferMethod} = 'backuppcd'. +$Conf{FtpPort} = 21; + +# +# Connection timeout for FTP. When undefined, the default is 120 seconds. +# +# This setting is used only if $Conf{XferMethod} = 'ftp'. # -$Conf{BackupPCdRestoreCmd} = '$bpcdPath TODO'; +$Conf{FtpTimeout} = 120; +# +# Behaviour when BackupPC encounters symlinks on the FTP share. +# +# 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 # @@ -1292,6 +1547,10 @@ $Conf{ArchiveSplit} = 0; # $archiveloc The location to put the archive # $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' . ' $compression $compext $splitsize $archiveloc $parfile *'; @@ -1300,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 @@ -1309,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 @@ -1321,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'; # @@ -1348,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'; # @@ -1369,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: @@ -1381,6 +1648,10 @@ $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'; # @@ -1527,6 +1798,10 @@ $Conf{MaxOldPerPCLogFiles} = 12; # $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; @@ -1536,6 +1811,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 @@ -1563,7 +1861,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. @@ -1679,11 +1977,12 @@ $Conf{EMailOutlookBackupSubj} = undef; $Conf{EMailOutlookBackupMesg} = undef; # -# Additional email headers +# Additional email headers. This sets to charset to +# utf8. # $Conf{EMailHeaders} = < "Documentation", # actually displays $Lang->{Documentation} }, { - link => "http://backuppc.sourceforge.net/faq", - name => "FAQ", # displays literal "FAQ" + link => "http://backuppc.wiki.sourceforge.net", + name => "Wiki", # displays literal "Wiki" }, { link => "http://backuppc.sourceforge.net", @@ -1809,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', }; # @@ -1822,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} = ''; @@ -1848,10 +2150,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'; # @@ -1879,17 +2185,20 @@ $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, @@ -1903,15 +2212,27 @@ $Conf{CgiUserConfigEdit} = { 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, @@ -1934,6 +2255,7 @@ $Conf{CgiUserConfigEdit} = { ArchivePostUserCmd => 0, DumpPostShareCmd => 0, DumpPreShareCmd => 0, + UserCmdCheckStatus => 0, EMailNotifyMinDays => 1, EMailFromUserName => 1, EMailAdminUserName => 1, @@ -1948,3 +2270,94 @@ $Conf{CgiUserConfigEdit} = { 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{ArchiveMediaSize} = 4200 * 1024 * 1024; + +# +# maximum size of one (uncompressed) file on archive medium (in bytes) +# default: 2Gb - 2k for DVD +#$Conf{ArchiveChunkSize} = (2048 - 2) * 1024 * 1024; + +# +# 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/';