Browse files

updated docs

  • Loading branch information...
1 parent 94747ec commit 8d51c24466a9e6732981ae0bab2494d3f692206a @flyingmachine committed Feb 3, 2012
Showing with 50 additions and 8 deletions.
  1. +1 −1 Gemfile.lock
  2. +24 −2 doc/index.asciidoc
  3. +24 −4 doc/index.html
  4. +1 −1 lib/whoops/engine.rb
2 Gemfile.lock
@@ -1,7 +1,7 @@
remote: .
- whoops (0.1.11)
+ whoops (0.2.1)
26 doc/index.asciidoc
@@ -82,9 +82,31 @@ Since Whoops is self-hosted, you can set it up behind your firewall.
. add +gem "whoops"+ to your Gemfile
. run +bundle+
. add[+config/mongoid.yml+]
-. run +bundle exec rails g whoops:assets+ - this copies assets to your public directory (whoops isn't 3.1 compatible yet)
. _optional_ add +root :to => "event_groups#index"+ to your routes file to make the event group listing your home page
. add[loggers] to the code you want to monitor
+. ensure that your +config/application.rb+ file looks something like
+the following:
+# make sure that you're not requiring active record
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+if defined?(Bundler)
+ Bundler.require(*Rails.groups(:assets => %w(development test)))
+module WhoopsServer
+ class Application < Rails::Application
+ config.encoding = "utf-8"
+ config.assets.enabled = true
+ config.filter_parameters += [:password]
+ end
=== Usage
@@ -242,4 +264,4 @@ end
* finish email notification of events
* graphing
-* integrate fully with Rails logger (?)
+* integrate fully with Rails logger (?)
28 doc/index.html
@@ -1001,20 +1001,40 @@ <h3 id="_installation">Installation</h3>
-run <span class="monospaced">bundle exec rails g whoops:assets</span> - this copies assets to your public directory (whoops isn&#8217;t 3.1 compatible yet)
+<em>optional</em> add <span class="monospaced">root :to &#8658; "event_groups#index"</span> to your routes file to make the event group listing your home page
-<em>optional</em> add <span class="monospaced">root :to &#8658; "event_groups#index"</span> to your routes file to make the event group listing your home page
+add <a href="">loggers</a> to the code you want to monitor
-add <a href="">loggers</a> to the code you want to monitor
+ensure that your <span class="monospaced">config/application.rb</span> file looks something like
+the following:
+<div class="listingblock">
+<div class="content"><div class="highlight"><pre><span class="c1"># make sure that you&#39;re not requiring active record</span>
+<span class="nb">require</span> <span class="s2">&quot;action_controller/railtie&quot;</span>
+<span class="nb">require</span> <span class="s2">&quot;action_view/railtie&quot;</span>
+<span class="nb">require</span> <span class="s2">&quot;action_mailer/railtie&quot;</span>
+<span class="nb">require</span> <span class="s2">&quot;sprockets/railtie&quot;</span>
+<span class="k">if</span> <span class="n">defined?</span><span class="p">(</span><span class="no">Bundler</span><span class="p">)</span>
+ <span class="no">Bundler</span><span class="o">.</span><span class="n">require</span><span class="p">(</span><span class="o">*</span><span class="no">Rails</span><span class="o">.</span><span class="n">groups</span><span class="p">(</span><span class="ss">:assets</span> <span class="o">=&gt;</span> <span class="sx">%w(development test)</span><span class="p">))</span>
+<span class="k">end</span>
+<span class="k">module</span> <span class="nn">WhoopsServer</span>
+ <span class="k">class</span> <span class="nc">Application</span> <span class="o">&lt;</span> <span class="no">Rails</span><span class="o">::</span><span class="no">Application</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">encoding</span> <span class="o">=</span> <span class="s2">&quot;utf-8&quot;</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">assets</span><span class="o">.</span><span class="n">enabled</span> <span class="o">=</span> <span class="kp">true</span>
+ <span class="n">config</span><span class="o">.</span><span class="n">filter_parameters</span> <span class="o">+=</span> <span class="o">[</span><span class="ss">:password</span><span class="o">]</span>
+ <span class="k">end</span>
+<span class="k">end</span>
<div class="sect2">
<h3 id="_usage">Usage</h3>
@@ -1234,7 +1254,7 @@ <h2 id="_todo">TODO</h2>
<div id="footnotes"><hr></div>
<div id="footer">
<div id="footer-text">
-Last updated 2011-08-01 08:12:21 EDT
+Last updated 2012-02-03 11:30:58 EST
2 lib/whoops/engine.rb
@@ -1,7 +1,7 @@
module Whoops
class Engine < Rails::Engine
initializer "static assets" do |app|
- app.middleware.use ::ActionDispatch::Static, File.expand_path("../../../app/assets", __FILE__)
+ app.middleware.use ::ActionDispatch::Static, File.expand_path("../../../app/assets/javascripts", __FILE__)

0 comments on commit 8d51c24

Please sign in to comment.