hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-14 17:02:49 +03:00
Code Issues Projects Releases Wiki Activity

docs: update docs for enabling EE rate limiting

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8811
Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com>
GitOrigin-RevId: 111d059b7a002178c42f44926bbf220ab3ad2fe2
This commit is contained in:
Puru Gupta 2023-04-20 16:45:14 +05:30 committed by hasura-bot
parent 0383cb383b
commit 9d815b54ed
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/docs/security/api-limits.mdx
View File

@ -49,6 +49,15 @@ You can choose any one of the above parameters to rate limit the requests.
**Note**: If you set a `Unique Parameter` then the combination of both the `role_name` and the `Unique Parameter` will
be used to rate-limit requests.
:::info Note
To enable rate limiting on Hasura Enterprise, you must set the
[`HASURA_GRAPHQL_RATE_LIMIT_REDIS_URL`](/deployment/graphql-engine-flags/reference.mdx#rate-limit-redis-url) environment
variable or the [`--rate-limit-redis-url`](/deployment/graphql-engine-flags/reference.mdx#rate-limit-redis-url) server flag
with the appropriate Redis connection string.
:::
Example:
If you rate-limit using the `role_name` and set the unique parameter for the rate-limit as `IP Address`, then rate-limit