diff --git a/README.md b/README.md index c258351..d86203d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ 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 +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: @@ -22,71 +22,70 @@ 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 +for you. Checkout [Hoptoad](http://hoptoadapp.com) from the guys over at [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: - - aptitude update - aptitude install mongodb - + 1. Install MongoDB. Follow the directions [here](http://www.mongodb.org/display/DOCS/Ubuntu+and+Debian+packages), then: + + aptitude update + aptitude install mongodb + 2. Install libxml - - apt-get install libxml2 libxml2-dev libxslt-dev - + + 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 + rake errbit:bootstrap 2. Update the config.yml and mongoid.yml files with information about your environment 3. Install dependencies - - bundle install - + + bundle install + 4. Start Server - - script/rails server + + script/rails server **Deploying:** 1. Bootstrap Errbit. This will copy over config.yml and also seed the database. - rake errbit:bootstrap + rake errbit:bootstrap 2. Update the deploy.rb file with information about your server 3. Setup server and deploy - - cap deploy:setup deploy + + cap deploy:setup deploy **Deploying to Heroku:** 1. Clone the repository - git clone http://github.com/jdpace/errbit.git + 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 + 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 + heroku rake db:seed 4. Enjoy! @@ -104,7 +103,7 @@ Special Thanks 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 -- libgit2 0.21.2