diff --git a/README.md b/README.md index fa6ad0b..dd49e58 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Errbit [![TravisCI][travis-img-url]][travis-ci-url] [![Code Climate][codeclimate-img-url]][codeclimate-url] [![Coveralls][coveralls-img-url]][coveralls-url] [![Dependency Status][gemnasium-img-url]][gemnasium-url] +# Errbit [![TravisCI][travis-img-url]][travis-ci-url] [![Code Climate][codeclimate-img-url]][codeclimate-url] [![Coveralls][coveralls-img-url]][coveralls-url] [![Dependency Status][gemnasium-img-url]][gemnasium-url] [![Deploy](https://www.herokucdn.com/deploy/button.svg)][heroku-deploy-url] [travis-img-url]: https://travis-ci.org/errbit/errbit.svg?branch=master [travis-ci-url]: http://travis-ci.org/errbit/errbit @@ -8,6 +8,7 @@ [coveralls-url]:https://coveralls.io/r/errbit/errbit [gemnasium-img-url]:https://gemnasium.com/errbit/errbit.png [gemnasium-url]:https://gemnasium.com/errbit/errbit +[heroku-deploy-url]:https://heroku.com/deploy?template=https://github.com/errbit/errbit/tree/master ### The open source, self-hosted error catcher @@ -48,18 +49,6 @@ Airbrake, you can just point the `airbrake` gem to your Errbit server. -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 a hosted service such as -[Airbrake](http://airbrake.io). - Mailing List ------------ diff --git a/docs/deployment/heroku.md b/docs/deployment/heroku.md index 60444ff..bbfeafe 100644 --- a/docs/deployment/heroku.md +++ b/docs/deployment/heroku.md @@ -1,8 +1,18 @@ # Deploy to Heroku + +## The Easy Way + +If you just want to get started with Errbit and you're not sure how to proceed, +you can use this deploy button to get a basic deployment running on Heroku. + +[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/errbit/errbit/tree/master) + +## The Hard Way + We designed Errbit to work well with Heroku. These instructions should result in a working deploy, but you should modify them to suit your needs: -## Clone and prepare the source code repository +### Clone and prepare the source code repository ```bash git clone git@github.com:errbit/errbit.git cd errbit @@ -15,10 +25,10 @@ Commit the results: git commit -m "Update db/seeds.rb with initial login" ``` -## Install the heroku toolbelt +### Install the heroku toolbelt [toolbelt.heroku.com](https://toolbelt.heroku.com/) -## Create an app on Heroku and push the source code +### Create an app on Heroku and push the source code ```bash heroku apps:create heroku addons:add mongolab:sandbox @@ -30,13 +40,13 @@ heroku config:add ERRBIT_EMAIL_FROM=example@example.com git push heroku master ``` -## Prepare the DB +### Prepare the DB ```bash heroku run rake errbit:bootstrap ``` -## Schedule recurring tasks +### Schedule recurring tasks You may want to periodically clear resolved errors to free up space. For that you have a few options: @@ -65,11 +75,7 @@ Option 3. Clear resolved errors manually: heroku run rake errbit:db:clear_resolved ``` -## Add the deployment hook +### Add the deployment hook ```bash heroku addons:add deployhooks:http --url="http://YOUR_ERRBIT_HOST/deploys.txt?api_key=YOUR_API_KEY" ``` - -## Or Just be lazy - -[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/errbit/errbit/tree/master) -- libgit2 0.21.2