​
Quick Start Deployment

Get your WhatsApp Team Inbox up and running in minutes with our one-click installation script.

​
Prerequisites

Before you begin, ensure you have:

Docker

Docker 20.10 or higher

Docker Compose

Docker Compose v2.0 or higher

WhatsApp Business API

Meta Business account with WhatsApp API access

Database

PostgreSQL 14+ (included in Docker setup)

​
One-Click Installation

​
1. Download the Repository

git clone https://github.com/your-org/whatsapp-team-inbox.git
cd whatsapp-team-inbox

​
2. Run Installation Script

chmod +x install.sh
./install.sh
The script will:
  • ✅ Check Docker prerequisites
  • ✅ Generate secure secrets
  • ✅ Prompt for configuration
  • ✅ Build Docker containers
  • ✅ Run database migrations
  • ✅ Create admin user
  • ✅ Start all services

​
3. Configuration Prompts

You’ll be asked to provide: 
Enter admin email [admin@example.com]: admin@yourcompany.com
Enter admin password (min 8 characters): ********

WhatsApp Access Token: EAAxxxxxxxxxxxxxxx
WhatsApp Phone Number ID: 123456789012345
WhatsApp Business Account ID: 123456789012345
Get these from Meta Business Suite
Enter your domain (e.g., app.company.com) [localhost]:
For production, use your actual domain. For testing, use localhost.

​
Access Your Installation

Once installation completes, access your services:

WebSocket

ws://localhost:4001

​
Next Steps

1

Configure WhatsApp Webhook

Set your webhook URL in Meta Business Suite:
https://your-domain.com/api/webhook
Learn how →
2

Invite Team Members

Log in and invite your team from Settings > Team
3

Customize Settings

Configure templates, automated responses, and more
4

Test First Conversation

Send a test message to your WhatsApp number

​
Troubleshooting

Check Docker daemon is running:
docker ps
View logs:
docker-compose logs -f
Verify PostgreSQL is healthy:
docker-compose ps postgres
Check database logs:
docker-compose logs postgres
Verify admin was created:
docker-compose exec backend node scripts/create-admin.js
  1. Verify webhook is configured in Meta Business Suite
  2. Check webhook verify token matches your .env
  3. Ensure your server is publicly accessible
  4. Test webhook endpoint: curl https://your-domain.com/api/webhook

​
Useful Commands

# View all logs
docker-compose logs -f

# View specific service logs
docker-compose logs -f backend

# Restart services
docker-compose restart

# Stop services
docker-compose down

# Stop and remove volumes (⚠️ deletes data)
docker-compose down -v

# Update to latest version
git pull
docker-compose build --no-cache
docker-compose up -d
Important: After installation, change your admin password immediately from the Settings page.

​
Production Deployment

For production deployments with managed hosting, see our platform-specific guides:

Railway

One-click deploy with built-in PostgreSQL

Vercel

Deploy Next.js frontend with global CDN

DigitalOcean

Deploy on App Platform with managed database
For optimal performance and cost:
  1. Frontend: Vercel (Next.js optimization + global CDN)
  2. Backend: Railway (easy deployment + included PostgreSQL)
  3. Cost: ~$20-30/month total
Alternative all-in-one options:
  • Railway: Full-stack deployment on single platform
  • DigitalOcean: Complete deployment with managed database