Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
docs(env): correct the throttler, Redis, cache and shutdown notes
Yudhi Armyndharise820a4538f6d
diff --git a/.env.example b/.env.exampleindex 323a684e9..408290017 100644--- a/.env.example+++ b/.env.example@@ -65,9 +65,10 @@ STATUS_SEED_ON_READY=false# MAX_CONCURRENT_SESSIONS=0# Graceful-shutdown drain: on SIGTERM/SIGINT the app flips readiness to 503 (so a load balancer stops-# routing) and keeps serving in-flight requests for this many ms before teardown. Default 3000 in-# production, 0 elsewhere (a dev hot-reload/Ctrl+C is not slowed). Capped at 30000. A second signal-# forces an immediate exit. In Docker, keep `stop_grace_period` >= this + your worst-case teardown.+# routing) and keeps serving in-flight requests for this many ms before teardown. Default 3000 unless+# NODE_ENV is development or test (0 there, so a dev hot-reload/Ctrl+C is not slowed); an unset+# NODE_ENV also gets 3000. Capped at 30000. A second signal forces an immediate exit. In Docker, keep+# `stop_grace_period` >= this + your worst-case teardown.# SHUTDOWN_DELAY_MS=3000# HTTP server timeouts. Raise these when a reverse proxy in front holds connections longer.@@ -346,16 +347,19 @@ DATABASE_SYNCHRONIZE=false # WARNING: Set false in production! (data DB# =============================================================================# REDIS / QUEUE (Phase 2)# =============================================================================-# REDIS_ENABLED=false # Enable Redis for queue, caching, AND cross-replica WebSocket- # event fan-out (Socket.IO Redis adapter). Multi-replica- # deployments need this so a WS client on one replica receives- # events raised on another; single-node can leave it off.+# REDIS_ENABLED=false # Use Redis for the rate-limit store, the cache and+ # cross-replica WebSocket event fan-out (Socket.IO Redis+ # adapter). It does not enable the queue: that needs+ # QUEUE_ENABLED=true. Multi-replica deployments need this so a+ # WS client on one replica receives events raised on another;+ # single-node can leave it off.# REDIS_BUILTIN=false # Use built-in Redis container?# Process webhooks/ingress through the BullMQ queue (needs a reachable Redis via REDIS_HOST/REDIS_PORT).# Off by default (inline dispatch). In the bundled Docker Compose this is dashboard-managed# (Infrastructure > Redis & Queue) — a host value here is not forwarded to the container.# QUEUE_ENABLED=false-# Redis-backed caching, independent of the queue. Off by default (in-memory cache).+# Redis cache: on when REDIS_ENABLED=true OR CACHE_ENABLED=true; otherwise there is no cache (reads+# go to the database, no in-memory tier). CACHE_ENABLED=false does not turn it off while Redis is on.# CACHE_ENABLED=false# Redis settings (auto-configured if REDIS_BUILTIN=true)@@ -624,7 +628,10 @@ WEBHOOK_SSRF_PROTECT=true# =============================================================================# RATE LIMITING (all TTLs are in MILLISECONDS)# =============================================================================-# All three tiers are enforced, each counted per route handler and client IP; unset values use the defaults.+# All three windows (short/medium/long) apply to every non-exempt route, each counted per route+# handler and client IP; exceeding any one returns 429, and raising one tier does not lift the+# others. Unset values keep the defaults below. /api/health*, /api/metrics and /api/ingress/* are+# exempt (ingress has its own limits).# RATE_LIMIT_MEDIUM_TTL=60000 # window in ms (default 60000 = 60s)# RATE_LIMIT_MEDIUM_LIMIT=100 # max requests per window# RATE_LIMIT_SHORT_TTL=1000 # 1s burst window (default)