Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

The open source error catcher that's Hoptoad API compliant

branch: big_brother

This branch is 10 commits ahead and 1588 commits behind master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 app
Octocat-spinner-32 autotest
Octocat-spinner-32 config
Octocat-spinner-32 db
Octocat-spinner-32 lib
Octocat-spinner-32 public
Octocat-spinner-32 script Initial Commit - Rails3 + RSpec2 + Haml + Mongoid August 02, 2010
Octocat-spinner-32 spec
Octocat-spinner-32 vendor removing vendor folder September 11, 2012
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .rspec Make rspec play nicer April 25, 2011
Octocat-spinner-32 Capfile Add a deploy task and update the readme August 14, 2010
Octocat-spinner-32 Gemfile
Octocat-spinner-32 Gemfile.lock
Octocat-spinner-32 LICENSE Add MIT License and update the readme August 16, 2010
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 config.ru Change some extra bits to Errbit August 07, 2010
README.md

Errbit: The open source self-hosted error catcher

Errbit is an open source, self-hosted error catcher. It is Hoptoad API compliant so you can just point the Hoptoad notifier at your Errbit server if you are already using Hoptoad.

Errbit may be a good fit for you if:

  • Your exceptions may contain sensitive data that you don't want sitting on someone else's server
  • Your application is behind a firewall
  • You'd like to brand your error catcher
  • You want to add customer features to your error catcher
  • You're crazy and love managing servers

If this doesn't sound like you, you should probably stick with Hoptoad. The Thoughtbot guys offer great support for it and it is much more worry-free. They have a free package and even offer a "Hoptoad behind your firewall" solution.

Installation

Note: This app is intended for people with experience deploying and maintining Rails applications. If you're uncomfortable with any step below then Errbit is not for you. Checkout Hoptoad from the guys over at Thoughtbot, which Errbit is based on.

Set your local box or server(Ubuntu):

  1. Install MongoDB. Follow the directions here, then:

     aptitude update
     aptitude install mongodb
    
  2. Install libxml

     apt-get install libxml2 libxml2-dev libxslt-dev
    
  3. Install Bundler

     gem install bundler
    

Running Locally:

  1. Bootstrap Errbit. This will copy over config.yml and also seed the database.

     rake errbit:bootstrap
    
  2. Update the config.yml and mongoid.yml files with information about your environment

  3. Install dependencies

     bundle install
    
  4. Start Server

     script/rails server
    

Deploying:

  1. Bootstrap Errbit. This will copy over config.yml and also seed the database.

     rake errbit:bootstrap
    
  2. Update the deploy.rb file with information about your server

  3. Setup server and deploy

     cap deploy:setup deploy
    

Deploying to Heroku:

  1. Clone the repository

     git clone http://github.com/jdpace/errbit.git
    
  2. Create & configure for Heroku

     gem install heroku
     heroku create
     heroku addons:add mongohq:free
     heroku addons:add sendgrid:free
     heroku config:add HEROKU=true
     heroku config:add ERRBIT_HOST=some-hostname.example.com
     heroku config:add ERRBIT_EMAIL_FROM=example@example.com
     git push heroku master
    
  3. Seed the DB (NOTE: No bootstrap task is used on Heroku!)

     heroku rake db:seed
    
  4. Enjoy!

Upgrading

Note: If upgrading from a version of Errbit that used Notices embedded in Errs please run:

     1. git pull origin master ( assuming origin is the github.com/jdpace/errbit repo )
     2. rake db:migrate

Lighthouseapp integration

Redmine integration

Pivotal Tracker integration

TODO

  • Add ability for watchers to be configured for types of notifications they should receive

Special Thanks

  • Michael Parenteau - For rocking the Errbit design and providing a great user experience.
  • Nick Recobra aka oruen - Nick is Errbit's first core contributor. He's been working hard at making Errbit more awesome.
  • Relevance - For giving me Open-source Fridays to work on Errbit and all my awesome co-workers for giving feedback and inspiration.
  • Thoughtbot - For being great open-source advocates and setting the bar with Hoptoad.

Contributing

  • 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 Jared Pace. See LICENSE for details.

Something went wrong with that request. Please try again.