Skip to main content

Prerequisites

Before you can set up and run the WhatsApp Agent, you need to ensure your system meets the following requirements.

Required Software​

The application is fully containerized using Docker, which simplifies the setup process significantly. You must have the following software installed:

  • Docker Engine: The core runtime for building and running containers. For installation instructions, please refer to the official Docker documentation.
  • Docker Compose: A tool for defining and running multi-container Docker applications. It is included with Docker Desktop but may need to be installed separately on Linux. See the Docker Compose installation guide.

You can verify that both are installed correctly by running:

docker --version
docker compose version

Network Access​

Your deployment environment must have network access to the following services:

  • Docker Image Registry: The application's Docker image is hosted on a container registry. You will need access to pull the image. The default registry is GitLab Container Registry.
  • External Services: The running application will need to make outbound connections to:
    • The Exotel API, which this project uses as the WhatsApp Business Solution Provider (BSP).
    • Your chosen CRM's API endpoint.
    • Your S3-compatible object storage service.

Ensure that any firewalls or network security policies on your server or cloud environment allow these connections.