#
# 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];
#
#
$Conf{MaxPendingCmds} = 10;
+#
+# How many BackupPC_nightly processes to run in parallel.
+#
+# 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.
+#
+# So to reduce the elapsed time, you might want to increase this
+# setting to run several BackupPC_nightly processes in parallel
+# (eg: 4, or even 8).
+#
+$Conf{MaxBackupPCNightlyJobs} = 2;
+
+#
+# How many days (runs) it takes BackupPC_nightly to traverse the
+# entire pool. Normally this is 1, which means every night it runs,
+# it does traverse the entire pool removing unused pool files.
+#
+# Other valid values are 2, 4, 8, 16. This causes BackupPC_nightly to
+# traverse 1/2, 1/4, 1/8 or 1/16th of the pool each night, meaning it
+# takes 2, 4, 8 or 16 days to completely traverse the pool. The
+# advantage is that each night the running time of BackupPC_nightly
+# is reduced roughly in proportion, since the total job is split
+# over multiple days. The disadvantage is that unused pool files
+# take longer to get deleted, which will slightly increase disk
+# usage.
+#
+# Note that even when $Conf{BackupPCNightlyPeriod} > 1, BackupPC_nightly
+# still runs every night. It just does less work each time it runs.
+#
+# Examples:
+#
+# $Conf{BackupPCNightlyPeriod} = 1; # entire pool is checked every night
+#
+# $Conf{BackupPCNightlyPeriod} = 2; # two days to complete pool check
+# # (different half each night)
+#
+# $Conf{BackupPCNightlyPeriod} = 4; # four days to complete pool check
+# # (different quarter each night)
+#
+$Conf{BackupPCNightlyPeriod} = 1;
+
#
# Maximum number of log files we keep around in log directory.
# These files are aged nightly. A setting of 14 means the log
#
$Conf{SplitPath} = '/usr/bin/split';
-$Conf{ParPath} = '/usr/bin/par';
+$Conf{ParPath} = '/usr/bin/par2';
$Conf{CatPath} = '/bin/cat';
$Conf{GzipPath} = '/bin/gzip';
$Conf{Bzip2Path} = '/usr/bin/bzip2';
# 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;
#
# 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;
# they are.
#
$Conf{FullKeepCntMin} = 1;
-$Conf{FullAgeMax} = 60;
+$Conf{FullAgeMax} = 90;
#
# Number of incremental backups to keep. Must be >= 1.
$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;
# 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
# 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
$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],
+# },
+# ];
+#
+# 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{BlackoutHourBegin} = 7.0;
-$Conf{BlackoutHourEnd} = 19.5;
-$Conf{BlackoutWeekDays} = [1, 2, 3, 4, 5];
+$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
#
# 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.
# $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';
#
# 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';
#
# 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+';
#
# 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
#
# 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
'--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
#
# 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
#
#
# Archive Parity Files
#
-# The number of Parity Files to generate.
-# Uses the commandline par available from
+# The amount of Parity data to generate, as a percentage
+# of the archive size.
+# Uses the commandline par2 (par2cmdline) available from
# http://parchive.sourceforge.net
#
# Only useful for file dumps.
# 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
# $splitpath The path to the split program
-# $parpath The path to the par program
+# $parpath The path to the par2 program
# $host The host to archive
# $backupnumber The backup number of the host to archive
# $compression The path to the compression program
# $compext The extension assigned to the compression type
# $splitsize The number of bytes to split archives into
# $archiveloc The location to put the archive
-# $parfile The number of par files to create
+# $parfile The amount of parity data to create (percentage)
#
-$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
# 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';
#
# 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}:
# $HostList list of hosts being archived
# $BackupList list of backup numbers for the hosts being archived
# $archiveloc location where the archive is sent to
-# $parfile number of par files being generated
+# $parfile amount of parity data being generated (percentage)
# $compression compression program being used (eg: cat, gzip, bzip2)
# $compext extension used for compression type (eg: raw, gz, bz2)
# $splitsize size of the files that the archive creates
#
# 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';
#
# 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.
};
#
-# Additional CGI header text. For example, if you wanted each CGI page
-# to auto refresh every 900 seconds, you could add this text:
-#
-# <meta http-equiv="refresh" content="900">
+# Additional CGI header text.
#
$Conf{CgiHeaders} = '<meta http-equiv="pragma" content="no-cache">';
$Conf{CgiImageDirURL} = '';
#
-# CSS stylesheet for the CGI interface.
-#
-$Conf{CSSstylesheet} = <<'EOF';
-<style type="text/css">
-body {
- font-family:arial,sans-serif;
- font-size:1em;
- background-color:#ffffff;
- margin:2px 5px 0px 2px;
- height:100%
-}
-
-h1 {
- font-family:arial,sans-serif;
- font-size:1.5em;
- color:#000000
-}
-
-h2 {
- font-family:arial,sans-serif;
- font-size:1em;
- color:#000000
-}
-
-p {
- font-family:arial,sans-serif;
- font-size:.9em
-}
-
-a {
- font-family:arial,sans-serif;
- font-size:1em;
- color:#3333ff
-}
-
-li {
- font-size:.9em;
-}
-
-a:hover {
- color:#cc0000;
- text-decoration:none
-}
-
-a.NavCurrent {
- font-weight:bold;
-}
-
-a.navbar {
- padding-left:5px;
- padding-right:5px;
-}
-
-.h1 {
- font-family:arial,sans-serif;
- font-size:1.5em;
- color:#000000;
- font-weight:bold;
- background-color:#99cc33;
- padding:3px;
- padding-left:10px
-}
-
-.h2 {
- font-family:arial,sans-serif;
- font-size:1em;
- color:#000000;
- font-weight:bold;
- background-color:#ddeeee;
- padding:3px;
- padding-left:10px
-}
-
-.border {
- border-bottom:1px solid #000000;
- border-left:1px dotted #666666;
- font-size:.9em;
-}
-
-.tableheader {
- font-size:.8em;
- font-weight:bold;
- background-color:#cccccc
-}
-
-.fviewheader {
- font-weight:bold;
- font-size:.8em;
- color:#ffffff;
- background-color:#999999
-}
-
-.fviewborder {
- border-bottom:1px solid #000000;
- border-left:1px dotted #666666;
- background-color:#dddddd;
- font-size:.9em;
-}
-
-.fviewon {
- background-color:#cccccc
-}
-
-.fviewoff {
- background-color:#ffffff
-}
-
-.fview {
- font-size:13px;
- font-family:arial,sans-serif;
- text-decoration:none;
- line-height:15px
-}
-
-.fviewbold {
- font-size:13px;
- font-family:arial,sans-serif;
- text-decoration:none;
- line-height:15px;
- font-weight:bold
-}
-
-.histView {
- border-bottom:1px solid #000000;
- border-left:2px solid #ffffff;
- background-color:#dddddd
-}
-
-.histViewMis {
- border-bottom:1px solid #000000;
- background-color:#ffdddd
-}
-
-div.NavMenu {
- width:18%;
- margin:0px;
- background-color:#ddeeee;
-}
-
-div.NavMenu a {
- font-size:.8em;
- display:block;
- margin-left:8px;
- padding:2px;
-}
-
-div.NavTitle {
- padding-left:10px;
- background-color:#99cc33;
- font-family:arial,sans-serif;
- color:#000000;
- font-weight:bold
-}
-
-#Content {
- float:right;
- width:80%;
- left:20%;
- top:10px;
- position:absolute;
-}
-</style>
-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';
projects / BackupPC.git / blobdiff