|
| Latest Version | 
|
| Documentation | 
|
| Crate Downloads | 
|
| GitHub Downloads | 
|
| License | 
|| | |
| ---------------: | ------------------------------------------------------- |
| CI | |
| Latest Version | |
| Documentation | |
| Crate Downloads | |
| GitHub Downloads | |
| License | |
Table of Contents
A reverse proxy service with configurable rate limiting
The limitation-proxy service is an HTTP reverse proxy which sits in front of
another HTTP service and will perform rate limiting on all requests that pass
through it. The rate limiting is a variant of a fixed window rate limiting
strategy and Redis is used for its persistence.
text
+------------------+ +-----------------------+
| | | |
| | | |
--->+ limitation-proxy +----------->+ proxied |
| +<-----------+ back end |
| | | |
| | | |
+--------+---------+ +-----------------------+
|
v
+--------+---------+
| |
| |
| Redis |
| |
| |
+------------------+
If Rust is installed, then installing with Cargo is straight forward:
console
$ cargo install limitation-proxy
To install from source, you can clone the Git repository, build with Cargo and copy the binary into a destination directory. This will build the project from the latest commit on the master branch, which may not correspond to the latest stable release:
console
$ git clone https://github.com/fnichol/limitation.git
$ cd limitation
$ cargo build --bin limitation-proxy --release
$ cp ./target/release/limitation-proxy /dest/path/
You can use the -h/--help flag to get:
```console $ limitation-proxy limitation-proxy 0.1.0 Fletcher Nichol fnichol@nichol.ca
A reverse proxy service with configurable rate limiting
Project home page: https://github.com/fnichol/limitation
USAGE: limitation-proxy
OPTIONS:
-b, --bind
A running Redis instance is required for limitation-proxy, so we'll assume one
is running locally and reachable at 127.0.0.1:6379 which happens to be this
service's default as well. Starting the service without any arguments runs with
the default settings:
console
$ limitation-proxy
You can also override the defaults with the arguments. For example, this will run the service limiting up to 100 requests in a 60 second window:
console
$ limitation-proxy --limit 100 --period 60
These are some ideas and potential future work for this project. If you're reading this, then maybe you're curious or interested in helping out? Great! Be sure to check out the [Contributing][#contributing] section and dig in!
Authorization header will only key on the full value string which may
include both basic authentication and token based authentication.limitation crate to support this./a/b will be proxied to the back end's /a/b path. It might be
useful if the service could take /a/b and send it to /api/v1/a/b on the
back end| Operating System | Stable Rust | Nightly Rust | MSRV |
| ---------------: | ----------------------------------------------------------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| FreeBSD | 
| 
| 
|
| Linux | 
| 
| 
|
| macOS | 
| 
| 
|
| Windows | 
| 
| 
|
| Operating System | Stable Rust | Nightly Rust | MSRV |
| ---------------: | --------------------------------------------------------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------- |
| FreeBSD | 
| 
| 
|
| Linux | 
| 
| 
|
| macOS | 
| 
| 
|
| Windows | 
| 
| 
|
| | Status |
| ------ | ------------------------------------------------- |
| Lint | 
|
| Format | 
|
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to fnichol@nichol.ca.
If you have any problems with or questions about this project, please contact us through a GitHub issue.
You are invited to contribute to new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
See the [changelog] for a full release history.
Created and maintained by Fletcher Nichol (fnichol@nichol.ca).
Licensed under the Mozilla Public License Version 2.0 (LICENSE.txt).
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the MPL-2.0 license, shall be licensed as above, without any additional terms or conditions.