sjs/rack-attack
1
0
Fork 0
mirror of https://github.com/samsonjs/rack-attack.git synced 2026-04-27 15:07:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Cleanup README

Browse source
This commit is contained in:
Aaron Suggs 2012-07-28 19:35:59 -04:00
parent 32eac5caf1
commit 623c1ea05d
1 changed files with 6 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -8,28 +8,29 @@ Thottle state is stored in a configurable cache (e.g. `Rails.cache`), presumably
## Installation ## Installation
Add `rack-attack` to your Gemfile or run Add "rack-attack" to your Gemfile or run
gem install rack-attack gem install rack-attack
Tell your app to use the `Rack::Attack` middleware. Tell your app to use the Rack::Attack middleware.
For Rails 3 apps: For Rails 3 apps:
# In config/application.rb # In config/application.rb
config.middleware.use Rack::Attack config.middleware.use Rack::Attack
Or in your `config.ru`: Or in your `config.ru`:
use Rack::Attack use Rack::Attack
Optionally configure the cache store for throttling: Optionally configure the cache store for throttling:
Rack::Attack.cache.store = my_cache_store # defaults to Rails.cache Rack::Attack.cache.store = my_cache_store # defaults to Rails.cache
Note that `Rack::Attack.cache` is only used for throttling, not blacklisting & whitelisting. Note that `Rack::Attack.cache` is only used for throttling, not blacklisting & whitelisting.
## How it works ## How it works
The Rack::Attack middleware examines each request against *whitelists*, *blacklists*, and *throttles* that you define. The Rack::Attack middleware examines each request against *whitelists*, *blacklists*, and *throttles* that you define. There are none by default.
By default, there are no whitelists, blacklists, or throttles.
* If the request matches any whitelist, the request is allowed. Blacklists and throttles are not checked. * If the request matches any whitelist, the request is allowed. Blacklists and throttles are not checked.
* If the request matches any blacklist, the request is blocked. Throttles are not checked. * If the request matches any blacklist, the request is blocked. Throttles are not checked.
@ -83,9 +84,4 @@ less on short-term, one-off hacks to block a particular attack.
Rack::Attack complements `iptables` and nginx's [limit_zone module](http://wiki.nginx.org/HttpLimitZoneModule). Rack::Attack complements `iptables` and nginx's [limit_zone module](http://wiki.nginx.org/HttpLimitZoneModule).
## Processing order
* If any whitelist matches, the request is allowed
* If any blacklist matches, the request is blocked (unless a whitelist matched)
* If any throttle matches, the request is throttled (unless a whitelist or blacklist matched)
[![Travis CI](https://secure.travis-ci.org/ktheory/rack-attack.png)](http://travis-ci.org/ktheory/rack-attack) [![Travis CI](https://secure.travis-ci.org/ktheory/rack-attack.png)](http://travis-ci.org/ktheory/rack-attack)