/[BackupPC]/trunk/doc/BackupPC.html

This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!

Diff of /trunk/doc/BackupPC.html

Parent Directory | Revision Log | View Patch Patch

-revision 315 by dpavlin,
Wed Jun 22 19:12:42 2005 UTC
+revision 316 by dpavlin,
Mon Jan 30 13:37:17 2006 UTC
 Line 2
  <html xmlns="http://www.w3.org/1999/xhtml">
  <head>
  <title>BackupPC</title>
- <link rev="made" href="mailto:craig@atheros.com" />
+ <link rev="made" href="mailto:root@localhost" />
  </head>
  <body style="background-color: white">
 Line 104
  <p>
  </p>
  <h1><a name="backuppc_introduction">BackupPC Introduction</a></h1>
- <p>This documentation describes BackupPC version 2.1.0,
+ <p>This documentation describes BackupPC version 2.1.2,
- released on 20 Jun 2004.</p>
+ released on 5 Sep 2005.</p>
  <p>
  </p>
  <h2><a name="overview">Overview</a></h2>
 Line 403 
 BackupPC server data to tape.</p>
  <dd>
  <p>Various programs and scripts use rsync to provide hardlinked backups.
  See, for example, Mike Rubel's site (<a href="http://www.mikerubel.org/computers/rsync_snapshots">http://www.mikerubel.org/computers/rsync_snapshots</a>),
- JW Schultz's dirvish (<a href="http://www.pegasys.ws/dirvish">http://www.pegasys.ws/dirvish</a> (although as of
+ JW Schultz's dirvish (<a href="http://www.dirvish.org">http://www.dirvish.org</a>),
- June 2004 this link doesn't work)),
  Ben Escoto's rdiff-backup (<a href="http://rdiff-backup.stanford.edu">http://rdiff-backup.stanford.edu</a>),
  and John Bowman's rlbackup (<a href="http://www.math.ualberta.ca/imaging/rlbackup">http://www.math.ualberta.ca/imaging/rlbackup</a>).</p>
  </dd>
-Line 432 
 more and more people find it useful.  So
+Line 431 
 more and more people find it useful.  So
  appreciated, both positive and negative.</p>
  <p>Beyond being a satisfied user and telling other people about it, everyone
  is encouraged to add links to <a href="http://backuppc.sourceforge.net">http://backuppc.sourceforge.net</a>
