A Redis backend for for the Hammer rate-limiter
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
doc_src
lib
test
.gitignore
.travis.yml
CHANGELOG.md
LICENSE.txt
Makefile
README.md
mix.exs
mix.lock

README.md

HammerBackendRedis

Build Status

Coverage Status

A Redis backend for the Hammer rate-limiter.

Installation

Hammer-backend-redis is available in Hex, the package can be installed by adding hammer_backend_redis to your list of dependencies in mix.exs:

def deps do
  [{:hammer_backend_redis, "~> 5.0"},
   {:hammer, "~> 5.0"}]
end

Usage

Configure the :hammer application to use the Redis backend:

config :hammer,
  backend: {Hammer.Backend.Redis, [expiry_ms: 60_000 * 60 * 2,
                                   redix_config: [host: "localhost",
                                                  port: 6379]]}

(the redix_config arg is a keyword-list which is passed to Redix, it's also aliased to redis_config, with an s)

And that's it, calls to Hammer.check_rate/3 and so on will use Redis to store the rate-limit counters.

See the Hammer Tutorial for more.

Documentation

On hexdocs: https://hexdocs.pm/hammer_backend_redis/

Getting Help

If you're having trouble, either open an issue on this repo, or reach out to the maintainers (@shanekilkelly) on Twitter.