* Added multi-level incrementals. Still needs testing.

[BackupPC.git] / doc-src / BackupPC.pod

diff --git a/doc-src/BackupPC.pod b/doc-src/BackupPC.pod
index a780f9e..cc4175e 100644 (file)
--- a/doc-src/BackupPC.pod
+++ b/doc-src/BackupPC.pod
@@ -251,33 +251,34 @@ Do not send subscription requests to this address!
 =item Other Programs of Interest
 
 If you want to mirror linux or unix files or directories to a remote server
 =item Other Programs of Interest
 
 If you want to mirror linux or unix files or directories to a remote server

-you should consider rsync, L<http://rsync.samba.org>.  BackupPC now uses
+you should use rsync, L<http://rsync.samba.org>.  BackupPC now uses

 rsync as a transport mechanism; if you are already an rsync user you
 can think of BackupPC as adding efficient storage (compression and
 pooling) and a convenient user interface to rsync.
 
 Unison is a utility that can do two-way, interactive, synchronization.
 rsync as a transport mechanism; if you are already an rsync user you
 can think of BackupPC as adding efficient storage (compression and
 pooling) and a convenient user interface to rsync.
 
 Unison is a utility that can do two-way, interactive, synchronization.

-See L<http://www.cis.upenn.edu/~bcpierce/unison>.
+See L<http://freshmeat.net/projects/unison>.  An external wrapper around
+rsync that maintains transfer data to enable two-way synchronization is
+drsync; see L<http://freshmeat.net/projects/drsync>.

 
 

