Skip to content

Commit

Permalink
feature/clarify-changing-rate-limit-settings moving explanations insi…
Browse files Browse the repository at this point in the history
…de table
  • Loading branch information
TomerPacific committed Oct 18, 2023
1 parent 50ce796 commit 51681ba
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions source/configure/rate-limiting-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ Maximum burst size
| is enabled. | - Environment variable: ``MM_RATELIMITSETTINGS_MAXBURST`` |
| | |
| Numerical input. Default is **100**. | |
| | |
| Increase this value to allow for more concurrent requests to be | |
| handled, and decrease this value to limit this capacity. | |
| | |
+-----------------------------------------------------------------+--------------------------------------------------------------------------+

.. config:setting:: ratelimit-memorystoresize
Expand All @@ -78,7 +82,6 @@ Maximum burst size
:environment: MM_RATELIMITSETTINGS_MEMORYSTORESIZE
:description: The maximum number of user sessions connected to the system as determined by vary rate limit settings when `rate limiting <#enable-rate-limiting>`__ is enabled. Default is **10000** sessions.

Increase this value to allow for more concurrent requests to be handled, and decrease this value to limit this capacity.

Memory store size
~~~~~~~~~~~~~~~~~
Expand All @@ -92,6 +95,12 @@ Memory store size
| | |
| Numerical input. Default is **10000**. Typically set to the | |
| number of users in the system. | |
| | |
| We recommend setting this value to the expected number of | |
| users. A higher value may result in underutilized resources, | |
| and a lower value may result in user sessions/tokens expiring | |
| too frequently. | |
| | | |
+-----------------------------------------------------------------+----------------------------------------------------------------------------+

.. config:setting:: ratelimit-varybyremoteaddress
Expand All @@ -103,7 +112,6 @@ Memory store size
- **true**: **(Default)** Rate limit API access by IP address. Recommended when using a proxy.
- **false**: Rate limiting does not vary by IP address.

We recommend setting this value to the expected number of users. A higher value may result in underutilized resources, and a lower value may result in user sessions/tokens expiring too frequently.

Vary rate limit by remote address
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 51681ba

Please sign in to comment.