Skip to content

Document WebSocket rate limiter env variables #807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexGaillard merged 2 commits into from
Aug 18, 2026
Merged

Document WebSocket rate limiter env variables #807

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5935e44
Document WebSocket rate limiter env variables
AlexGaillard Aug 14, 2026
2d78f8b
Clarify WebSocket rate limiter inherits main RATE_LIMITER_* settings
AlexGaillard Aug 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions content/configuration/security-limits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,18 @@ You can use the built-in email rate-limiter for flow operations. Unlike the queu
| `RATE_LIMITER_EMAIL_FLOWS_DURATION` | The time window in seconds in which the points are counted. | `60` |
| `RATE_LIMITER_EMAIL_FLOWS_ERROR_MESSAGE` | A custom error message which is appended to the rate limit error. | `''` |

### WebSocket Rate Limiting

You can rate limit the number of messages a client can send over a WebSocket connection. The WebSocket message rate limiter inherits all `RATE_LIMITER_*` settings (store, points, duration, Redis connection) and is enabled by the same `RATE_LIMITER_ENABLED` flag. There is no separate enable flag.

Any `RATE_LIMITER_WEBSOCKETS_*` variable overrides the matching `RATE_LIMITER_*` value for WebSocket connections only.

| Variable | Description | Default Value |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
| `RATE_LIMITER_WEBSOCKETS_POINTS` | Overrides `RATE_LIMITER_POINTS` for WebSocket connections - allowed messages per client per window. | Inherits `RATE_LIMITER_POINTS` |
| `RATE_LIMITER_WEBSOCKETS_DURATION` | Overrides `RATE_LIMITER_DURATION` for WebSocket connections - window length in seconds. | Inherits `RATE_LIMITER_DURATION` |
| `RATE_LIMITER_WEBSOCKETS_KEY_PREFIX` | Prefix for the WebSocket limiter's Redis keys. Override this when a shared Redis instance scopes each project's access by key prefix. | `websocket` |

## Limits & Optimizations

Allows you to configure hard technical limits, to prevent abuse and optimize for your particular server environment.
Expand Down
Loading