SF.net SVN: safekeep: [383] website/trunk/WebContent/documentation.shtml

[<di...@us...>]

Revision: 383
          http://safekeep.svn.sourceforge.net/safekeep/?rev=383&view=rev
Author:   dimi
Date:     2007-02-04 21:10:49 -0800 (Sun, 04 Feb 2007)

Log Message:
-----------
Write up the documentation page.

Modified Paths:
--------------
    website/trunk/WebContent/documentation.shtml

Modified: website/trunk/WebContent/documentation.shtml
===================================================================
--- website/trunk/WebContent/documentation.shtml	2007-02-05 01:55:39 UTC (rev 382)
+++ website/trunk/WebContent/documentation.shtml	2007-02-05 05:10:49 UTC (rev 383)
@@ -11,20 +11,83 @@
 <a name="docs"></a>
 <h2>Documentation</h2>
 <p>
-Please note that this section is a works-in-progress. 
-We hope to have them available in the next little while.
+SafeKeep comes with manual pages for the application,
+and the configuration file:
 </p>
 <ul>
   <li><a href="safekeep.html">safekeep(1) man page</a></li>
   <li><a href="safekeep.conf.html">safekeep.conf(5) man page</a></li>
-  <!--li><a href="safekeep-tips.shtml">SafeKeep Tips</a></li-->
 </ul>
 
 <a name="ex"></a>
 <h2>Quick Example</h2>
 <p>
-TODO
+This example will walk you through the setup of SafeKeep
+to backup a small LAN comprised of two workstations
+called <tt>oak</tt> and <tt>pine</tt>, onto a server
+named <tt>forrest</tt>. For simplicity's sake, we will
+assume that: 
 </p>
+<ul>
+  <li> we are interested in backing up only the user's personal data; </li>
+  <li> there is a lot of music (MP3s) that we don not care about; </li>
+  <li> we are using LVM everywhere, and we want to use it for snapshots; </li>
+  <li> boxes run a RedHat-based distribution, such as Fedora. </li>
+</ul>
 
+<p>
+First we need to get SafeKeep installed on all the boxes:
+</p>
+<pre>
+[root@oak ~] rpm -Uvh safekeep-{common,client}-*.noarch.rpm
+[root@pine ~] rpm -Uvh safekeep-{common,client}-*.noarch.rpm
+[root@forrest ~] rpm -Uvh safekeep-{common,server}-*.noarch.rpm
+</pre>
 
+<p>
+This is all we have to do on the clients. The next steps will
+happen on the server side (on <tt>forrest</tt> in our case).
+</p>
+<p>
+Next, we need to create a file for each of the boxes we need to backup:
+</p>
+<pre>
+[root@forrest ~] cat /etc/safekeep.d/oak.conf
+&lt;backup&gt;
+  &lt;host name="oak" /&gt;
+  &lt;setup&gt;
+      &lt;snapshot device="/dev/mapper/VolGroup00-LogVol00" size="500M" /&gt;
+  &lt;/setup&gt;
+
+  &lt;data&gt;
+    &lt;exclude regexp=".*\.mp3"/&gt;
+    &lt;include path="/home"/&gt;
+  &lt;/data&gt;
+&lt;/backup&gt;
+
+[root@forrest ~] cat /etc/safekeep.d/pine.conf
+&lt;backup&gt;
+  &lt;host name="pine" /&gt;
+  &lt;setup&gt;
+      &lt;snapshot device="/dev/mapper/VolGroup00-LogVol00" size="500M" /&gt;
+  &lt;/setup&gt;
+
+  &lt;data&gt;
+    &lt;exclude regexp=".*\.mp3"/&gt;
+    &lt;include path="/home"/&gt;
+  &lt;/data&gt;
+&lt;/backup&gt;
+</pre>
+
+<p>
+Now all we have to do is tell SafeKeep to deploy the SSH keys:
+</p>
+<pre>
+[root@forrest ~] sudo -H -u safekeep safekeep --keys --deploy
+</pre>
+
+<p>
+Done! The server RPM has already installed a cron job that will
+run once a day and thus backup the workstations daily.
+</p>
 <!--#include virtual="footer.shtml" -->


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.