From 9d815b54edd5acbe11822eb38ce9ca0513eeb604 Mon Sep 17 00:00:00 2001 From: Puru Gupta Date: Thu, 20 Apr 2023 16:45:14 +0530 Subject: [PATCH] docs: update docs for enabling EE rate limiting 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 --- docs/docs/security/api-limits.mdx | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/docs/security/api-limits.mdx b/docs/docs/security/api-limits.mdx index 366277b077d..b345889ee63 100644 --- a/docs/docs/security/api-limits.mdx +++ b/docs/docs/security/api-limits.mdx @@ -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