Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
docs: stop describing Redis as a cache
Yudhi Armyndharise7e9a4b107da
diff --git a/README.md b/README.mdindex a954ada9b..ac6a47815 100644--- a/README.md+++ b/README.md@@ -32,12 +32,12 @@**OpenWA** is a free, open-source WhatsApp API Gateway designed for developers who need full control over their messaging infrastructureβwithout vendor lock-in or hidden paywalls.-Built on a **pluggable architecture**, OpenWA lets you select database engines (SQLite/PostgreSQL), media storage backends (Local/S3), and cache layers (disabled/Redis) through configuration rather than application-code changes. The storage backend is the live store for status media and, when chat-media archiving is enabled, archived chat media; other message media is returned inline to API and webhook consumers. Of the media, `scripts/backup.sh` archives only the local media directory, so an S3 bucket needs a backup of its own.+Built on a **pluggable architecture**, OpenWA lets you select database engines (SQLite/PostgreSQL), media storage backends (Local/S3), and an optional Redis (queue, rate limits, WebSocket fan-out) through configuration rather than application-code changes. The storage backend is the live store for status media and, when chat-media archiving is enabled, archived chat media; other message media is returned inline to API and webhook consumers. Of the media, `scripts/backup.sh` archives only the local media directory, so an S3 bucket needs a backup of its own.| | || ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- || π **100% Open Source** | No licensing fees, no feature locks, full source code access |-| ποΈ **Pluggable Architecture** | Swap adapters for database, storage, and cache via config |+| ποΈ **Pluggable Architecture** | Swap adapters for database and storage via config || π₯οΈ **Full Dashboard** | Modern React UI for session, webhook, and API key management || πΉ **Multi-Session Ready** | Run multiple WhatsApp sessions concurrently on one instance || π³ **Docker Native** | Production-ready with zero configuration |@@ -165,7 +165,7 @@ For any deployment where ethical, legal, or regulatory compliance matters (healt| ---------------- | ------ | ------------------------------------------------ || SQLite | β | Zero-config embedded database || PostgreSQL | β | Production-grade database |-| Redis Cache | β | Optional performance caching |+| Redis | β | Opt-in queue, rate limits, WebSocket fan-out || S3/MinIO Storage | β | Live media store (statuses, archived chat media) || Docker | β | One-command deployment || Health Checks | β | Kubernetes-ready probes |@@ -283,7 +283,7 @@ docker compose --profile full up -d| Profile | Services || ---------- | ----------------------------------------------- || `postgres` | PostgreSQL database |-| `redis` | Redis cache |+| `redis` | Redis (queue, rate limits, WebSocket fan-out) || `minio` | S3-compatible storage (MinIO fork `pgsty/silo`) || `full` | All services above |@@ -454,7 +454,7 @@ The key can be passed as `Authorization: Bearer β¦` or `X-API-Key: β¦`. Every| **Language** | TypeScript 6.x || **WA Engine** | whatsapp-web.js (default) / baileys β set `ENGINE_TYPE` || **Database** | SQLite / PostgreSQL |-| **Cache** | Redis (optional) |+| **Redis** | Queue, rate limits, WebSocket fan-out (optional) || **Storage** | Local / S3 / MinIO || **ORM** | TypeORM || **Container** | Docker + Docker Compose |@@ -470,7 +470,7 @@ openwa/β βββ app.module.ts # Root moduleβ βββ config/ # Configurationβ βββ common/ # Shared utilities-β β βββ cache/ # Redis caching+β β βββ cache/ # Redis client (infra status probe)β β βββ storage/ # File storage (Local/S3)β βββ core/ # Core systemsβ β βββ hooks/ # Plugin hooksdiff --git a/docs/12-troubleshooting-faq.md b/docs/12-troubleshooting-faq.mdindex e769a7caa..237f46e05 100644--- a/docs/12-troubleshooting-faq.md+++ b/docs/12-troubleshooting-faq.md@@ -1083,7 +1083,7 @@ DATABASE_IDLE_TIMEOUT_MS=30000 # idle client eviction (default 30000)DATABASE_CONNECTION_TIMEOUT_MS=10000 # wait for a free connection (default 10000)DATABASE_STATEMENT_TIMEOUT_MS=30000 # server-side per-query cap (default 30000)-# Redis caching (per-key TTLs are fixed in code β there is no cache TTL env var)+# Redis (the cache connection only answers the infra status probe β there is no cache TTL env var)# REDIS_ENABLED=true# REDIS_HOST=localhost# REDIS_PORT=6379diff --git a/docs/14-migration-guide.md b/docs/14-migration-guide.mdindex 2110248b3..51e89bc66 100644--- a/docs/14-migration-guide.md+++ b/docs/14-migration-guide.md@@ -315,7 +315,7 @@ route instead. The volume and its media are kept either way.### Redis Migration (Cache)-Redis in OpenWA holds only **ephemeral** state: TTL-based cache entries, BullMQ jobs (see below), and β when `REDIS_ENABLED` β the rate-limit hit counters. No request reads the cache, so there is nothing to migrate.+Redis in OpenWA holds only **ephemeral** state: BullMQ jobs (see below), and β when `REDIS_ENABLED` β the rate-limit hit counters. No request reads the cache, so there is nothing to migrate.**No migration API needed** - just change configuration: