backup-gundua

h1. Backup

h2. A Backup Ruby Gem

Backup is a Ruby Gem written for Unix and Rails environments. It can be used both with and without the Ruby on Rails framework! This gem offers a quick and simple solution to backing up databases such as MySQL/PostgreSQL and Files/Folders. All backups can be transferred to Amazon S3 or any remote server you have access to, using either SCP, SFTP or regular FTP. Backup handles Compression, Archiving, Encryption, Backup Cleaning (Cycling) and supports Email Notifications.

h2. Authors/Maintainers

• "Meskyanichi - Michael van Rooijen":http://github.com/meskyanichi
• "Fernandoluizao - Fernando Migliorini Luizão":http://github.com/fernandoluizao

h2. Backup's Current Capabilities

h3. Storage Methods

• Amazon S3
• Remote Server (Available Protocols: SCP, SFTP, FTP)
• Local server (Example Locations: Another Hard Drive, Network path) (coming in the next gem release)

h3. Adapters

• MySQL
• SQLite (in the next gem release)
• PostgreSQL
• Archive (Any files and/or folders)
• Custom (Anything you can produce using the command line)

h3. Archiving

Handles archiving for the Archive and Custom adapters.

h3. Encryption

Handles encryption of all backups for any adapter. To decrypt a "Backup encrypted file" you can use Backup's built-in utility command:

bc. sudo backup --decrypt /path/to/encrypted/file.enc

h3. Backup Cleaning

With Backup you can very easily specify how many backups you would like to have stored (per backup procedure!) on your Amazon S3, Remote or Local server. When the limit you specify gets exceeded, the oldest backup will automatically be cleaned up.

h3. Email Notifications

You will be able to specify whether you would like to be notified by email when a backup successfully been stored. Simply fill in the email configuration block and set "notify" to true inside the backup procedure you would like to be notified of.

h3. Quick Example of a Single Backup Setting/Procedure inside the Backup Configuration File

bc. backup 'mysql-backup-s3' do adapter :mysql do user 'user' password 'password' database 'database' end storage :s3 do access_key_id 'access_key_id' secret_access_key 'secret_access_key' bucket '/bucket/backups/mysql/' use_ssl true end keep_backups 25 encrypt_with_password 'my_password' notify true end

Everything above should be pretty straightforward, so now, using the "trigger" we specified between the backup and do you can execute this backup procedure like so:

Rails Environment

bc. rake backup:run trigger=mysql-backup-s3

Unix Environment

bc. sudo backup --run mysql-backup-s3

That's it. This was a simple example of how it works.

h2. Interested in trying out Backup?

h3. Getting started with Backup for the Unix Environment

"http://wiki.github.com/meskyanichi/backup/getting-started-unix":http://wiki.github.com/meskyanichi/backup/getting-started-unix

h3. Getting started with Backup for the Rails Environment

"http://wiki.github.com/meskyanichi/backup/getting-started-ruby-on-rails":http://wiki.github.com/meskyanichi/backup/getting-started-ruby-on-rails

h3. Production Mode RAILS_ENV

"http://wiki.github.com/meskyanichi/backup/production-mode":http://wiki.github.com/meskyanichi/backup/production-mode

h3. Encrypting and Decrypting

"http://wiki.github.com/meskyanichi/backup/encrypting-and-decrypting":http://wiki.github.com/meskyanichi/backup/encrypting-and-decrypting

h3. Backup Configuration File (All Adapters, Storage Methods, Mail Settings and Options)

"http://wiki.github.com/meskyanichi/backup/configuration-file":http://wiki.github.com/meskyanichi/backup/configuration-file

h3. Unix Utility Commands and Rails Rake Tasks

"http://wiki.github.com/meskyanichi/backup/utility-commands":http://wiki.github.com/meskyanichi/backup/utility-commands

"http://wiki.github.com/meskyanichi/backup/rake-tasks":http://wiki.github.com/meskyanichi/backup/rake-tasks

h3. Automatic Backups

"http://wiki.github.com/meskyanichi/backup/automatic-backups":http://wiki.github.com/meskyanichi/backup/automatic-backups

h3. Capistrano Recipes

"http://wiki.github.com/meskyanichi/backup/capistrano-recipes":http://wiki.github.com/meskyanichi/backup/capistrano-recipes

h3. Capistrano, Whenever!

"http://wiki.github.com/meskyanichi/backup/capistrano-whenever":http://wiki.github.com/meskyanichi/backup/capistrano-whenever

h3. Understanding "The Backup Database"

"http://wiki.github.com/meskyanichi/backup/the-backup-database":http://wiki.github.com/meskyanichi/backup/the-backup-database

h3. Trouble Shooting

"http://wiki.github.com/meskyanichi/backup/troubleshooting":http://wiki.github.com/meskyanichi/backup/troubleshooting

h3. Requirements

"http://wiki.github.com/meskyanichi/backup/requirements":http://wiki.github.com/meskyanichi/backup/requirements

h3. Resources

"http://wiki.github.com/meskyanichi/backup/resources":http://wiki.github.com/meskyanichi/backup/resources

h3. Requests

If anyone has any requests, please send us a message or post it on the issues page!

h3. Suggestions?

Send us a message! Fork the project!

h3. Found a Bug?

"http://github.com/meskyanichi/backup/issues":http://github.com/meskyanichi/backup/issues

h3. Contributors

List of people that forked and added stuff!

• "dtrueman":http://github.com/dtrueman

Michael van Rooijen | Final Creation. ("http://final-creation.com":http://final-creation.com)