X-Git-Url: http://git.rot13.org/?p=BackupPC.git;a=blobdiff_plain;f=conf%2Fconfig.pl;h=58991e158df65a3d7fcc112ba093d1f447532dde;hp=8c581400be13f5554393d29fd12bc31447ab7b76;hb=8f5625f9cdf47f8e04be654c4954838b2df3e26d;hpb=a7e968ce327855f2ba2624ca8517069a936c9b5b
diff --git a/conf/config.pl b/conf/config.pl
index 8c58140..58991e1 100644
--- a/conf/config.pl
+++ b/conf/config.pl
@@ -108,6 +108,13 @@ $Conf{UmaskMode} = 027;
#
# 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).
+#
$Conf{WakeupSchedule} = [1..23];
#
@@ -241,7 +248,7 @@ $Conf{BackupPCUserVerify} = 1;
#
# Maximum number of hardlinks supported by the $TopDir file system
# that BackupPC uses. Most linux or unix file systems should support
-# at least 32000 hardlinks per file, or 64K in other cases. If a pool
+# at least 32000 hardlinks per file, or 64000 in other cases. If a pool
# file already has this number of hardlinks, a new pool file is created
# so that new hardlinks can be accommodated. This limit will only
# be hit if an identical file appears at least this number of times
@@ -337,10 +344,6 @@ $Conf{TarShareName} = '/';
# being backed up (eg: a retired machine), but you wish to keep the
# last backups available for browsing or restoring to other machines.
#
-# Also, you might create a virtual client (by setting $Conf{ClientNameAlias})
-# for restoring to a DVD or permanent media and you would set
-# $Conf{FullPeriod} to -2 so that it is never backed up.
-#
$Conf{FullPeriod} = 6.97;
#
@@ -361,8 +364,74 @@ $Conf{IncrPeriod} = 0.97;
# extra old backups will be removed.
#
# If filling of incremental dumps is off the oldest backup always
-# has to be a full (ie: filled) dump. This might mean an extra full
-# dump is kept until the second oldest (incremental) dump expires.
+# has to be a full (ie: filled) dump. This might mean one or two
+# extra full dumps are kept until the oldest incremental backups expire.
+#
+# Exponential backup expiry is also supported. This allows you to specify:
+#
+# - num fulls to keep at intervals of 1 * $Conf{FullPeriod}, followed by
+# - num fulls to keep at intervals of 2 * $Conf{FullPeriod},
+# - num fulls to keep at intervals of 4 * $Conf{FullPeriod},
+# - num fulls to keep at intervals of 8 * $Conf{FullPeriod},
+# - num fulls to keep at intervals of 16 * $Conf{FullPeriod},
+#
+# and so on. This works by deleting every other full as each expiry
+# boundary is crossed.
+#
+# Exponential expiry is specified using an array for $Conf{FullKeepCnt}:
+#
+# $Conf{FullKeepCnt} = [4, 2, 3];
+#
+# Entry #n specifies how many fulls to keep at an interval of
+# 2^n * $Conf{FullPeriod} (ie: 1, 2, 4, 8, 16, 32, ...).
+#
+# The example above specifies keeping 4 of the most recent full backups
+# (1 week interval) two full backups at 2 week intervals, and 3 full
+# backups at 4 week intervals, eg:
+#
+# full 0 19 weeks old \
+# full 1 15 weeks old >--- 3 backups at 4 * $Conf{FullPeriod}
+# full 2 11 weeks old /
+# full 3 7 weeks old \____ 2 backups at 2 * $Conf{FullPeriod}
+# full 4 5 weeks old /
+# full 5 3 weeks old \
+# full 6 2 weeks old \___ 4 backups at 1 * $Conf{FullPeriod}
+# full 7 1 week old /
+# full 8 current /
+#
+# On a given week the spacing might be less than shown as each backup
+# ages through each expiry period. For example, one week later, a
+# new full is completed and the oldest is deleted, giving:
+#
+# full 0 16 weeks old \
+# full 1 12 weeks old >--- 3 backups at 4 * $Conf{FullPeriod}
+# full 2 8 weeks old /
+# full 3 6 weeks old \____ 2 backups at 2 * $Conf{FullPeriod}
+# full 4 4 weeks old /
+# full 5 3 weeks old \
+# full 6 2 weeks old \___ 4 backups at 1 * $Conf{FullPeriod}
+# full 7 1 week old /
+# full 8 current /
+#
+# You can specify 0 as a count (except in the first entry), and the
+# array can be as long as you wish. For example:
+#
+# $Conf{FullKeepCnt} = [4, 0, 4, 0, 0, 2];
+#
+# This will keep 10 full dumps, 4 most recent at 1 * $Conf{FullPeriod},
+# followed by 4 at an interval of 4 * $Conf{FullPeriod} (approx 1 month
+# apart), and then 2 at an interval of 32 * $Conf{FullPeriod} (approx
+# 7-8 months apart).
+#
+# Note that you will have to increase $Conf{FullAgeMax} if you want
+# very old full backups to be kept. Full backups are removed according
+# to both $Conf{FullKeepCnt} and $Conf{FullAgeMax}.
+#
+# Note also that these two settings are equivalent and both keep just
+# the four most recent full dumps:
+#
+# $Conf{FullKeepCnt} = 4;
+# $Conf{FullKeepCnt} = [4];
#
$Conf{FullKeepCnt} = 1;
@@ -372,7 +441,7 @@ $Conf{FullKeepCnt} = 1;
# they are.
#
$Conf{FullKeepCntMin} = 1;
-$Conf{FullAgeMax} = 60;
+$Conf{FullAgeMax} = 90;
#
# Number of incremental backups to keep. Must be >= 1.
@@ -433,9 +502,9 @@ $Conf{IncrFill} = 0;
$Conf{RestoreInfoKeepCnt} = 10;
#
-# Number of archive logs to keep. BackupPC remembers information about
-# each archive request. This number per archive client will be kept around before
-# the oldest ones are pruned.
+# Number of archive logs to keep. BackupPC remembers information
+# about each archive request. This number per archive client will
+# be kept around before the oldest ones are pruned.
#
$Conf{ArchiveInfoKeepCnt} = 10;
@@ -495,6 +564,9 @@ $Conf{BackupFilesOnly} = undef;
# the directory name: a trailing "/" causes the name to not match
# and the directory will not be excluded.
#
+# Users report that for smbclient you should specify a directory
+# followed by "/*", eg: "/proc/*", instead of just "/proc".
+#
# Examples:
# $Conf{BackupFilesExclude} = '/temp';
# $Conf{BackupFilesExclude} = ['/temp']; # same as first example
@@ -512,8 +584,7 @@ $Conf{BackupFilesExclude} = undef;
# each PC a count of consecutive good pings is maintained. Once a PC has
# at least $Conf{BlackoutGoodCnt} consecutive good pings it is subject
# to "blackout" and not backed up during hours and days specified by
-# $Conf{BlackoutWeekDays}, $Conf{BlackoutHourBegin} and
-# $Conf{BlackoutHourEnd}.
+# $Conf{BlackoutPeriods}.
#
# To allow for periodic rebooting of a PC or other brief periods when a
# PC is not on the network, a number of consecutive bad pings is allowed
@@ -539,13 +610,52 @@ $Conf{BlackoutBadPingLimit} = 3;
$Conf{BlackoutGoodCnt} = 7;
#
-# The default settings specify the blackout period from 7:00am to
-# 7:30pm local time on Mon-Fri. For $Conf{BlackoutWeekDays},
-# 0 is Sunday, 1 is Monday etc.
+# One or more blackout periods can be specified. If a client is
+# subject to blackout then no regular (non-manual) backups will
+# be started during any of these periods. hourBegin and hourEnd
+# specify hours fro midnight and weekDays is a list of days of
+# the week where 0 is Sunday, 1 is Monday etc.
+#
+# For example:
+#
+# $Conf{BlackoutPeriods} = [
+# {
+# hourBegin => 7.0,
+# hourEnd => 19.5,
+# weekDays => [1, 2, 3, 4, 5],
+# },
+# ];
+#
+# specifies one blackout period from 7:00am to 7:30pm local time
+# on Mon-Fri.
+#
+# The blackout period can also span midnight by setting
+# hourBegin > hourEnd, eg:
+#
+# $Conf{BlackoutPeriods} = [
+# {
+# hourBegin => 7.0,
+# hourEnd => 19.5,
+# weekDays => [1, 2, 3, 4, 5],
+# },
+# {
+# hourBegin => 23,
+# hourEnd => 5,
+# weekDays => [5, 6],
+# },
+# ];
#
-$Conf{BlackoutHourBegin} = 7.0;
-$Conf{BlackoutHourEnd} = 19.5;
-$Conf{BlackoutWeekDays} = [1, 2, 3, 4, 5];
+# This specifies one blackout period from 7:00am to 7:30pm local time
+# on Mon-Fri, and a second period from 11pm to 5am on Friday and
+# Saturday night.
+#
+$Conf{BlackoutPeriods} = [
+ {
+ hourBegin => 7.0,
+ hourEnd => 19.5,
+ weekDays => [1, 2, 3, 4, 5],
+ },
+];
#
# A backup of a share that has zero files is considered fatal. This is
@@ -566,21 +676,33 @@ $Conf{BackupZeroFilesIsFatal} = 1;
#
# The valid values are:
#
-# - 'smb': backup and restore via smbclient and the SMB protocol.
-# Best choice for WinXX.
+# - 'smb': backup and restore via smbclient and the SMB protocol.
+# Easiest choice for WinXX.
#
-# - 'rsync': backup and restore via rsync (via rsh or ssh).
-# Best choice for linux/unix. Can also work on WinXX.
+# - 'rsync': backup and restore via rsync (via rsh or ssh).
+# Best choice for linux/unix. Good choice also for WinXX.
#
-# - 'rsyncd': backup and restre via rsync daemon on the client.
-# Best choice for linux/unix if you have rsyncd running on
-# the client. Can also work on WinXX.
+# - 'rsyncd': backup and restre via rsync daemon on the client.
+# Best choice for linux/unix if you have rsyncd running on
+# the client. Good choice also for WinXX.
#
# - 'tar': backup and restore via tar, tar over ssh, rsh or nfs.
# Good choice for linux/unix.
#
+# - 'archive': host is a special archive host. Backups are not done.
+# An archive host is used to archive other host's backups
+# to permanent media, such as tape, CDR or DVD.
+#
+#
$Conf{XferMethod} = 'smb';
+#
+# Level of verbosity in Xfer log files. 0 means be quiet, 1 will give
+# will give one line per file, 2 will also show skipped files on
+# incrementals, higher values give more output.
+#
+$Conf{XferLogLevel} = 1;
+
#
# Full path for smbclient. Security caution: normal users should not
# allowed to write to this file or directory.
@@ -609,6 +731,10 @@ $Conf{SmbClientPath} = '/usr/bin/smbclient';
# $X_option exclude option (if $fileList is an exclude list)
# $timeStampFile start time for incremental dump
#
+# If your smb share is read-only then direct restores will fail.
+# You should set $Conf{SmbClientRestoreCmd} to undef and the
+# corresponding CGI restore option will be removed.
+#
$Conf{SmbClientFullCmd} = '$smbClientPath \\\\$host\\$shareName'
. ' $I_option -U $userName -E -N -d 1'
. ' -c tarmode\\ full -Tc$X_option - $fileList';
@@ -656,7 +782,7 @@ $Conf{SmbClientRestoreCmd} = '$smbClientPath \\\\$host\\$shareName'
#
# This setting only matters if $Conf{XferMethod} = 'tar'.
#
-$Conf{TarClientCmd} = '$sshPath -q -n -l root $host'
+$Conf{TarClientCmd} = '$sshPath -q -x -n -l root $host'
. ' $tarPath -c -v -f - -C $shareName+'
. ' --totals';
@@ -709,7 +835,11 @@ $Conf{TarIncrArgs} = '--newer=$incrDate+ $fileList+';
#
# This setting only matters if $Conf{XferMethod} = "tar".
#
-$Conf{TarClientRestoreCmd} = '$sshPath -q -l root $host'
+# If you want to disable direct restores using tar, you should set
+# $Conf{TarClientRestoreCmd} to undef and the corresponding CGI
+# restore option will be removed.
+#
+$Conf{TarClientRestoreCmd} = '$sshPath -q -x -l root $host'
. ' $tarPath -x -p --numeric-owner --same-owner'
. ' -v -f - -C $shareName+';
@@ -741,7 +871,7 @@ $Conf{RsyncClientPath} = '/bin/rsync';
#
# This setting only matters if $Conf{XferMethod} = 'rsync'.
#
-$Conf{RsyncClientCmd} = '$sshPath -l root $host $rsyncPath $argList+';
+$Conf{RsyncClientCmd} = '$sshPath -q -x -l root $host $rsyncPath $argList+';
#
# Full command to run rsync for restore on the client. The following
@@ -758,7 +888,7 @@ $Conf{RsyncClientCmd} = '$sshPath -l root $host $rsyncPath $argList+';
#
# This setting only matters if $Conf{XferMethod} = 'rsync'.
#
-$Conf{RsyncClientRestoreCmd} = '$sshPath -l root $host $rsyncPath $argList+';
+$Conf{RsyncClientRestoreCmd} = '$sshPath -q -x -l root $host $rsyncPath $argList+';
#
# Share name to backup. For $Conf{XferMethod} = "rsync" this should
@@ -833,6 +963,14 @@ $Conf{RsyncArgs} = [
'--times',
'--block-size=2048',
'--recursive',
+
+ #
+ # If you are using a patched client rsync that supports the
+ # --fixed-csumseed option (see http://backuppc.sourceforge.net),
+ # then uncomment this to enabled rsync checksum cachcing
+ #
+ #'--fixed-csumseed',
+
#
# Add additional arguments here
#
@@ -842,36 +980,38 @@ $Conf{RsyncArgs} = [
# Arguments to rsync for restore. Do not edit the first set unless you
# have a thorough understanding of how File::RsyncP works.
#
+# If you want to disable direct restores using rsync (eg: is the module
+# is read-only), you should set $Conf{RsyncRestoreArgs} to undef and
+# the corresponding CGI restore option will be removed.
#
$Conf{RsyncRestoreArgs} = [
#
# Do not edit these!
#
- "--numeric-ids",
- "--perms",
- "--owner",
- "--group",
- "--devices",
- "--links",
- "--times",
- "--block-size=2048",
- "--relative",
- "--ignore-times",
- "--recursive",
+ '--numeric-ids',
+ '--perms',
+ '--owner',
+ '--group',
+ '--devices',
+ '--links',
+ '--times',
+ '--block-size=2048',
+ '--relative',
+ '--ignore-times',
+ '--recursive',
+
+ #
+ # If you are using a patched client rsync that supports the
+ # --fixed-csumseed option (see http://backuppc.sourceforge.net),
+ # then uncomment this to enabled rsync checksum cachcing
+ #
+ #'--fixed-csumseed',
+
#
# Add additional arguments here
#
];
-#
-# Amount of verbosity in Rsync Xfer log files. 0 means be quiet,
-# 1 will give will give one line per file, 2 will also show skipped
-# files on incrementals, higher values give more output. 10 will
-# include byte dumps of all data read/written, which will make the
-# log files huge.
-#
-$Conf{RsyncLogLevel} = 1;
-
#
# Archive Destination
#
@@ -919,7 +1059,7 @@ $Conf{ArchiveSplit} = 650;
# Archive Command
#
# This is the command that is called to actually run the archive process
-# The following variables are substituted at run-time:
+# for each host. The following variables are substituted at run-time:
#
# $Installdir The installation directory of BackupPC
# $tarCreatePath The path to BackupPC_tarCreate
@@ -933,7 +1073,9 @@ $Conf{ArchiveSplit} = 650;
# $archiveloc The location to put the archive
# $parfile The number of par files to create
#
-$Conf{ArchiveClientCmd} = '$Installdir/bin/BackupPC_archivecd $tarCreatePath $splitpath $parpath $host $backupnumber $compression $compext $splitsize $archiveloc $parfile /';
+$Conf{ArchiveClientCmd} = '$Installdir/bin/BackupPC_archiveHost'
+ . ' $tarCreatePath $splitpath $parpath $host $backupnumber'
+ . ' $compression $compext $splitsize $archiveloc $parfile *';
#
# Full path for ssh. Security caution: normal users should not
@@ -1034,7 +1176,7 @@ $Conf{PingCmd} = '$pingPath -c 1 $host';
# Example:
#
# $Conf{ServerInitdPath} = '/etc/init.d/backuppc';
-# $Conf{ServerInitdStartCmd} = '$sshPath -l root $serverHost'
+# $Conf{ServerInitdStartCmd} = '$sshPath -q -x -l root $serverHost'
# . ' $serverInitdPath start'
# . ' < /dev/null >& /dev/null';
#
@@ -1119,7 +1261,7 @@ $Conf{MaxOldPerPCLogFiles} = 12;
# shut down and restart a database server, or to dump a database
# to files for backup. Example:
#
-# $Conf{DumpPreUserCmd} = '$sshPath -l root $host /usr/bin/dumpMysql';
+# $Conf{DumpPreUserCmd} = '$sshPath -q -x -l root $host /usr/bin/dumpMysql';
#
# The following variable substitutions are made at run time for
# $Conf{DumpPreUserCmd} and $Conf{DumpPostUserCmd}:
@@ -1373,10 +1515,10 @@ $Conf{CgiURL} = undef;
#
# Language to use. See lib/BackupPC/Lang for the list of supported
# languages, which include English (en), French (fr), Spanish (es),
-# and German (de).
+# German (de), and Italian (it).
#
# Currently the Language setting applies to the CGI interface and email
-# messages sent to users. Log files and other text is still in English.
+# messages sent to users. Log files and other text are still in English.
#
$Conf{Language} = 'en';
@@ -1412,16 +1554,11 @@ $Conf{CgiDateFormatMMDD} = 1;
#
# If set, the complete list of hosts appears in the left navigation
-# bar for administrators. Otherwise, just the hosts for which the
-# user is listed in the host file (as either the user or in moreUsers)
+# bar pull-down for administrators. Otherwise, just the hosts for which
+# the user is listed in the host file (as either the user or in moreUsers)
# are displayed.
#
-$Conf{CgiNavBarAdminAllHosts} = 0;
-
-#
-# Color scheme for CGI interface.
-#
-$Conf{CgiHeaderBgColor} = '#99cc33';
+$Conf{CgiNavBarAdminAllHosts} = 1;
#
# Hilight colors based on status that are used in the PC summary page.
@@ -1435,10 +1572,7 @@ $Conf{CgiStatusHilightColor} = {
};
#
-# Additional CGI header text. For example, if you wanted each CGI page
-# to auto refresh every 900 seconds, you could add this text:
-#
-#
+# Additional CGI header text.
#
$Conf{CgiHeaders} = '';
@@ -1474,177 +1608,8 @@ $Conf{CgiExt2ContentType} = { };
$Conf{CgiImageDirURL} = '';
#
-# CSS stylesheet for the CGI interface.
-#
-$Conf{CSSstylesheet} = <<'EOF';
-
-EOF
+# CSS stylesheet for the CGI interface. It is stored in the
+# $Conf{CgiImageDir} directory and accessed via the
+# $Conf{CgiImageDirURL} URL.
+#
+$Conf{CgiCSSFile} = 'BackupPC_stnd.css';