= ExceptionGrowler Plugin for Rails= 

The ExceptionGrowler is a small plugin that hooks into ActionController::Rescue 
to send exception notifications (using Growl Network Notification Protocol) to one or more clients.


== Client software ==

Even though the Growl Network Notification Protocol was made for Growl,
it is currently supported by a bunch of tools. Therefore you can use ExceptionGrowler 
on Mac (of course with [http://growl.info Growl]), on Linux ([http://www.mumbles-project.org/ Mumbles])
and may be on Windows.


== Installation == 

ExceptionGrowler uses [http://segment7.net/projects/ruby/growl/ ruby-growl] for notification handling. 
The ruby-growl Library is available as a gem. Therefor simply run:

`sudo gem install ruby-growl`

After getting the library you're ready to install the plugin:
`script/plugin install http://rubyphunk.googlecode.com/svn/exception_growler`


== Usage ==

Simply include the ExceptionGrowler Module in your application.rb:

class ApplicationController < ActionController::Base
  include ExceptionGrowler


== Configuration ==

Configuration code goes to your environment.rb:

ExceptionGrowler.application_name = "plugin app"  # Give it a name
ExceptionGrowler.recipients do |r|
  r << {:host => "localhost", :password => "geheim", :environment => "production", :ignore_404 => true}
  r << {:host => "my.office.work.station"}
end

Beside `host` and `password` each recipient can get the following optional configuration parameters:

`:environment` || default: all || Notifications should only occur in this environment
`:ignore_404` || default: false || Tell ExceptionGrowler to ignore all routing errors


== Finish ==

Thats all. Your application will now send exception notifications to all configured clients..


Latest version and bug tracker:
http://rubyphunk.googlecode.com

Copyright (c) 2007 rubyphunk (rubyphunk@gmail.com), released under the MIT license