RubyGems - astrails-safe - Versions diffs - 0.1.3 → 0.1.4 - Mend

astrails-safe 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

data/README.markdown ADDED Viewed

@@ -0,0 +1,160 @@
+astrails-safe
+=============
+Simple mysql and filesystem backups with S3 support (with optional encryption)
+Motivation
+----------
+We needed a backup solution that will satisfy the following requirements:
+* opensource
+* simple to install and configure
+* support for simple ‘tar’ backups of directories (with includes/excludes)
+* support for simple mysqldump of mysql databases
+* support for symmetric or public key encryption
+* support for local filesystem and Amazon S3 for storage
+* support for backup rotation. we don’t want backups filling all the diskspace or cost a fortune on S3
+And since we didn't find any, we wrote our own :)
+Usage
+-----
+    Usage:
+       astrails-safe [OPTIONS] CONFIG_FILE
+    Options:
+      -h, --help           This help screen
+      -v, --verbose        be verbose, duh!
+      -n, --dry-run        just pretend, don't do anything.
+      -L, --local          skip S3
+Note: CONFIG_FILE will be created from template if missing
+Encryption
+----------
+If you want to encrypt your backups you have 2 options:
+* use simple password encryption
+* use GPG public key encryption
+For simple password, just add password entry in gpg section.
+For public key encryption you will need to create a public/secret keypair.
+We recommend to create your GPG keys only on your local machine and then
+transfer your public key to the server that will do the backups.
+This way the server will only know how to encrypt the backups but only you
+will be able to decrypt them using the secret key you have locally. Of course
+you MUST backup your backup encryption key :)
+We recommend also pringing the hard paper copy of your GPG key 'just in case'.
+The procedure to create and transfer the key is as follows:
+1. run 'gpg --gen-gen' on your local machine and follow onscreen instructions to create the key
+   (you can accept all the defaults).
+2. extract your public key into a file (assuming you used test@example.com as your key email):
+   gpg -a --export test@example.com > test@example.com.pub
+3. transfer public key to the server
+   scp backup@example.com root@example.com:
+4. import public key on the remote system:
+<pre>
+   $ gpg --import test@example.com.pub
+   gpg: key 45CA9403: public key "Test Backup <test@example.com>" imported
+   gpg: Total number processed: 1
+   gpg:               imported: 1
+</pre>
+5. since we don't keep the secret part of the key on the remote server, gpg has
+   no way to know its yours and can be trusted.
+   To fix that we can sign it with other trusted key, or just directly modify its
+   trust level in gpg (use level 5):
+<pre>
+   $ gpg --edit-key test@example.com
+   ...
+   Command> trust
+   ...
+   1 = I don't know or won't say
+   2 = I do NOT trust
+   3 = I trust marginally
+   4 = I trust fully
+   5 = I trust ultimately
+   m = back to the main menu
+   Your decision? 5
+   ...
+   Command> quit
+</pre>
+6. export your secret key for backup
+   (we recommend to print it on paper and burn to a CD/DVD and store in a safe place):
+   > gpg -a --export-secret-key test@example.com > test@example.com.key
+Example configuration
+---------------------
+<pre>
+  safe do
+    local :path => "/backup/:kind/:id"
+    s3 do
+      key "...................."
+      secret "........................................"
+      bucket "backup.astrails.com"
+      path "servers/alpha/:kind/:id"
+    end
+    gpg do
+      # symmetric encryption key
+      # password "qwe"
+      # public GPG key (must be known to GPG, i.e. be on the keyring)
+      key "backup@astrails.com"
+    end
+    keep do
+      local 2
+      s3 2
+    end
+    mysqldump do
+      options "-ceKq --single-transaction --create-options"
+      user "root"
+      password "............"
+      socket "/var/run/mysqld/mysqld.sock"
+      database :blog
+      database :servershape
+      database :astrails_com
+      database :secret_project_com
+    end
+    tar do
+      archive "git-repositories", :files => "/home/git/repositories"
+      archive "dot-configs",      :files => "/home/*/.[^.]*"
+      archive "etc",              :files => "/etc", :exclude => "/etc/puppet/other"
+      archive "blog-astrails-com" do
+        files "/var/www/blog.astrails.com/"
+        exclude ["/var/www/blog.astrails.com/log", "/var/www/blog.astrails.com/tmp"]
+      end
+      archive "astrails-com" do
+        files "/var/www/astrails.com/"
+        exclude ["/var/www/astrails.com/log", "/var/www/astrails.com/tmp"]
+      end
+    end
+  end
+</pre>
+Copyright
+---------
+Copyright (c) 2009 Astrails Ltd. See LICENSE for details.

