Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs: say a compose profile only starts the container

Yudhi Armyndharisd580d95f4d6b
diff --git a/README.md b/README.md
index 628bb82d8..addb6ffd9 100644
--- a/README.md
+++ b/README.md
@@ -261,10 +261,10 @@ For production, use the main `docker-compose.yml` with optional services:
# Basic production (SQLite, local storage)
docker compose up -d
-# With PostgreSQL database
+# Also start the PostgreSQL container (configure it first, see below)
docker compose --profile postgres up -d
-# Full stack (PostgreSQL, Redis, MinIO)
+# Also start PostgreSQL, Redis and MinIO (configure them first, see below)
docker compose --profile full up -d
```
@@ -275,6 +275,20 @@ docker compose --profile full up -d
| `minio` | S3-compatible storage |
| `full` | All services above |
+A profile only starts the container; OpenWA keeps using SQLite and local storage until it is told
+to use the new service. The simplest route is **Dashboard > Infrastructure**: pick the built-in
+option, save, and restart from there, and OpenWA starts the container itself. To use a profile
+directly, set these in the `.env` next to `docker-compose.yml` first:
+
+- PostgreSQL: `DATABASE_TYPE=postgres`, `DATABASE_HOST=postgres`, `DATABASE_USERNAME=openwa`,
+ `DATABASE_PASSWORD=<strong password>`
+- Redis: `REDIS_ENABLED=true`, `REDIS_HOST=redis`
+- MinIO: `STORAGE_TYPE=s3`, `S3_ENDPOINT=http://minio:9000`, `S3_ACCESS_KEY_ID=<user>`,
+ `S3_SECRET_ACCESS_KEY=<strong password>`
+
+PostgreSQL and MinIO refuse to initialize with an empty password, and a production boot rejects
+default credentials such as `openwa` or `minioadmin`.
+
> The dashboard is bundled into the API image and served by NestJS on the API port, so it
> needs no profile — it is always available wherever `openwa-api` runs. For TLS/public exposure,
> put your own reverse proxy (nginx, Caddy, a cloud load balancer, or a k8s Ingress) in front;
diff --git a/docs/08-development-guidelines.md b/docs/08-development-guidelines.md
index 8876fe1c7..71b72551c 100644
--- a/docs/08-development-guidelines.md
+++ b/docs/08-development-guidelines.md
@@ -655,6 +655,10 @@ docker compose --profile postgres up -d
docker compose --profile full up -d
```
+A profile only starts the extra containers. Point OpenWA at them first, from Dashboard >
+Infrastructure or with the `.env` variables listed under Production Deployment in the README;
+otherwise it stays on SQLite and local storage.
+
### VS Code Extensions
```json
diff --git a/docs/14-migration-guide.md b/docs/14-migration-guide.md
index 38cc8a279..fb435a542 100644
--- a/docs/14-migration-guide.md
+++ b/docs/14-migration-guide.md
@@ -98,12 +98,17 @@ OpenWA v0.2+ includes built-in migration API endpoints that leverage the **Dual-
curl -s 'http://localhost:2785/api/infra/export-data' \
-H 'X-API-Key: YOUR_KEY' > data-backup.json
-# Step 2: Change database configuration in .env or Dashboard
-# From: DATABASE_TYPE=sqlite
-# To: DATABASE_TYPE=postgres
-# POSTGRES_BUILTIN=true
-
-# Step 3: Restart with new configuration
+# Step 2: Change the database configuration
+# Dashboard: Infrastructure > PostgreSQL + "Use Built-in PostgreSQL Container"; save, then
+# restart from the dashboard, which starts the container itself (skip Step 3).
+# Or in the .env next to docker-compose.yml (compose does not forward POSTGRES_BUILTIN, so
+# name the host and set a real password):
+# DATABASE_TYPE=postgres
+# DATABASE_HOST=postgres
+# DATABASE_USERNAME=openwa
+# DATABASE_PASSWORD=<strong password>
+
+# Step 3: Restart with the new configuration (.env route)
docker compose --profile postgres up -d
# Step 4: Import data to new database