Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs: stop describing Redis as a cache

Yudhi Armyndharise7e9a4b107da
diff --git a/README.md b/README.md
index 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 hooks
diff --git a/docs/12-troubleshooting-faq.md b/docs/12-troubleshooting-faq.md
index 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=6379
diff --git a/docs/14-migration-guide.md b/docs/14-migration-guide.md
index 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: