Skip to content

docs: add WhatsApp Web Gateway setup guide (QR code)#441

Open
KeysiJones wants to merge 1 commit intoRightNow-AI:mainfrom
KeysiJones:docs/whatsapp-web-gateway-setup
Open

docs: add WhatsApp Web Gateway setup guide (QR code)#441
KeysiJones wants to merge 1 commit intoRightNow-AI:mainfrom
KeysiJones:docs/whatsapp-web-gateway-setup

Conversation

@KeysiJones
Copy link

Summary

  • Adds a WhatsApp Web Gateway section to the README with step-by-step instructions for connecting a personal WhatsApp account via QR code
  • Documents all gateway environment variables (WHATSAPP_WEB_GATEWAY_URL, WHATSAPP_GATEWAY_PORT, OPENFANG_URL, OPENFANG_DEFAULT_AGENT)
  • Lists the gateway API endpoints (/login/start, /login/status, /message/send, /health)
  • Includes a link to the Cloud API docs as an alternative for production workloads

Context

The WhatsApp Web Gateway (using Baileys + QR code) is fully implemented in packages/whatsapp-gateway/ but has no documentation in the README. Users currently see a "WhatsApp Web gateway not running" message in the dashboard with no guidance on how to set it up.

This PR fills that gap by documenting the complete setup flow: installing dependencies, configuring config.toml, setting environment variables, starting the gateway, and scanning the QR code.

Test plan

  • Verify the new section renders correctly on GitHub
  • Follow the documented steps on a fresh install to confirm accuracy
  • Confirm QR code flow works end-to-end with the dashboard

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant