Reading the repo

Opening the box…

How to set up OpenWA (rmyndharis/OpenWA) · gitmanual

Assembly instructions

rmyndharis/OpenWA

Free, Open Source, Self-Hosted WhatsApp API Gateway

Node.jsNestJS#api#bot#gateway#self-hosted

Difficulty: Moderate
Time: 30 min or more
Stars: ★ 16,531
Activity: Updated this month
License: MIT
Open issues: 12
Got it running: Be the first
Looked up: 2 h ago

Saved setup from 2 h ago

Start here

Website ↗open-wa.orgThe project's own site.

Setup script in the repo

The maintainers included scripts/install-trivy.sh. Run it from the cloned folder after reading it.

bash scripts/install-trivy.sh

Will it work on my device?

Yes, with Docker on macOS

It's a self-hosted app: the README runs it with Docker, and you open it in your browser.
On macOS that means installing Docker Desktop first.

Checking for

Run it with Docker

A self-hosted app: Docker runs it on your computer and you open it in the browser. Needs Docker Desktop (or Docker Engine on Linux). Run docker compose commands inside the cloned repo folder.

Docker

docker compose -f docker-compose.dev.yml up -d

Docker

docker compose up -d

From the README, exactly as the maintainers wrote it.

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

Claude reads the 13 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js 22runtime
1×Docker tool
1×npm package manager
1×Redis service
1×PostgreSQL service

12× settings in .env

NODE_ENV
PORT
API_PORT
LOG_LEVEL
STATUS_SEED_ON_READY
OPENWA_MEM_LIMIT
OPENWA_PIDS_LIMIT
DATABASE_SYNCHRONIZE
WEBHOOK_TIMEOUT
WEBHOOK_RETRY_DELAY
WEBHOOK_SSRF_PROTECT
PLUGINS_DIR

Featured in Zain Finds

▶ Watch the Reel ↗Need to connect WhatsApp to your own app or AI agent without paying for another hosted API

Share this manual

Good to know

Dockerfile available (base image: docker.io/node:22-slim@sha256:4b150b48b4116e2a22f2c39cc27025fbf4f153e2078fd3b14d159fdb5c7279da).
Nested projects: dashboard/package.json, sdk/go/go.mod, sdk/java/pom.xml, sdk/javascript/package.json and 2 more

package.json scripts (54)

buildnest build
build:allnest build && npm run dashboard:build
formatprettier --write "src/**/*.ts" "test/**/*.ts" "**/*.md"
format:checkprettier --check "src/**/*.ts" "test/**/*.ts" "**/*.md"
startnest start
start:devnest start --watch
start:debugnest start --debug --watch
start:prodnode dist/main
prodnpm run build:all && node dist/main
devconcurrently -n api,dashboard -c blue,green "npm run start:dev" "npm run dashboard:dev"
dashboard:installcd dashboard && npm install
dashboard:cicd dashboard && npm ci
dashboard:devcd dashboard && npm run dev
dashboard:buildcd dashboard && npm run build
postinstallnode scripts/postinstall.js
check:versionsnode scripts/check-doc-versions.mjs
check:dockerignorenode scripts/check-dockerignore.mjs
check:chartnode scripts/check-chart-behaviour.mjs
check:auditnode scripts/check-audit.mjs
check:sdk-routesnode scripts/check-sdk-routes.mjs
check:sdk-coveragenode scripts/check-sdk-coverage.mjs
check:sdk-eventsnode scripts/check-sdk-events.mjs
check:sdk-docsnode scripts/check-sdk-docs.mjs
check:contract-shapesnode scripts/check-contract-shapes.mjs
openapi:exportts-node scripts/export-openapi.ts openapi.json

Files we read (13)

.env.example

.github/workflows/ci.yml

.github/workflows/java-sdk-release.yml

.github/workflows/js-sdk-release.yml

.github/workflows/php-sdk-release.yml

.github/workflows/python-sdk-release.yml

.github/workflows/sdk-ci.yml

.nvmrc

CONTRIBUTING.md

Dockerfile

README.md

docker-compose.yml

package.json

Branch main · 2,302 files in the repo