Skip to content

README.md

Latest commit

 

History

History
77 lines (43 loc) · 1.58 KB

README.md

File metadata and controls

77 lines (43 loc) · 1.58 KB

Glimpse.Rack

Glimpse for Rack - A client side Glimpse into whats going on in your server

Rack Server Module

The Glimpse "theory of operation" is that server modules or plugins expose application, configuration, diagnostic, or environment information. This project provides Glimpse for any Rack-based framework or application.

Installation

% gem install glimpse

Configuration

# add a use line to your builder
require 'rack/glimpse'
Rack::Builder.new do
  use Rack::Glimpse, {
    :glimpse          => { :enabled => false, :request_limit => '15', :logging_enabled => false, :cache_enabled => true, :ip_forwarding_enabled => false },
    :ip_addresses     => {},
    :plugin_blacklist => {},
    :url_blacklist    => {},
    :content_types    => {},
    :environments     => {}
  }

  run Hello.new
end

Creating Plugins

Read the documentation for more information.

Contributing

Obtain the project (assumes you've forked it)

% cd ~/projects
% git clone git@github.com:user/Glimpse.Rack.git && cd Glimpse.Rack
% bundle install

Run Tests

% bundle exec rake test

License

Glimpse is licensed under the ??? license.