Implement FTP backend and other code cleanups.

[cumulus.git] / README

diff --git a/README b/README
index 027ca61..82fed7d 100644 (file)
--- a/README
+++ b/README
@@ -6,6 +6,8 @@ How to Build
 Dependencies:
   - libuuid (sometimes part of e2fsprogs)
   - sqlite3
+  - boto, the python interface to Amazon's Web Services (for S3 storage)
+    http://code.google.com/p/boto
 
 Building should be a simple matter of running "make".  This will produce
 an executable called "cumulus".
@@ -136,11 +138,34 @@ should be restored (this directory should initially be empty).
 specified, the entire snapshot is restored.
 
 
+Remote Backups
+--------------
+
+The cumulus-util command can operate directly on remote backups.  The
+--store parameter accepts, in addition to a raw disk path, a URL.
+Supported URL forms are
+    file:///path        Equivalent to /path
+    s3://bucket/path    Storage in Amazon S3
+        (Expects the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
+        environment variables to be set appropriately)
+
+To copy backup snapshots from one storage area to another, the
+cumulus-sync command can be used, as in
+    $ cumulus-sync file:///cumulus s3://my-bucket/cumulus
+
+Support for directly writing backups to a remote location (without using
+a local staging directory and cumulus-sync) is slightly more
+experimental, but can be achieved by replacing
+    --dest=/cumulus
+with
+    --upload-script="cumulus-store s3://my-bucket/cumulus"
+
+
 Alternate Restore Tool
---------------------
+----------------------
 
 The contrib/restore.pl script is a simple program for restoring the
-contents of a Cumulus snapshot.  It is not as full-features as the
+contents of a Cumulus snapshot.  It is not as full-featured as the
 restore functionality in cumulus-util, but it is far more compact.  It
 could be stored with the backup files so a tool for restores is
 available even if all other data is lost.