Skip to content

feat: RATE_LIMITING env var and config docs#75

Merged
GraysonCAdams merged 2 commits intomainfrom
docs/config-env-vars
Mar 4, 2026
Merged

feat: RATE_LIMITING env var and config docs#75
GraysonCAdams merged 2 commits intomainfrom
docs/config-env-vars

Conversation

@GraysonCAdams
Copy link
Collaborator

Summary

  • Add RATE_LIMITING env var (default false) — rate limiting is now opt-in via RATE_LIMITING=true
  • When disabled, checkRateLimit always allows requests, the in-memory store is never populated, and the cleanup interval doesn't start — covers both hook-level and route-level checks (auth join endpoint)
  • Document RATE_LIMITING, VERBOSE_REQUESTS, ADDRESS_HEADER, and XFF_DEPTH in the configuration reference

Test plan

  • Verify app starts without RATE_LIMITING set — no rate limiting applied
  • Verify RATE_LIMITING=true enables rate limiting as before
  • Confirm the auth join endpoint respects the flag

@GraysonCAdams GraysonCAdams enabled auto-merge (squash) March 4, 2026 03:43
Rate limiting is now opt-in via RATE_LIMITING=true. When disabled
(the default), checkRateLimit always allows requests, the in-memory
store is never populated, and the cleanup interval doesn't start.
This covers both the hook-level and route-level rate limit checks.
@GraysonCAdams GraysonCAdams force-pushed the docs/config-env-vars branch from 6c12421 to d0608bf Compare March 4, 2026 03:45
@GraysonCAdams GraysonCAdams merged commit 4032791 into main Mar 4, 2026
18 checks passed
@GraysonCAdams GraysonCAdams deleted the docs/config-env-vars branch March 4, 2026 03:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant