Skip to content
This repository has been archived by the owner on Jun 5, 2023. It is now read-only.

Adding information about throttling parameters #402

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,24 @@ sudo apt install build-essential

## WARNING

This application does NOT serve up over TLS, and does NOT rate
control, or access control clients. Please run this service behind a
load balancer that terminates SSL and does some rate and access
control.
This application does NOT serve up over TLS or access control clients.
Please run this service behind a load balancer that terminates SSL
and does some access control.

### Rating

This application performs rating on the request with the parameters
configured in `sys.config`.

Each client is checked against the limits configured by following parameters:

* How much request time is allowed: `request_time`
* How many requests are allowed: `request_count`
* Period in milliseconds to apply above limits: `request_interval`
* Duration threshold to ignore the requests in rating, if the execution takes less: `grace_time`

All limits are applied against individual client IPs. Client IP is retrieved from `X-Forwarded-For` HTTP header,
and this header can be configured with `actor_header` parameter in the configuration file.

## Using Docker

Expand Down