Skip to content

Commit

Permalink
Document Redis is available now
Browse files Browse the repository at this point in the history
  • Loading branch information
julik committed Feb 28, 2024
1 parent 0ad6416 commit 585576c
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

Pecorino is a rate limiter based on the concept of leaky buckets, or more specifically - based on the [generic cell rate](https://brandur.org/rate-limiting) algorithm. It uses your DB as the storage backend for the throttles. It is compact, easy to install, and does not require additional infrastructure. The approach used by Pecorino has been previously used by [prorate](https://github.com/WeTransfer/prorate) with Redis, and that approach has proven itself.

Pecorino is designed to integrate seamlessly into any Rails application using a PostgreSQL or SQLite database (at the moment there is no MySQL support, we would be delighted if you could add it).
Pecorino is designed to integrate seamlessly into any Rails application, and will use either:

* A memory store (good enough if you have just 1 process)
* A PostgreSQL or SQLite database (at the moment there is no MySQL support, we would be delighted if you could add it)
* A Redis instance

If you would like to know more about the leaky bucket algorithm: [this article](http://live.julik.nl/2022/08/the-unreasonable-effectiveness-of-leaky-buckets) or the [Wikipedia article](https://en.wikipedia.org/wiki/Leaky_bucket) are both good starting points. [This Wikipedia article](https://en.wikipedia.org/wiki/Generic_cell_rate_algorithm) describes the generic cell rate algorithm in more detail as well.

Expand Down

0 comments on commit 585576c

Please sign in to comment.