Commit d0bad87e92ae1c1d259f9a1cc05f75cb7f63e907
Committed by
Nick Recobra
1 parent
652b42f9
Exists in
master
and in
1 other branch
update README.md: trailing spaces & fix preformatted snippets
Showing
1 changed file
with
33 additions
and
34 deletions
Show diff stats
README.md
1 | 1 | Errbit: The open source self-hosted error catcher |
2 | 2 | ================================================= |
3 | 3 | |
4 | -Errbit is an open source, self-hosted error catcher. It is [Hoptoad](http://hoptoadapp.com) | |
5 | -API compliant so you can just point the Hoptoad notifier at your Errbit server if you are | |
4 | +Errbit is an open source, self-hosted error catcher. It is [Hoptoad](http://hoptoadapp.com) | |
5 | +API compliant so you can just point the Hoptoad notifier at your Errbit server if you are | |
6 | 6 | already using Hoptoad. |
7 | 7 | |
8 | 8 | Errbit may be a good fit for you if: |
... | ... | @@ -22,71 +22,70 @@ Installation |
22 | 22 | |
23 | 23 | *Note*: This app is intended for people with experience deploying and maintining |
24 | 24 | Rails applications. If you're uncomfortable with any step below then Errbit is not |
25 | -for you. Checkout [Hoptoad](http://hoptoadapp.com) from the guys over at | |
25 | +for you. Checkout [Hoptoad](http://hoptoadapp.com) from the guys over at | |
26 | 26 | [Thoughtbot](http://thoughtbot.com), which Errbit is based on. |
27 | 27 | |
28 | 28 | **Set your local box or server(Ubuntu):** |
29 | 29 | |
30 | - 1. Install MongoDB | |
31 | - * Follow the directions [here](http://www.mongodb.org/display/DOCS/Ubuntu+and+Debian+packages), then: | |
32 | - | |
33 | - aptitude update | |
34 | - aptitude install mongodb | |
35 | - | |
30 | + 1. Install MongoDB. Follow the directions [here](http://www.mongodb.org/display/DOCS/Ubuntu+and+Debian+packages), then: | |
31 | + | |
32 | + aptitude update | |
33 | + aptitude install mongodb | |
34 | + | |
36 | 35 | 2. Install libxml |
37 | - | |
38 | - apt-get install libxml2 libxml2-dev libxslt-dev | |
39 | - | |
36 | + | |
37 | + apt-get install libxml2 libxml2-dev libxslt-dev | |
38 | + | |
40 | 39 | 3. Install Bundler |
41 | - | |
40 | + | |
42 | 41 | gem install bundler |
43 | - | |
42 | + | |
44 | 43 | **Running Locally:** |
45 | 44 | |
46 | 45 | 1. Bootstrap Errbit. This will copy over config.yml and also seed the database. |
47 | 46 | |
48 | - rake errbit:bootstrap | |
47 | + rake errbit:bootstrap | |
49 | 48 | |
50 | 49 | 2. Update the config.yml and mongoid.yml files with information about your environment |
51 | 50 | 3. Install dependencies |
52 | - | |
53 | - bundle install | |
54 | - | |
51 | + | |
52 | + bundle install | |
53 | + | |
55 | 54 | 4. Start Server |
56 | - | |
57 | - script/rails server | |
55 | + | |
56 | + script/rails server | |
58 | 57 | |
59 | 58 | **Deploying:** |
60 | 59 | |
61 | 60 | 1. Bootstrap Errbit. This will copy over config.yml and also seed the database. |
62 | 61 | |
63 | - rake errbit:bootstrap | |
62 | + rake errbit:bootstrap | |
64 | 63 | |
65 | 64 | 2. Update the deploy.rb file with information about your server |
66 | 65 | 3. Setup server and deploy |
67 | - | |
68 | - cap deploy:setup deploy | |
66 | + | |
67 | + cap deploy:setup deploy | |
69 | 68 | |
70 | 69 | **Deploying to Heroku:** |
71 | 70 | |
72 | 71 | 1. Clone the repository |
73 | 72 | |
74 | - git clone http://github.com/jdpace/errbit.git | |
73 | + git clone http://github.com/jdpace/errbit.git | |
75 | 74 | |
76 | 75 | 2. Create & configure for Heroku |
77 | 76 | |
78 | - gem install heroku | |
79 | - heroku create | |
80 | - heroku addons:add mongohq:free | |
81 | - heroku addons:add sendgrid:free | |
82 | - heroku config:add HEROKU=true | |
83 | - heroku config:add ERRBIT_HOST=some-hostname.example.com | |
84 | - heroku config:add ERRBIT_EMAIL_FROM=example@example.com | |
85 | - git push heroku master | |
77 | + gem install heroku | |
78 | + heroku create | |
79 | + heroku addons:add mongohq:free | |
80 | + heroku addons:add sendgrid:free | |
81 | + heroku config:add HEROKU=true | |
82 | + heroku config:add ERRBIT_HOST=some-hostname.example.com | |
83 | + heroku config:add ERRBIT_EMAIL_FROM=example@example.com | |
84 | + git push heroku master | |
86 | 85 | |
87 | 86 | 3. Seed the DB (_NOTE_: No bootstrap task is used on Heroku!) |
88 | 87 | |
89 | - heroku rake db:seed | |
88 | + heroku rake db:seed | |
90 | 89 | |
91 | 90 | 4. Enjoy! |
92 | 91 | |
... | ... | @@ -104,7 +103,7 @@ Special Thanks |
104 | 103 | |
105 | 104 | Contributing |
106 | 105 | ------------ |
107 | - | |
106 | + | |
108 | 107 | * Fork the project. |
109 | 108 | * Make your feature addition or bug fix. |
110 | 109 | * Add tests for it. This is important so I don't break it in a | ... | ... |