Skip to content

Document WebSocket rate limiter env variables - #807

Open
AlexGaillard wants to merge 2 commits into
mainfrom
docs/websocket-rate-limiter
Open

Document WebSocket rate limiter env variables#807
AlexGaillard wants to merge 2 commits into
mainfrom
docs/websocket-rate-limiter

Conversation

@AlexGaillard

Copy link
Copy Markdown
Member

Documents the new WebSocket rate-limiter environment variables introduced in directus/directus#28106.

The WebSocket rate limiter now has its own config group instead of reusing the main RATE_LIMITER_* values with a hardcoded key prefix. On shared-Redis setups (one Redis instance, multiple projects, ACLs scoped by key prefix), the old hardcoded WebSocket prefix blocked a project from accessing its own limiter keys. The new variables let the prefix be overridden per project.

Added to the Rate Limiting section

  • RATE_LIMITER_WEBSOCKETS_POINTS (default 50)
  • RATE_LIMITER_WEBSOCKETS_DURATION (default 1)
  • RATE_LIMITER_WEBSOCKETS_KEY_PREFIX (default websocket)

Also noted in prose:

  • WebSocket rate limiting is still toggled by the existing RATE_LIMITER_ENABLED flag (no separate enable flag).
  • Store and Redis connection are shared with the main rate limiter (RATE_LIMITER_STORE, REDIS).
  • Defaults (50 points / 1s) match the previous built-in behavior, so existing setups are unaffected unless the new variables are set.

Ref: directus/directus#28106

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@AlexGaillard
AlexGaillard requested a review from a team as a code owner August 14, 2026 15:09
@vercel

vercel Bot commented Aug 14, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 14, 2026 8:08pm

Request Review

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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