heroku_cloud_backup 0.0.2 → 0.0.3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Jack Chu
+Copyright (c) 2011 Jack Chu
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,79 @@
+# Heroku Cloud Backup
+
+The `heroku_cloud_backup` gem adds a rake task to your project that will take backups stored with Heroku's [PGBackup addon](http://devcenter.heroku.com/articles/pgbackups) and upload them to the cloud.
+
+## Installation
+
+It's recommended that you use this gem in conjunction with the [heroku_backup_task](https://github.com/joemsak/heroku_backup_task) gem. heroku_backup_task adds a rake tasks that will create a fresh database capture and expire the oldest backup if you're at your  capture limit.
+
+First, you need to enable the Heroku PGBackups addon:
+
+    heroku addons:add pgbackups:basic
+
+If you want this to run daily, you'll need to enable the Heroku cron addon:
+
+    heroku addons:add cron:daily
+
+For Rails 3.0 and later, add this to your Gemfile:
+
+    gem 'heroku_backup_task'
+    gem 'heroku_cloud_backup'
+
+For Rails 2.1 and later, add this to your in your environment.rb:
+
+    config.gem 'heroku_backup_task'
+    config.gem 'heroku_cloud_backup'
+
+In your Rakefile:
+
+    require "heroku_backup_task"
+    task :cron do
+      HerokuBackupTask.execute
+      HerokuCloudBackupTask.execute
+    end
+
+## Usage
+
+The first thing you'll want to do is configure the addon.
+
+HCB_PROVIDERS (aws, rackspace, google) - Add which providers you're using. Accepts a comma delimited value with each provider so you can store backups in more than 1 provider. **Required**
+
+    heroku config:add HCB_PROVIDERS='aws' # or 'aws, google, rackspace'
+
+HCB_BUCKET (Defaults to "[APP NAME]-heroku-backups") - Select a bucket name to upload to. This the bucket or root directory that your files will be stored in. **Optional**
+
+    heroku config:add HCB_BUCKET='mywebsite'
+
+HCB_PREFIX (Defaults to "db") - The direction prefix for where the backups are stored. This is so you can store your backups within a specific sub directory within the bucket. **Optional**
+
+    heroku config:add HCB_PREFIX='backups/pg'
+
+HCB_MAX_BACKUPS (Defaults to no limit) - The number of backups to store before the script will prune out older backups. A value of 10 will allow you to store 10 of the most recent backups. Newer backups will replace older ones. **Optional**
+
+    heroku config:add HCB_MAX_BACKUPS=10
+
+Depending on which providers you specify, you'll need to provide login credentials.
+
+Currently, only Amazon Web Services is supported.
+
+    heroku config:add HCB_AWS_ACCESS_KEY_ID="your_access_key"
+    heroku config:add HCB_AWS_SECRET_ACCESS_KEY="your_secret"
+
+You can run this manually like this:
+
+    rake heroku_backup
+    rake heroku:cloud_backup
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+### Copyright
+
+Copyright (c) 2011 Jack Chu. See LICENSE for details.

data/lib/heroku_cloud_backup/tasks.rb

@@ -2,7 +2,7 @@ require 'heroku_cloud_backup'
 
 namespace :heroku do
   desc "Example showing PostgreSQL database backups from Heroku to Amazon S3"
-  task :backup => :environment do
+  task :cloud_backup => :environment do
     HerokuCloudBackup.execute
   end
 end

data/lib/heroku_cloud_backup/version.rb

@@ -1,3 +1,3 @@
 module HerokuCloudBackup
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -2,7 +2,7 @@
 name: heroku_cloud_backup
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Jack Chu
@@ -47,7 +47,7 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - heroku_cloud_backup.gemspec
 - lib/heroku_cloud_backup.rb

data/README.rdoc

@@ -1,17 +0,0 @@
-= heroku_cloud_backup
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Jack Chu. See LICENSE for details.