Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 147 lines (97 sloc) 5.609 kb
8453c65 @jdpace Add an intro paragraph about Errbit
jdpace authored
1 Errbit: The open source self-hosted error catcher
2 =================================================
3
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored
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
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
19
63cd8fe @jdpace WIP - Add Users backed by Devise
jdpace authored
20 Installation
21 ------------
1601584 @jdpace Add a stub Readme file
jdpace authored
22
c54cc32 @jdpace Add a deploy task and update the readme
jdpace authored
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
25 for you. Checkout [Hoptoad](http://hoptoadapp.com) from the guys over at
8453c65 @jdpace Add an intro paragraph about Errbit
jdpace authored
26 [Thoughtbot](http://thoughtbot.com), which Errbit is based on.
c54cc32 @jdpace Add a deploy task and update the readme
jdpace authored
27
cccdfbd @jdpace Update Markdown formatting in the README
jdpace authored
28 **Set your local box or server(Ubuntu):**
29
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored
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
35 2. Install libxml
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored
36
37 apt-get install libxml2 libxml2-dev libxslt-dev
38
c54cc32 @jdpace Add a deploy task and update the readme
jdpace authored
39 3. Install Bundler
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored
40
d55d2ed @oruen Bundler was released long time ago. Fixing readme.
oruen authored
41 gem install bundler
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored
42
cccdfbd @jdpace Update Markdown formatting in the README
jdpace authored
43 **Running Locally:**
44
a43dcc0 @jdpace Add MIT License and update the readme
jdpace authored
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
47 rake errbit:bootstrap
a43dcc0 @jdpace Add MIT License and update the readme
jdpace authored
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
51
52 bundle install
53
a43dcc0 @jdpace Add MIT License and update the readme
jdpace authored
54 4. Start Server
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored
55
56 script/rails server
cccdfbd @jdpace Update Markdown formatting in the README
jdpace authored
57
58 **Deploying:**
c54cc32 @jdpace Add a deploy task and update the readme
jdpace authored
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
62 rake errbit:bootstrap
c54cc32 @jdpace Add a deploy task and update the readme
jdpace authored
63
a43dcc0 @jdpace Add MIT License and update the readme
jdpace authored
64 2. Update the deploy.rb file with information about your server
cccdfbd @jdpace Update Markdown formatting in the README
jdpace authored
65 3. Setup server and deploy
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored
66
67 cap deploy:setup deploy
3977fd2 @jdpace Add full management controls for users.
jdpace authored
68
b365d9b Added instructions for super-easy Heroku deploy
Drew Blas authored
69 **Deploying to Heroku:**
70
71 1. Clone the repository
72
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored
73 git clone http://github.com/jdpace/errbit.git
b365d9b Added instructions for super-easy Heroku deploy
Drew Blas authored
74
75 2. Create & configure for Heroku
76
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored
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
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
88 heroku rake db:seed
b365d9b Added instructions for super-easy Heroku deploy
Drew Blas authored
89
90 4. Enjoy!
91
40453cc moved Notices to a separate collection
Karol Hosiawa authored
92 Upgrading
93 ---------
94 *Note*: If upgrading from a version of Errbit that used Notices embedded in Errs please run:
95
96 1. git pull origin master ( assuming origin is the github.com/jdpace/errbit repo )
97 2. rake db:migrate
98
35880a5 @oruen Lighthouseapp tracker model.
oruen authored
99 Lighthouseapp integration
100 -------------------------
101
40453cc moved Notices to a separate collection
Karol Hosiawa authored
102 * Account is the name of your subdomain, i.e. **litcafe** for project at http://litcafe.lighthouseapp.com/projects/73466-face/overview
3960fb5 @oruen Link to lighthouse knowledge base.
oruen authored
103 * Errbit uses token-based authentication. Get your API Token or visit [http://help.lighthouseapp.com/kb/api/how-do-i-get-an-api-token](http://help.lighthouseapp.com/kb/api/how-do-i-get-an-api-token) to learn how to get it.
dd383c8 @oruen Note on Redmine integration.
oruen authored
104 * Project id is number identifier of your project, i.e. **73466** for project at http://litcafe.lighthouseapp.com/projects/73466-face/overview
105
106 Redmine integration
107 -------------------------
108
40453cc moved Notices to a separate collection
Karol Hosiawa authored
109 * Account is the host of your redmine installation, i.e. **http://redmine.org**
dd383c8 @oruen Note on Redmine integration.
oruen authored
110 * Errbit uses token-based authentication. Get your API Key or visit [http://www.redmine.org/projects/redmine/wiki/Rest_api#Authentication](http://www.redmine.org/projects/redmine/wiki/Rest_api#Authentication) to learn how to get it.
111 * Project id is an identifier of your project, i.e. **chilliproject** for project at http://www.redmine.org/projects/chilliproject
35880a5 @oruen Lighthouseapp tracker model.
oruen authored
112
a02daca @benlangfeld Add support for Pivotal Tracker issue creation
benlangfeld authored
113 Pivotal Tracker integration
114 -------------------------
115
116 * Errbit uses token-based authentication. Get your API Key or visit [http://www.pivotaltracker.com/help/api](http://www.pivotaltracker.com/help/api) to learn how to get it.
117 * Project id is an identifier of your project, i.e. **24324** for project at http://www.pivotaltracker.com/projects/24324
118
3977fd2 @jdpace Add full management controls for users.
jdpace authored
119 TODO
120 ----
121
cccdfbd @jdpace Update Markdown formatting in the README
jdpace authored
122 * 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
123
37694d2 @jdpace Add a special thanks section to the Readme.
jdpace authored
124 Special Thanks
125 --------------
126
127 * [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
128 * [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
129 * [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.
130 * [Thoughtbot](http://thoughtbot.com) - For being great open-source advocates and setting the bar with [Hoptoad](http://hoptoadapp.com).
131
a43dcc0 @jdpace Add MIT License and update the readme
jdpace authored
132 Contributing
133 ------------
d0bad87 @avsej update README.md: trailing spaces & fix preformatted snippets
avsej authored
134
a43dcc0 @jdpace Add MIT License and update the readme
jdpace authored
135 * Fork the project.
136 * Make your feature addition or bug fix.
137 * Add tests for it. This is important so I don't break it in a
138 future version unintentionally.
139 * Commit, do not mess with Rakefile, version, or history.
140 (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)
141 * Send me a pull request. Bonus points for topic branches.
142
143 Copyright
144 ---------
145
146 Copyright (c) 2010 Jared Pace. See LICENSE for details.
Something went wrong with that request. Please try again.