README.markdown in astrails-safe-0.2.6 vs README.markdown in astrails-safe-0.2.7

- old
+ new

@@ -1,9 +1,9 @@ astrails-safe ============= -Simple database and filesystem backups with S3 support (with optional encryption) +Simple database and filesystem backups with S3 and Rackspace Cloud Files support (with optional encryption) Home: http://blog.astrails.com/astrails-safe Motivation ---------- @@ -13,12 +13,12 @@ * 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 +* support for local filesystem, Amazon S3, and Rackspace Cloud Files for storage +* support for backup rotation. we don’t want backups filling all the diskspace or cost a fortune on S3 or Cloud Files And since we didn't find any, we wrote our own :) Contributions ------------- @@ -27,10 +27,14 @@ * PostgreSQL dump using pg_dump (by Mark Mansour <mark@stateofflux.com>) * Subversion dump using svndump (by Richard Luther <richard.luther@gmail.com>) * SFTP remote storage (by Adam <adam@mediadrive.ca>) * benchmarking output (By Neer) +* README fixes (by Bobby Wilson) +* improved config file parsing (by Fedor Kocherga <fkocherga@gmail.com>) +* mysql password file quoting (by Jonathan Sutherland <jonathan.sutherland@gmail.com>) +* Rackspace Cloud Files support (by H. Wade Minter <minter@lunenburg.org>) Thanks to all :) Installation ------------ @@ -49,21 +53,30 @@ 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 + -L, --local skip remote storage, only do local backups 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 +> IMPORTANT: some gpg installations automatically set 'use-agent' option in the default +> configuration file that is created when you run gpg for the first time. This will cause +> gpg to fail on the 2nd run if you don't have the agent running. The result is that +> 'astrails-safe' will work ONCE when you manually test it and then fail on any subsequent run. +> The solution is to remove the 'use-agent' from the config file (usually /root/.gnupg/gpg.conf) +> To mitigate this problem for the gpg 1.x series '--no-use-agent' option is added by defaults +> to the autogenerated config file, but for gpg2 is doesn't work. as the manpage says it: +> "This is dummy option. gpg2 always requires the agent." :( + 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. @@ -131,27 +144,39 @@ secret "........................................" bucket "backup.astrails.com" path "servers/alpha/:kind/:id" end + cloudfiles do + username "..........." + api_key "................................." + container "safe_backup" + path ":kind/" # this is default + service_net false + end + sftp do host "sftp.astrails.com" user "astrails" # port 8023 password "ssh password for sftp" end gpg do + command "/usr/local/bin/gpg" + options "--no-use-agent" # 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 20 - s3 30 + s3 100 + cloudfiles 100 + sftp 100 end mysqldump do options "-ceKq --single-transaction --create-options"