-Three popular open source packages that do tape backup are
-Amanda (L<http://www.amanda.org>),
-afbackup (L<http://sourceforge.net/projects/afbackup>), and
-Bacula (L<http://www.bacula.org>).
+Two popular open source packages that do tape backup are
+Amanda (L<http://www.amanda.org>)
+and Bacula (L<http://www.bacula.org>).

 Amanda can also backup WinXX machines to tape using samba.
 These packages can be used as back ends to BackupPC to backup the
 BackupPC server data to tape.
 
 Various programs and scripts use rsync to provide hardlinked backups.
 See, for example, Mike Rubel's site (L<http://www.mikerubel.org/computers/rsync_snapshots>),
 Amanda can also backup WinXX machines to tape using samba.
 These packages can be used as back ends to BackupPC to backup the
 BackupPC server data to tape.
 
 Various programs and scripts use rsync to provide hardlinked backups.
 See, for example, Mike Rubel's site (L<http://www.mikerubel.org/computers/rsync_snapshots>),

-JW Schultz's dirvish (L<http://www.pegasys.ws/dirvish> (although as of
-June 2004 this link doesn't work)),
+JW Schultz's dirvish (L<http://www.dirvish.org/>),

 Ben Escoto's rdiff-backup (L<http://rdiff-backup.stanford.edu>),
 and John Bowman's rlbackup (L<http://www.math.ualberta.ca/imaging/rlbackup>).
 
 BackupPC provides many additional features, such as compressed storage,
 hardlinking any matching files (rather than just files with the same name),
 and storing special files without root privileges.  But these other scripts
 Ben Escoto's rdiff-backup (L<http://rdiff-backup.stanford.edu>),
 and John Bowman's rlbackup (L<http://www.math.ualberta.ca/imaging/rlbackup>).
 
 BackupPC provides many additional features, such as compressed storage,
 hardlinking any matching files (rather than just files with the same name),
 and storing special files without root privileges.  But these other scripts

-provide simple and effective solutions and are worthy of consideration.
+provide simple and effective solutions and are definitely worthy of
+consideration.

 
 =back
 
 
 =back
 


@@ -300,7 +301,7 @@ appreciated, both positive and negative.
 
 Beyond being a satisfied user and telling other people about it, everyone
 is encouraged to add links to L<http://backuppc.sourceforge.net>
 
 Beyond being a satisfied user and telling other people about it, everyone
 is encouraged to add links to L<http://backuppc.sourceforge.net>

-(I'll see then via Google) or otherwise publicize BackupPC.  Unlike
+(I'll see them via Google) or otherwise publicize BackupPC.  Unlike

 the commercial products in this space, I have a zero budget (in both
 time and money) for marketing, PR and advertising, so it's up to
 all of you!  Feel free to vote for BackupPC at
 the commercial products in this space, I have a zero budget (in both
 time and money) for marketing, PR and advertising, so it's up to
 all of you!  Feel free to vote for BackupPC at


@@ -568,6 +569,17 @@ sure the BackupPC user's group is chosen restrictively.
 
 On this installation, this is __BACKUPPCUSER__.
 
 
 On this installation, this is __BACKUPPCUSER__.
 

+For security purposes you might choose to configre the BackupPC
+user with the shell set to /bin/false.  Since you might need to
+run some BackupPC programs as the BackupPC user for testing
+purposes, you can use the -s option to su to explicitly run
+a shell, eg:
+
+    su -s /bin/bash __BACKUPPCUSER__
+    
+Depending upon your configuration you might also need
+the -l option.
+

 =item Data Directory
 
 You need to decide where to put the data directory, below which
 =item Data Directory
 
 You need to decide where to put the data directory, below which


@@ -600,7 +612,7 @@ directory.
 =head2 Step 3: Setting up config.pl
 
 After running configure.pl, browse through the config file,
 =head2 Step 3: Setting up config.pl
 
 After running configure.pl, browse through the config file,

-__INSTALLDIR__/conf/config.pl, and make sure all the default settings
+__TOPDIR__/conf/config.pl, and make sure all the default settings

 are correct. In particular, you will need to decide whether to use
 smb, tar or rsync transport (or whether to set it on a per-PC basis)
 and set the relevant parameters for that transport method.
 are correct. In particular, you will need to decide whether to use
 smb, tar or rsync transport (or whether to set it on a per-PC basis)
 and set the relevant parameters for that transport method.


@@ -746,12 +758,25 @@ L<http://backuppc.sourceforge.net>.  This patch adds the --checksum-seed
 option for checksum caching, and also sends all errors to the client,
 which is important so BackupPC can log all file access errors.
 
 option for checksum caching, and also sends all errors to the client,
 which is important so BackupPC can log all file access errors.
 

-Otherwise, to use SMB, you need to create shares for the data you want
-to backup. Open "My Computer", right click on the drive (eg: C), and
+
+Otherwise, to use SMB, you can either create shares for the data you want
+to backup or your can use the existing C$ share.  To create a new 
+share, open "My Computer", right click on the drive (eg: C), and

 select "Sharing..." (or select "Properties" and select the "Sharing"
 tab). In this dialog box you can enable sharing, select the share name
 select "Sharing..." (or select "Properties" and select the "Sharing"
 tab). In this dialog box you can enable sharing, select the share name

-and permissions.  Many machines will be configured by default to share
-the entire C drive as C$ using the administrator password.
+and permissions.
+
+All Windows NT based OS (NT, 2000, XP Pro), are configured by default 
+to share the entire C drive as C$.  This is a special share used for 
+various administration functions, one of which is to grant access to backup 
+operators. All you need to do is create a new domain user, specifically 
+for backup. Then add the new backup user to the built in "Backup 
+Operators" group. You now have backup capability for any directory on 
+any computer in the domain in one easy step. This avoids using 
+administrator accounts and only grants permission to do exactly what you 
+want for the given user, i.e.: backup.
+Also, for additional security, you may wish to deny the ability for this 
+user to logon to computers in the default domain policy.

 
 If this machine uses DHCP you will also need to make sure the
 NetBios name is set.  Go to Control Panel|System|Network Identification
 
 If this machine uses DHCP you will also need to make sure the
 NetBios name is set.  Go to Control Panel|System|Network Identification


@@ -995,19 +1020,22 @@ it has started and all is ok.
 
 =head2 Step 7: Talking to BackupPC
 
 
 =head2 Step 7: Talking to BackupPC
 

-Note: as of version 1.5.0, BackupPC no longer supports telnet
-to its TCP port.  First off, a unix domain socket is used
-instead of a TCP port.  (The TCP port can still be re-enabled
-if your installation has apache and BackupPC running on different
-machines.)  Secondly, even if you still use the TCP port, the
-messages exchanged over this interface are now protected by
-an MD5 digest based on a shared secret (see $Conf{ServerMesgSecret})
-as well as sequence numbers and per-session unique keys, preventing
-forgery and replay attacks.
-

 You should verify that BackupPC is running by using BackupPC_serverMesg.
 This sends a message to BackupPC via the unix (or TCP) socket and prints
 You should verify that BackupPC is running by using BackupPC_serverMesg.
 This sends a message to BackupPC via the unix (or TCP) socket and prints

-the response.
+the response.  Like all BackupPC programs, BackupPC_serverMesg
+should be run as the BackupPC user (__BACKUPPCUSER__), so you
+should
+
+    su __BACKUPPCUSER__
+
+before running BackupPC_serverMesg.  If the BackupPC user is
+configured with /bin/false as the shell, you can use the -s
+option to su to explicitly run a shell, eg:
+
+    su -s /bin/bash __BACKUPPCUSER__
+    
+Depending upon your configuration you might also need
+the -l option.

 
 You can request status information and start and stop backups using this
 interface. This socket interface is mainly provided for the CGI interface
 
 You can request status information and start and stop backups using this
 interface. This socket interface is mainly provided for the CGI interface


@@ -1543,7 +1571,7 @@ status files to keep.
 Note that for direct restore to work, the $Conf{XferMethod} must
 be able to write to the client.  For example, that means an SMB
 share for smbclient needs to be writable, and the rsyncd module
 Note that for direct restore to work, the $Conf{XferMethod} must
 be able to write to the client.  For example, that means an SMB
 share for smbclient needs to be writable, and the rsyncd module

-needs "read only" set to "yes".  This creates additional security
+needs "read only" set to "false".  This creates additional security

 risks.  If you only create read-only SMB shares (which is a good
 idea), then the direct restore will fail.  You can disable the
 direct restore option by setting $Conf{SmbClientRestoreCmd},
 risks.  If you only create read-only SMB shares (which is a good
 idea), then the direct restore will fail.  You can disable the
 direct restore option by setting $Conf{SmbClientRestoreCmd},


@@ -1984,7 +2012,10 @@ is only run when there are no BackupPC_dump or BackupPC_link processes
 running.  Therefore, when it is time to run BackupPC_nightly, no new
 backups are started and BackupPC waits until all backups have finished.
 Then BackupPC_nightly is run, and until it finishes no new backups are
 running.  Therefore, when it is time to run BackupPC_nightly, no new
 backups are started and BackupPC waits until all backups have finished.
 Then BackupPC_nightly is run, and until it finishes no new backups are

-started.  If BackupPC_nightly is slow, the settings
+started.  If BackupPC_nightly takes too long to run, the settings
+$Conf{MaxBackupPCNightlyJobs} and $Conf{BackupPCNightlyPeriod} can
+be used to run several BackupPC_nightly processes in parallel, and
+to split its job over several nights.

 
 =back
 
 
 =back
 


@@ -2729,7 +2760,7 @@ See L<http://backuppc.sourceforge.net>.
 
 =head1 Copyright
 
 
 =head1 Copyright
 

-Copyright (C) 2001-2004 Craig Barratt
+Copyright (C) 2001-2005 Craig Barratt

 
 =head1 Credits
 
 
 =head1 Credits
 


@@ -2762,6 +2793,9 @@ Lorenzo Cappelletti provided the Italian translation, it.pm for v2.1.0.
 Lieven Bridts provided the Dutch translation, nl.pm, for v2.1.0,
 with some tweaks from Guus Houtzager.
 
 Lieven Bridts provided the Dutch translation, nl.pm, for v2.1.0,
 with some tweaks from Guus Houtzager.
 

+Reginaldo Ferreira provided the Portuguese Brazillian translation
+pt_br.pm for v2.2.0.
+

 Many people have reported bugs, made useful suggestions and helped
 with testing; see the ChangeLog and the mail lists.
 
 Many people have reported bugs, made useful suggestions and helped
 with testing; see the ChangeLog and the mail lists.