Commit 3ee0618d197f6f00f7034a7ae3f93c81aabf59e6
1 parent
5f75f850
Exists in
master
and in
1 other branch
fixes #887 add heroku button
Showing
2 changed files
with
18 additions
and
23 deletions
Show diff stats
README.md
| 1 | -# 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] | |
| 1 | +# 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] [][heroku-deploy-url] | |
| 2 | 2 | |
| 3 | 3 | [travis-img-url]: https://travis-ci.org/errbit/errbit.svg?branch=master |
| 4 | 4 | [travis-ci-url]: http://travis-ci.org/errbit/errbit |
| ... | ... | @@ -8,6 +8,7 @@ |
| 8 | 8 | [coveralls-url]:https://coveralls.io/r/errbit/errbit |
| 9 | 9 | [gemnasium-img-url]:https://gemnasium.com/errbit/errbit.png |
| 10 | 10 | [gemnasium-url]:https://gemnasium.com/errbit/errbit |
| 11 | +[heroku-deploy-url]:https://heroku.com/deploy?template=https://github.com/errbit/errbit/tree/master | |
| 11 | 12 | |
| 12 | 13 | ### The open source, self-hosted error catcher |
| 13 | 14 | |
| ... | ... | @@ -48,18 +49,6 @@ Airbrake, you can just point the `airbrake` gem to your Errbit server. |
| 48 | 49 | </tr> |
| 49 | 50 | </table> |
| 50 | 51 | |
| 51 | -Errbit may be a good fit for you if: | |
| 52 | - | |
| 53 | -* Your exceptions may contain sensitive data that you don't want sitting on | |
| 54 | - someone else's server | |
| 55 | -* Your application is behind a firewall | |
| 56 | -* You'd like to brand your error catcher | |
| 57 | -* You want to add customer features to your error catcher | |
| 58 | -* You're crazy and love managing servers | |
| 59 | - | |
| 60 | -If this doesn't sound like you, you should probably stick with a hosted service such as | |
| 61 | -[Airbrake](http://airbrake.io). | |
| 62 | - | |
| 63 | 52 | Mailing List |
| 64 | 53 | ------------ |
| 65 | 54 | ... | ... |
docs/deployment/heroku.md
| 1 | 1 | # Deploy to Heroku |
| 2 | + | |
| 3 | +## The Easy Way | |
| 4 | + | |
| 5 | +If you just want to get started with Errbit and you're not sure how to proceed, | |
| 6 | +you can use this deploy button to get a basic deployment running on Heroku. | |
| 7 | + | |
| 8 | +[](https://heroku.com/deploy?template=https://github.com/errbit/errbit/tree/master) | |
| 9 | + | |
| 10 | +## The Hard Way | |
| 11 | + | |
| 2 | 12 | We designed Errbit to work well with Heroku. These instructions should result |
| 3 | 13 | in a working deploy, but you should modify them to suit your needs: |
| 4 | 14 | |
| 5 | -## Clone and prepare the source code repository | |
| 15 | +### Clone and prepare the source code repository | |
| 6 | 16 | ```bash |
| 7 | 17 | git clone git@github.com:errbit/errbit.git |
| 8 | 18 | cd errbit |
| ... | ... | @@ -15,10 +25,10 @@ Commit the results: |
| 15 | 25 | git commit -m "Update db/seeds.rb with initial login" |
| 16 | 26 | ``` |
| 17 | 27 | |
| 18 | -## Install the heroku toolbelt | |
| 28 | +### Install the heroku toolbelt | |
| 19 | 29 | [toolbelt.heroku.com](https://toolbelt.heroku.com/) |
| 20 | 30 | |
| 21 | -## Create an app on Heroku and push the source code | |
| 31 | +### Create an app on Heroku and push the source code | |
| 22 | 32 | ```bash |
| 23 | 33 | heroku apps:create |
| 24 | 34 | heroku addons:add mongolab:sandbox |
| ... | ... | @@ -30,13 +40,13 @@ heroku config:add ERRBIT_EMAIL_FROM=example@example.com |
| 30 | 40 | git push heroku master |
| 31 | 41 | ``` |
| 32 | 42 | |
| 33 | -## Prepare the DB | |
| 43 | +### Prepare the DB | |
| 34 | 44 | |
| 35 | 45 | ```bash |
| 36 | 46 | heroku run rake errbit:bootstrap |
| 37 | 47 | ``` |
| 38 | 48 | |
| 39 | -## Schedule recurring tasks | |
| 49 | +### Schedule recurring tasks | |
| 40 | 50 | You may want to periodically clear resolved errors to free up space. For that |
| 41 | 51 | you have a few options: |
| 42 | 52 | |
| ... | ... | @@ -65,11 +75,7 @@ Option 3. Clear resolved errors manually: |
| 65 | 75 | heroku run rake errbit:db:clear_resolved |
| 66 | 76 | ``` |
| 67 | 77 | |
| 68 | -## Add the deployment hook | |
| 78 | +### Add the deployment hook | |
| 69 | 79 | ```bash |
| 70 | 80 | heroku addons:add deployhooks:http --url="http://YOUR_ERRBIT_HOST/deploys.txt?api_key=YOUR_API_KEY" |
| 71 | 81 | ``` |
| 72 | - | |
| 73 | -## Or Just be lazy | |
| 74 | - | |
| 75 | -[](https://heroku.com/deploy?template=https://github.com/errbit/errbit/tree/master) | ... | ... |