README.md

Hammer.Backend.Mnesia

An Mnesia backend for the Hammer rate-limiter.

This package is available in beta. If you have any problems, please open an issue.

Installation

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

def deps do
  [{:hammer_backend_mnesia, "~> 0.6"},
   {:hammer, "~> 6.1"}]
end

Usage

First, set up an Mnesia schema, see this guide: https://elixirschool.com/en/lessons/specifics/mnesia/

Then, create the Mnesia table for Hammer to use:

Hammer.Backend.Mnesia.create_mnesia_table()

Configure the :hammer application to use the Mnesia backend:

config :hammer,
  backend: {Hammer.Backend.Mnesia, [expiry_ms: 60_000 * 60 * 2,
                                    cleanup_interval_ms: 60_000 * 10]}

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

See the Hammer Tutorial for more.

Documentation

On hexdocs: https://hexdocs.pm/hammer_backend_mnesia/

Getting Help

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