# Craig Barratt <cbarratt@users.sourceforge.net>
#
# COPYRIGHT
-# Copyright (C) 2001-2003 Craig Barratt
+# Copyright (C) 2001-2007 Craig Barratt
#
# See http://backuppc.sourceforge.net.
#
# 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
# 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
# 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:
# $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.
# . ' $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} = '';
# 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';
# 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';
#
$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.
#
# This setting only matters if $Conf{XferMethod} = 'smb'.
#
-$Conf{SmbClientPath} = '/usr/bin/smbclient';
+$Conf{SmbClientPath} = '';
#
# Command to run smbclient for a full dump.
# $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';
#
# 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';
# 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
#
# 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';
# $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+';
#
# 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
#
# 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+';
#
#
# 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
'--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',
'--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',
#
];
+###########################################################################
+# FTP Configuration
+# (can be overwritten in the per-PC log file)
+##########################################################################
+#
+# 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:
+#
+# $Conf{FtpShareName} = 'c'; # backup 'c' share
+# $Conf{FtpShareName} = ['c', 'd']; # backup 'c' and 'd' shares
+#
+# This setting only matters if $Conf{XferMethod} = 'ftp'.
+#
+$Conf{FtpShareName} = '';
+
+#
+# FTP user name. This is used to log into the server.
+#
+# This setting is used only if $Conf{XferMethod} = 'ftp'.
+#
+$Conf{FtpUserName} = '';
+
+#
+# FTP user password. This is used to log into the server.
+#
+# This setting is used only if $Conf{XferMethod} = 'ftp'.
+#
+$Conf{FtpPasswd} = '';
+
+#
+# Transfer block size. This sets the size of the amounts of data in
+# each frame. While undefined, this value takes the default value.
+#
+# 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'.
+#
+$Conf{FtpPort} = 21;
+
+#
+# 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;
+
+
+###########################################################################
+# BackupPCd 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'.
#
# 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
#
# 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';
-
+###########################################################################
+# Archive Configuration
+# (can be overwritten in the per-PC log file)
+###########################################################################
#
# Archive Destination
#
# $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 *';
# 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
# 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
# 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';
#
# 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';
#
#
# $Conf{PingPath} = '/bin/echo';
#
-$Conf{PingPath} = '/bin/ping';
+$Conf{PingPath} = '';
#
# Ping command. The following variables are substituted at run-time:
# 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';
#
# $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;
# 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.
#
# Language to use. See lib/BackupPC/Lang for the list of supported
# languages, which include English (en), French (fr), Spanish (es),
-# German (de), Italian (it), Dutch (nl) and Portuguese Brazillian
-# (pt_br).
+# German (de), Italian (it), Dutch (nl), Polish (pl), Portuguese
+# Brazillian (pt_br) and Chinese (zh_CH).
#
# Currently the Language setting applies to the CGI interface and email
# messages sent to users. Log files and other text are still in English.
$Conf{CgiUserUrlCreate} = 'mailto:%s';
#
-# Date display format for CGI interface. True for US-style dates (MM/DD)
-# and zero for international dates (DD/MM).
+# Date display format for CGI interface. A value of 1 uses US-style
+# dates (MM/DD), a value of 2 uses full YYYY-MM-DD format, and zero
+# for international dates (DD/MM).
#
$Conf{CgiDateFormatMMDD} = 1;
lname => "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",
Reason_no_ping => '#ffff99',
Reason_backup_canceled_by_user => '#ff9900',
Status_backup_in_progress => '#66cc99',
+ Disabled_OnlyManualBackups => '#d1d1d1',
+ Disabled_AllBackupsDisabled => '#d1d1d1',
};
#
$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';
#
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,
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,
+ BackupPCdPath => 1,
+ BackupPCdShareName => 1,
+ BackupPCdCmd => 1,
+ BackupPCdRestoreCmd => 1,
ArchiveDest => 1,
ArchiveComp => 1,
ArchivePar => 1,
projects / BackupPC.git / blobdiff