* Modified bin/BackupPC_dump to fix the case of a single partial
[BackupPC.git] / conf / config.pl
index a807a79..feed6bf 100644 (file)
@@ -136,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.
@@ -288,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}      = '';
@@ -888,6 +902,10 @@ $Conf{ClientCharset} = '';
 #
 $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.
@@ -987,6 +1005,10 @@ $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
@@ -1130,6 +1152,10 @@ $Conf{TarClientRestoreCmd} = '$sshPath -q -x -l root $host'
 #
 $Conf{TarClientPath} = '';
 
+###########################################################################
+# Rsync/Rsyncd Configuration
+# (can be overwritten in the per-PC log file)
+###########################################################################
 #
 # Path to rsync executable on the client
 #
@@ -1324,67 +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} = '';
+# 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'.
+#
+$Conf{FtpPort} = 21;
+
 #
-# This setting only matters if $Conf{XferMethod} = 'backuppcd'.
+# Connection timeout for FTP.  When undefined, the default is 120 seconds.
 #
-# 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.
+# This setting is used only if $Conf{XferMethod} = 'ftp'.
 #
-$Conf{BackupPCdRestoreCmd} = '$bpcdPath TODO';
+$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
 #
@@ -1880,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} = <<EOF;
 MIME-Version: 1.0
-Content-Type: text/plain; charset="iso-8859-1"
+Content-Type: text/plain; charset="utf-8"
 EOF
 
 ###########################################################################
@@ -2028,7 +2058,7 @@ $Conf{CgiHeaders} = '<meta http-equiv="pragma" content="no-cache">';
 # used by configure.pl when you upgrade BackupPC.
 #
 # Example:
-#     $Conf{CgiImageDir} = '/usr/local/apache/htdocs/BackupPC';
+#     $Conf{CgiImageDir} = '/var/www/htdocs/BackupPC';
 #
 $Conf{CgiImageDir} = '';
 
@@ -2128,6 +2158,12 @@ $Conf{CgiUserConfigEdit} = {
         RsyncClientCmd            => 0,
         RsyncClientRestoreCmd     => 0,
         RsyncClientPath           => 0,
+        FtpShareName              => 1,
+        FtpUserName               => 1,
+        FtpPasswd                 => 1,
+        FtpBlockSize              => 1,
+        FtpPort                   => 1,
+        FtpTimeout                => 1,
         ArchiveDest               => 1,
         ArchiveComp               => 1,
         ArchivePar                => 1,