From 8453c652fc421cb32cd33845f6c1c90f120b6b71 Mon Sep 17 00:00:00 2001 From: Jared Pace Date: Fri, 20 Aug 2010 10:21:57 -0400 Subject: [PATCH] Add an intro paragraph about Errbit --- README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 339df11..9a14089 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,21 @@ -Errbit: The open source self-hosted Hoptoad Server -===================================================== +Errbit: The open source self-hosted error catcher +================================================= + +Errbit is an open source, self-hosted error catcher. It is [Hoptoad](http://hoptoadapp.com) +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](http://hoptoadapp.com). +The [Thoughtbot](http://thoughtbot.com) 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 ------------ @@ -7,12 +23,12 @@ 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](http://hoptoadapp.com) from the guys over at -[Thoughbot](http://thoughtbot.com), which Errbit is based on. +[Thoughtbot](http://thoughtbot.com), which Errbit is based on. **Set your local box or server(Ubuntu):** 1. Install MongoDB - * Follow the directions [here](http://www.mongodb.org/display/DOCS/Ubuntu+and+Debian+packages) then: + * Follow the directions [here](http://www.mongodb.org/display/DOCS/Ubuntu+and+Debian+packages), then: aptitude update aptitude install mongodb -- libgit2 0.21.2