Skip to content
Newer
Older
100644 120 lines (78 sloc) 3.88 KB
8453c65 @jdpace Add an intro paragraph about Errbit
jdpace authored Aug 20, 2010
1 Errbit: The open source self-hosted error catcher
2 =================================================
3
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
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
8453c65 @jdpace Add an intro paragraph about Errbit
jdpace authored Aug 20, 2010
6 already using Hoptoad.
7
8 Errbit may be a good fit for you if:
9
10 * Your exceptions may contain sensitive data that you don't want sitting on someone else's server
11 * Your application is behind a firewall
12 * You'd like to brand your error catcher
13 * You want to add customer features to your error catcher
14 * You're crazy and love managing servers
15
16 If this doesn't sound like you, you should probably stick with [Hoptoad](http://hoptoadapp.com).
17 The [Thoughtbot](http://thoughtbot.com) guys offer great support for it and it is much more worry-free.
18 They have a free package and even offer a *"Hoptoad behind your firewall"* solution.
1601584 @jdpace Add a stub Readme file
jdpace authored Aug 2, 2010
19
63cd8fe @jdpace WIP - Add Users backed by Devise
jdpace authored Aug 10, 2010
20 Installation
21 ------------
1601584 @jdpace Add a stub Readme file
jdpace authored Aug 3, 2010
22
c54cc32 @jdpace Add a deploy task and update the readme
jdpace authored Aug 14, 2010
23 *Note*: This app is intended for people with experience deploying and maintining
24 Rails applications. If you're uncomfortable with any step below then Errbit is not
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
25 for you. Checkout [Hoptoad](http://hoptoadapp.com) from the guys over at
8453c65 @jdpace Add an intro paragraph about Errbit
jdpace authored Aug 20, 2010
26 [Thoughtbot](http://thoughtbot.com), which Errbit is based on.
c54cc32 @jdpace Add a deploy task and update the readme
jdpace authored Aug 14, 2010
27
cccdfbd @jdpace Update Markdown formatting in the README
jdpace authored Aug 16, 2010
28 **Set your local box or server(Ubuntu):**
29
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
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
c54cc32 @jdpace Add a deploy task and update the readme
jdpace authored Aug 14, 2010
35 2. Install libxml
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
36
37 apt-get install libxml2 libxml2-dev libxslt-dev
38
c54cc32 @jdpace Add a deploy task and update the readme
jdpace authored Aug 14, 2010
39 3. Install Bundler
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
40
d55d2ed @oruen Bundler was released long time ago. Fixing readme.
oruen authored Jan 13, 2011
41 gem install bundler
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
42
cccdfbd @jdpace Update Markdown formatting in the README
jdpace authored Aug 16, 2010
43 **Running Locally:**
44
a43dcc0 @jdpace Add MIT License and update the readme
jdpace authored Aug 16, 2010
45 1. Bootstrap Errbit. This will copy over config.yml and also seed the database.
46
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
47 rake errbit:bootstrap
a43dcc0 @jdpace Add MIT License and update the readme
jdpace authored Aug 16, 2010
48
49 2. Update the config.yml and mongoid.yml files with information about your environment
50 3. Install dependencies
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
51
52 bundle install
53
a43dcc0 @jdpace Add MIT License and update the readme
jdpace authored Aug 16, 2010
54 4. Start Server
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
55
56 script/rails server
cccdfbd @jdpace Update Markdown formatting in the README
jdpace authored Aug 16, 2010
57
58 **Deploying:**
c54cc32 @jdpace Add a deploy task and update the readme
jdpace authored Aug 14, 2010
59
60 1. Bootstrap Errbit. This will copy over config.yml and also seed the database.
61
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
62 rake errbit:bootstrap
c54cc32 @jdpace Add a deploy task and update the readme
jdpace authored Aug 14, 2010
63
a43dcc0 @jdpace Add MIT License and update the readme
jdpace authored Aug 16, 2010
64 2. Update the deploy.rb file with information about your server
cccdfbd @jdpace Update Markdown formatting in the README
jdpace authored Aug 16, 2010
65 3. Setup server and deploy
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
66
67 cap deploy:setup deploy
3977fd2 @jdpace Add full management controls for users.
jdpace authored Aug 13, 2010
68
b365d9b Added instructions for super-easy Heroku deploy
Drew Blas authored Sep 3, 2010
69 **Deploying to Heroku:**
70
71 1. Clone the repository
72
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
73 git clone http://github.com/jdpace/errbit.git
b365d9b Added instructions for super-easy Heroku deploy
Drew Blas authored Sep 3, 2010
74
75 2. Create & configure for Heroku
76
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
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
b365d9b Added instructions for super-easy Heroku deploy
Drew Blas authored Sep 3, 2010
85
86 3. Seed the DB (_NOTE_: No bootstrap task is used on Heroku!)
87
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
88 heroku rake db:seed
b365d9b Added instructions for super-easy Heroku deploy
Drew Blas authored Sep 3, 2010
89
90 4. Enjoy!
91
3977fd2 @jdpace Add full management controls for users.
jdpace authored Aug 13, 2010
92 TODO
93 ----
94
cccdfbd @jdpace Update Markdown formatting in the README
jdpace authored Aug 16, 2010
95 * Add ability for watchers to be configured for types of notifications they should receive
a43dcc0 @jdpace Add MIT License and update the readme
jdpace authored Aug 16, 2010
96
37694d2 @jdpace Add a special thanks section to the Readme.
jdpace authored Aug 20, 2010
97 Special Thanks
98 --------------
99
100 * [Michael Parenteau](http://michaelparenteau.com) - For rocking the Errbit design and providing a great user experience.
9538c38 @jdpace Call out oruen as a core contributor
jdpace authored Mar 16, 2011
101 * [Nick Recobra aka oruen](https://github.com/oruen) - Nick is Errbit's first core contributor. He's been working hard at making Errbit more awesome.
37694d2 @jdpace Add a special thanks section to the Readme.
jdpace authored Aug 20, 2010
102 * [Relevance](http://thinkrelevance.com) - For giving me Open-source Fridays to work on Errbit and all my awesome co-workers for giving feedback and inspiration.
103 * [Thoughtbot](http://thoughtbot.com) - For being great open-source advocates and setting the bar with [Hoptoad](http://hoptoadapp.com).
104
a43dcc0 @jdpace Add MIT License and update the readme
jdpace authored Aug 16, 2010
105 Contributing
106 ------------
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored Mar 14, 2011
107
a43dcc0 @jdpace Add MIT License and update the readme
jdpace authored Aug 16, 2010
108 * Fork the project.
109 * Make your feature addition or bug fix.
110 * Add tests for it. This is important so I don't break it in a
111 future version unintentionally.
112 * Commit, do not mess with Rakefile, version, or history.
113 (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
114 * Send me a pull request. Bonus points for topic branches.
115
116 Copyright
117 ---------
118
119 Copyright (c) 2010 Jared Pace. See LICENSE for details.
Something went wrong with that request. Please try again.