data/VERSION.yml CHANGED Viewed

@@ -1,4 +1,4 @@
 ---
-:patch: 3
+:patch: 4
 :major: 0
 :minor: 1

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: astrails-safe
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Astrails Ltd.
@@ -30,10 +30,10 @@ extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.rdoc
+- README.markdown
 files:
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION.yml
 - bin/astrails-safe

data/README.rdoc DELETED Viewed

@@ -1,132 +0,0 @@
-= astrails-safe
-Simple mysql and filesystem backups with S3 support (with optional encryption)
-Usage:
-   astrails-safe [OPTIONS] CONFIG_FILE
-Options:
-  -h, --help           This help screen
-  -v, --verbose        be verbose, duh!
-  -n, --dry-run        just pretend, don't do anything.
-  -L, --local          skip S3
-Note: CONFIG_FILE will be created from template if missing
-If you want to encrypt your backups you have 2 options:
-* use simple password encryption
-* use GPG public key encryption
-For simple password, just add password entry in gpg section.
-For public key encryption you will need to create a public/secret keypair.
-We recommend to create your GPG keys only on your local machine and then
-transfer your public key to the server that will do the backups.
-This way the server will only know how to encrypt the backups but only you
-will be able to decrypt them using the secret key you have locally. Of course
-you MUST backup your backup encryption key :)
-We recommend also pringing the hard paper copy of your GPG key 'just in case'.
-The procedure to create and transfer the key is as follows:
-1. run 'gpg --gen-gen' on your local machine and follow onscreen instructions to create the key
-   (you can accept all the defaults).
-2. extract your public key into a file (assuming you used test@example.com as your key email):
-   gpg -a --export test@example.com > test@example.com.pub
-3. transfer public key to the server
-   scp backup@example.com root@example.com:
-4. import public key on the remote system:
-   $ gpg --import test@example.com.pub
-   gpg: key 45CA9403: public key "Test Backup <test@example.com>" imported
-   gpg: Total number processed: 1
-   gpg:               imported: 1
-5. since we don't keep the secret part of the key on the remote server, gpg has
-   no way to know its yours and can be trusted.
-   To fix that we can sign it with other trusted key, or just directly modify its
-   trust level in gpg (use level 5):
-   $ gpg --edit-key test@example.com
-   ...
-   Command> trust
-   ...
-   1 = I don't know or won't say
-   2 = I do NOT trust
-   3 = I trust marginally
-   4 = I trust fully
-   5 = I trust ultimately
-   m = back to the main menu
-   Your decision? 5
-   ...
-   Command> quit
-6. export your secret key for backup
-   (we recommend to print it on paper and burn to a CD/DVD and store in a safe place):
-   gpg -a --export-secret-key test@example.com > test@example.com.key
-Example configuration:
-safe do
-  local :path => "/backup/:kind/:id"
-  s3 do
-    key "...................."
-    secret "........................................"
-    bucket "backup.astrails.com"
-    path "servers/alpha/:kind/:id"
-  end
-  gpg do
-	# symmetric encryption key
-    # password "qwe"
-	# public GPG key (must be known to GPG, i.e. be on the keyring)
-	key "backup@astrails.com"
-  end
-  keep do
-    local 2
-    s3 2
-  end
-  mysqldump do
-    options "-ceKq --single-transaction --create-options"
-    user "root"
-    password "............"
-    socket "/var/run/mysqld/mysqld.sock"
-    database :blog
-	database :servershape
-	database :astrails_com
-	database :secret_project_com
-  end
-  tar do
-    archive "git-repositories", :files => "/home/git/repositories"
-    archive "dot-configs",      :files => "/home/*/.[^.]*"
-    archive "etc",              :files => "/etc", :exclude => "/etc/puppet/other"
-    archive "blog-astrails-com" do
-      files "/var/www/blog.astrails.com/"
-      exclude ["/var/www/blog.astrails.com/log", "/var/www/blog.astrails.com/tmp"]
-    end
-    archive "astrails-com" do
-      files "/var/www/astrails.com/"
-      exclude ["/var/www/astrails.com/log", "/var/www/astrails.com/tmp"]
-    end
-  end
-end
-== Copyright
-Copyright (c) 2009 Astrails Ltd. See LICENSE for details.