ProjectlockerErrata on Heroku
==================

Send your application errors to our hosted service and reclaim your inbox.

1. Installing the Heroku add-on
----------------------------
To use ProjectlockerErrata on Heroku, install the ProjectlockerErrata add-on:

    $ heroku addons:add projectlocker_errata:basic # This adds the the basic plan.
                                       # If you'd like another plan, specify that instead.

2. Including the ProjectlockerErrata notifier in your application
--------------------------------------------------
After adding the ProjectlockerErrata add-on, you will need to install and configure the ProjectlockerErrata notifier.

Your application connects to ProjectlockerErrata with an API key. On Heroku, this is automatically provided to your
application in `ENV['HOPTOAD_API_KEY']`, so installation should be a snap! (Hoptoad is ProjectlockerErrata's old name.)

### Rails 3.x

Add the projectlocker_errata and heroku gems to your Gemfile.  In Gemfile:

    gem 'projectlocker_errata'
    gem 'heroku'

Then from your project's RAILS_ROOT, run:

    $ bundle install
    $ script/rails generate projectlocker_errata --heroku

### Rails 2.x

Install the heroku gem if you haven't already:

    gem install heroku

Add the projectlocker_errata gem to your app. In config/environment.rb:

    config.gem 'projectlocker_errata'

Then from your project's RAILS_ROOT, run:

    $ rake gems:install
    $ rake gems:unpack GEM=projectlocker_errata
    $ script/generate projectlocker_errata --heroku

As always, if you choose not to vendor the projectlocker_errata gem, make sure
every server you deploy to has the gem installed or your application won't start.

### Rack applications

In order to use projectlocker_errata in a non-Rails rack app, just load the projectlocker_errata, configure your API key, and use the ProjectlockerErrata::Rack middleware:

    require 'rubygems'
    require 'rack'
    require 'projectlocker_errata'

    ProjectlockerErrata.configure do |config|
      config.api_key = `ENV['HOPTOAD_API_KEY']`
    end

    app = Rack::Builder.app do
      use ProjectlockerErrata::Rack
      run lambda { |env| raise "Rack down" }
    end

### Rails 1.x

For Rails 1.x, visit the [ProjectlockerErrata notifier's README on GitHub](http://github.com/thoughtbot/projectlocker_errata),
and be sure to use `ENV['HOPTOAD_API_KEY']` where your API key is required in configuration code.

3. Configure your notification settings (important!)
---------------------------------------------------

Once you have included and configured the notifier in your application,
you will want to configure your notification settings.

This is important - without setting your email address, you won't receive notification emails.

ProjectlockerErrata can deliver exception notifications to your email inbox.  To configure these delivery settings:

1. Visit your applications resources page, like [ http://api.heroku.com/myapps/my-great-app/resources ](http://api.heroku.com/myapps/my-great-app/resources).
2. Click the name of your ProjectlockerErrata addon. (It may still be called Hoptoad.)
3. Click "Settings" to configure the Hoptoad Add-on.

4. Optionally: Set up deploy notification
-----------------------------------------

If your ProjectlockerErrata plan supports deploy notification, set it up for your Heroku application like this:

    rake projectlocker_errata:heroku:add_deploy_notification

This will install a Heroku [HTTP Deploy Hook](http://docs.heroku.com/deploy-hooks) to notify ProjectlockerErrata of the deploy.