1 files changed, 34 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..5f481cb
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+This module contains the general backup conventions and defintions used by the
+Sarava Group according to
+
+  http://padrao.sarava.org/trac/wiki/Backups/Convencoes
+
+It relies on Riseup Labs' Backupninja module,
+
+  https://labs.riseup.net/code/projects/show/module-backupninja
+
+What is basically do is to help the creation of standardized definitions for
+rdiff-backup and duplicity like these:
+
+  # local encrypted/signed backup
+  backup::duplicity { "localhost":
+    encryptkey => "$key_id",
+    password   => "$key_password",
+  }
+
+  # remote backup of previously encrypted/signed backup
+  backup::rdiff { "$node_name":
+    port => "$port",
+  }
+
+The first definition will keep local encrypted/signed backups using duplicity
+at /var/backups/duplicity.
+
+The second definition will push the local /var/backups/duplicity to a remote
+destination using rdiff-backup over ssh.
+
+We choose this two stage approach as the experience showed that it's more
+reliable and fast than to let duplicity do all the job.
+
+Note that this is a simple module that don't manages backup users or keys by
+itself: you should do that manually or use another puppet module.