Skip to content

Commit cd5e29b

Browse files
committed
docs(env): clarify rate limiting configuration in .env.example
- Add explanation for optional rate limiting configuration - Provide default values and units for rate limit settings - Improve clarity on purpose and usage of rate limiting options
1 parent 8f7a85a commit cd5e29b

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

.env.example

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,15 @@
4444
# This provides a secure way to set or recover the admin account.
4545
# OVERRIDE_ADMIN_EMAIL="[email protected]"
4646

47-
# --- Rate Limiting ---
48-
# Configuration for the /auth/request-code endpoint.
49-
RATE_LIMIT_REQUEST_CODE_LIMIT=3
50-
RATE_LIMIT_REQUEST_CODE_WINDOW_HOURS=24
51-
52-
# Configuration for the /data API endpoints.
53-
RATE_LIMIT_DATA_API_LIMIT=1000
54-
RATE_LIMIT_DATA_API_WINDOW_MINUTES=60
47+
# OPTIONAL: Configure API request limits to prevent abuse.
48+
# The application provides sensible defaults if these are not set.
49+
#
50+
# Limit for the /auth/request-code endpoint (requests per window).
51+
# RATE_LIMIT_REQUEST_CODE_LIMIT=3
52+
# Window for the /auth/request-code endpoint, in hours.
53+
# RATE_LIMIT_REQUEST_CODE_WINDOW_HOURS=24
54+
#
55+
# Limit for the generic /data API endpoints (requests per window).
56+
# RATE_LIMIT_DATA_API_LIMIT=1000
57+
# Window for the /data API endpoints, in minutes.
58+
# RATE_LIMIT_DATA_API_WINDOW_MINUTES=60

0 commit comments

Comments
 (0)