X-Git-Url: http://git.rot13.org/?p=BackupPC.git;a=blobdiff_plain;f=conf%2Fconfig.pl;h=feed6bfbba79eb6b63275785efd99889640bfc9a;hp=069dd6648787e68c50228307bdbd29adeae064ba;hb=3d15da9b2c6de8018c02677549678d6d769234b5;hpb=b81d2da5e16975674f011e4833337ac0fa24e0ea diff --git a/conf/config.pl b/conf/config.pl index 069dd66..feed6bf 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 @@ -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} = ''; @@ -648,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'; @@ -698,7 +718,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'; @@ -871,6 +891,21 @@ $Conf{XferLogLevel} = 1; # $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. @@ -912,7 +947,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. @@ -930,6 +965,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'; @@ -940,6 +979,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'; @@ -954,10 +997,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 @@ -1024,6 +1075,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'; @@ -1081,6 +1136,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+'; @@ -1091,12 +1150,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 @@ -1130,6 +1193,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+'; # @@ -1283,63 +1350,72 @@ $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'. +# Name of the host share that is backed up when using FTP. This can be a +# string or an array of strings if there are multiple shares per host. +# Examples: # -# This can also be a list of multiple file system paths or modules. -# (Can it??) +# $Conf{FtpShareName} = 'c'; # backup 'c' share +# $Conf{FtpShareName} = ['c', 'd']; # backup 'c' and 'd' shares # -# $Conf{BackupPCdShareName} = ['/', '/var', '/data', '/boot']; +# This setting only matters if $Conf{XferMethod} = 'ftp'. # -$Conf{BackupPCdShareName} = '/'; +$Conf{FtpShareName} = ''; # -# Path to backuppcd executable on the server +# FTP user name. This is used to log into the server. # -$Conf{BackupPCdPath} = '/usr/bin/backuppcd'; +# This setting is used only if $Conf{XferMethod} = 'ftp'. +# +$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: +# Transfer block size. This sets the size of the amounts of data in +# each frame. While undefined, this value takes the default value. # -# - 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{FtpBlockSize} = 10240; # -# 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) +# The port of the ftp server. If undefined, 21 is used. # -# $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{FtpPort} = 21; + # -$Conf{BackupPCdRestoreCmd} = '$bpcdPath TODO'; +# Connection timeout for FTP. When undefined, the default is 120 seconds. +# +# This setting is used only if $Conf{XferMethod} = 'ftp'. +# +$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 # @@ -1405,6 +1481,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 *'; @@ -1413,7 +1493,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 @@ -1422,7 +1502,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 @@ -1434,6 +1514,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'; # @@ -1461,6 +1545,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'; # @@ -1482,7 +1570,7 @@ $Conf{FixedIPNetBiosNameCheck} = 0; # # $Conf{PingPath} = '/bin/echo'; # -$Conf{PingPath} = '/bin/ping'; +$Conf{PingPath} = ''; # # Ping command. The following variables are substituted at run-time: @@ -1494,6 +1582,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'; # @@ -1640,6 +1732,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; @@ -1699,7 +1795,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. @@ -1815,13 +1911,12 @@ $Conf{EMailOutlookBackupSubj} = undef; $Conf{EMailOutlookBackupMesg} = undef; # -# Additional email headers. If you change the charset -# to utf8 then BackupPC_sendEmail will use utf8 for -# the email body. +# 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", @@ -1962,7 +2058,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} = ''; @@ -2036,6 +2132,7 @@ $Conf{CgiUserConfigEdit} = { BlackoutPeriods => 1, BackupZeroFilesIsFatal => 1, ClientCharset => 1, + ClientCharsetLegacy => 1, XferMethod => 1, XferLogLevel => 1, SmbShareName => 1, @@ -2049,15 +2146,24 @@ $Conf{CgiUserConfigEdit} = { 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, + FtpShareName => 1, + FtpUserName => 1, + FtpPasswd => 1, + FtpBlockSize => 1, + FtpPort => 1, + FtpTimeout => 1, ArchiveDest => 1, ArchiveComp => 1, ArchivePar => 1,