X-Git-Url: http://git.rot13.org/?p=BackupPC.git;a=blobdiff_plain;f=conf%2Fconfig.pl;h=a807a797bf471f3457e31b11861847eeef3dbcb1;hp=824ae779bb10cfcf4a98cdf2d86456da42175a91;hb=fda25dc88a63ccac1c80efa2e4994bf0725ca9b7;hpb=617af75f7419e95a9c3ea05b05cf21957acc331c diff --git a/conf/config.pl b/conf/config.pl index 824ae77..a807a79 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 @@ -146,8 +144,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 +200,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 +208,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. @@ -335,6 +337,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 +654,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 +704,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'; @@ -843,14 +849,45 @@ $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'; + # # 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. @@ -892,7 +929,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. @@ -910,6 +947,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'; @@ -920,6 +961,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'; @@ -934,6 +979,10 @@ $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 -'; @@ -1004,6 +1053,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'; @@ -1061,6 +1114,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+'; @@ -1071,12 +1128,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 @@ -1110,6 +1167,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+'; # @@ -1161,7 +1222,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 @@ -1205,14 +1266,17 @@ $Conf{RsyncArgs} = [ '--group', '-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', @@ -1239,6 +1303,7 @@ $Conf{RsyncRestoreArgs} = [ '--group', '-D', '--links', + '--hard-links', '--times', '--block-size=2048', '--relative', @@ -1246,9 +1311,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', @@ -1271,7 +1338,7 @@ $Conf{BackupPCdShareName} = '/'; # # Path to backuppcd executable on the server # -$Conf{BackupPCdPath} = '/usr/bin/backuppcd'; +$Conf{BackupPCdPath} = ''; # # Full command to run backuppcd on the server to backup a given @@ -1311,6 +1378,10 @@ $Conf{BackupPCdCmd} = '$bpcdPath $host $shareName $poolDir XXXX $poolCompress $t # # This setting only matters if $Conf{XferMethod} = 'backuppcd'. # +# 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{BackupPCdRestoreCmd} = '$bpcdPath TODO'; @@ -1379,6 +1450,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 *'; @@ -1387,7 +1462,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 @@ -1396,7 +1471,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 @@ -1408,6 +1483,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'; # @@ -1435,6 +1514,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'; # @@ -1456,7 +1539,7 @@ $Conf{FixedIPNetBiosNameCheck} = 0; # # $Conf{PingPath} = '/bin/echo'; # -$Conf{PingPath} = '/bin/ping'; +$Conf{PingPath} = ''; # # Ping command. The following variables are substituted at run-time: @@ -1468,6 +1551,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'; # @@ -1614,6 +1701,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; @@ -1673,7 +1764,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. @@ -1789,7 +1880,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} = < "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", @@ -1919,6 +2013,8 @@ $Conf{CgiStatusHilightColor} = { Reason_no_ping => '#ffff99', Reason_backup_canceled_by_user => '#ff9900', Status_backup_in_progress => '#66cc99', + Disabled_OnlyManualBackups => '#d1d1d1', + Disabled_AllBackupsDisabled => '#d1d1d1', }; # @@ -1958,10 +2054,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'; # @@ -1996,11 +2096,13 @@ $Conf{CgiUserConfigEdit} = { 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, @@ -2014,15 +2116,18 @@ $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, ArchiveDest => 1, ArchiveComp => 1, ArchivePar => 1,