- (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
-Line 627 
 then run these commands:</p>
+Line 626 
 then run these commands:</p>
      make install</pre>
  <p>The same sequence of commands can be used for each module.</p>
  <p>Now let's move onto BackupPC itself.  After fetching
- BackupPC-2.1.0.tar.gz, run these commands as root:</p>
+ BackupPC-2.1.2.tar.gz, run these commands as root:</p>
  <pre>
-     tar zxf BackupPC-2.1.0.tar.gz
+     tar zxf BackupPC-2.1.2.tar.gz
-     cd BackupPC-2.1.0
+     cd BackupPC-2.1.2
      perl configure.pl</pre>
  <p>In the future this release might also have patches available on the
  SourceForge site.  These patch files are text files, with a name of
  the form</p>
  <pre>
-     BackupPC-2.1.0plN.diff</pre>
+     BackupPC-2.1.2plN.diff</pre>
  <p>where N is the patch level, eg: pl5 is patch-level 5.  These
  patch files are cumulative: you only need apply the last patch
  file, not all the earlier patch files.  If a patch file is
- available, eg: BackupPC-2.1.0pl5.diff, you should apply
+ available, eg: BackupPC-2.1.2pl5.diff, you should apply
  the patch after extracting the tar file:</p>
  <pre>
-      # fetch BackupPC-2.1.0.tar.gz
+      # fetch BackupPC-2.1.2.tar.gz
-      # fetch BackupPC-2.1.0pl5.diff
+      # fetch BackupPC-2.1.2pl5.diff
-      tar zxf BackupPC-2.1.0.tar.gz
+      tar zxf BackupPC-2.1.2.tar.gz
-      cd BackupPC-2.1.0
+      cd BackupPC-2.1.2
-      patch -p0 &lt; ../BackupPC-2.1.0pl5.diff
+      patch -p0 &lt; ../BackupPC-2.1.2pl5.diff
       perl configure.pl</pre>
  <p>A patch file includes comments that describe that bug fixes
  and changes.  Feel free to review it before you apply the patch.</p>
-Line 717 
 directory.
+Line 716 
 directory.
  </p>
  <h2><a name="step_3__setting_up_config_pl">Step 3: Setting up config.pl</a></h2>
  <p>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.
-Line 1046 
 of SSH you have by typing ``ssh'' or ``m
+Line 1045 
 of SSH you have by typing ``ssh'' or ``m
  </dt>
  <dd>
  In general this should be similar to Linux/Unix machines.
- Mark Stosberg reports that you can also use hfstar.
+ Many users have reported success using xtar, which also
- See <a href="http://fink.sourceforge.net/pdb/package.php/hfstar">http://fink.sourceforge.net/pdb/package.php/hfstar</a>.
+ backs up the Mac OS X resource forks.
+ </dd>
+ <dd>
+ <p>Other choices include rsync and Mark Stosberg reports that you
+ can also use hfstar.
+ See <a href="http://fink.sourceforge.net/pdb/package.php/hfstar">http://fink.sourceforge.net/pdb/package.php/hfstar</a>.</p>
  </dd>
  <p></p>
  <dt><strong><a name="item_ssh_setup">SSH Setup</a></strong><br />
-Line 1638 
 status files to keep.</p>
+Line 1642 
 status files to keep.</p>
  <p>Note that for direct restore to work, the <a href="#item_%24conf%7bxfermethod%7d">$Conf{XferMethod}</A> 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 <a href="#item_%24conf%7bsmbclientrestorecmd%7d">$Conf{SmbClientRestoreCmd}</A>,
-Line 2109 
 is only run when there are no BackupPC_d
+Line 2113 
 is only run when there are no BackupPC_d
  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</p>
+ started.  If BackupPC_nightly takes too long to run, the settings
+ <a href="#item_%24conf%7bmaxbackuppcnightlyjobs%7d">$Conf{MaxBackupPCNightlyJobs}</A> and <a href="#item_%24conf%7bbackuppcnightlyperiod%7d">$Conf{BackupPCNightlyPeriod}</A> can
+ be used to run several BackupPC_nightly processes in parallel, and
+ to split its job over several nights.</p>
  <p></p></ol>
  <p>BackupPC also listens for TCP connections on <a href="#item_%24conf%7bserverport%7d">$Conf{ServerPort}</A>, which
  is used by the CGI script BackupPC_Admin for status reporting and
-Line 3752 
 this in the per-PC config.pl.
+Line 3759 
 this in the per-PC config.pl.
  </dd>
  <dd>
  <pre>
-   - 'rsyncd':  backup and restre via rsync daemon on the client.
+   - 'rsyncd':  backup and restore via rsync daemon on the client.
                 Best choice for linux/unix if you have rsyncd running on
                 the client.  Good choice also for WinXX.</pre>
  </dd>
-Line 4403 
 WAN or dialup connections the round-trip
+Line 4410 
 WAN or dialup connections the round-trip
  than 20msec.  Tune if necessary.
  </dd>
  <p></p>
- <dt><strong><a name="item_%24conf%7bclienttimeout%7d">$Conf{ClientTimeout} = 7200;</a></strong><br />
+ <dt><strong><a name="item_%24conf%7bclienttimeout%7d">$Conf{ClientTimeout} = 72000;</a></strong><br />
  </dt>
  <dd>
  Timeout in seconds when listening for the transport program's
-Line 4632 
 need to change the message, copy it here
+Line 4639 
 need to change the message, copy it here
    <a href="#item_%24conf%7bemailnobackupevermesg%7d">$Conf{EMailNoBackupEverMesg}</A> = &lt;&lt;'EOF';
    To: $user$domain
    cc:
-   Subject: $subj</pre>
+   Subject: $subj
- </dd>
+   $headers
- <dd>
- <pre>
    Dear $userName,</pre>
  </dd>
  <dd>
-Line 4670 
 need to change the message, copy it here
+Line 4675 
 need to change the message, copy it here
    <a href="#item_%24conf%7bemailnobackuprecentmesg%7d">$Conf{EMailNoBackupRecentMesg}</A> = &lt;&lt;'EOF';
    To: $user$domain
    cc:
-   Subject: $subj</pre>
+   Subject: $subj
- </dd>
+   $headers
- <dd>
- <pre>
    Dear $userName,</pre>
  </dd>
  <dd>
-Line 4708 
 need to change the message, copy it here
+Line 4711 
 need to change the message, copy it here
    <a href="#item_%24conf%7bemailoutlookbackupmesg%7d">$Conf{EMailOutlookBackupMesg}</A> = &lt;&lt;'EOF';
    To: $user$domain
    cc:
-   Subject: $subj</pre>
+   Subject: $subj
- </dd>
+   $headers
- <dd>
- <pre>
    Dear $userName,</pre>
  </dd>
  <dd>
-Line 4936 
 patch level.</p>
+Line 4937 
 patch level.</p>
  </p>
  <hr />
  <h1><a name="copyright">Copyright</a></h1>
- <p>Copyright (C) 2001-2004 Craig Barratt</p>
+ <p>Copyright (C) 2001-2005 Craig Barratt</p>
  <p>
  <a href="#__index__"><small>Back to Top</small></a>
  </p>

 Legend:



Removed from v.315
 


changed lines


 
Added in v.316
 Legend:



Removed from v.315
 


changed lines


 
Added in v.316
-Removed from v.315
+Added in v.316

	ViewVC Help
Powered by ViewVC 1.1.26