Evolution Go Installation

This guide will help you install and configure Evolution Go, our high-performance WhatsApp API written in Go.

Prerequisites

Before starting, make sure you have the following requirements met:

Docker 20.10 or higher
Docker Compose v2.x (optional)
Minimum of 512MB RAM available

Docker Installation

The quickest way to get started with Evolution Go.

Step 1: Clone the repository

git clone https://git.evoai.app/Evolution/evolution-go.git
cd evolution-go

Step 2: Configure environment variables

cp .env.example .env

Edit the .env file with your settings:

# Server port
SERVER_PORT=8080

# Client name
CLIENT_NAME=evolution

# Global API key (change to a secure key!)
GLOBAL_API_KEY=your-secure-key-here

# Database (PostgreSQL)
POSTGRES_AUTH_DB=postgresql://postgres:password@postgres:5432/evogo_auth?sslmode=disable
POSTGRES_USERS_DB=postgresql://postgres:password@postgres:5432/evogo_users?sslmode=disable
DATABASE_SAVE_MESSAGES=false

# Logs
WADEBUG=INFO
LOGTYPE=console

Never use the default API key from .env.example in production. Generate a unique, secure key.

Step 3: Build and run

# Build the Docker image
make docker-build

# Run the container
make docker-run

The service will be available at http://localhost:8080.

Alternative: Docker Compose

You can also use a docker-compose.yml to run Evolution Go alongside PostgreSQL:

services:
  postgres:
    image: postgres:15
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: password
    ports:
      - "5432:5432"
    volumes:
      - postgres_data:/var/lib/postgresql/data

  evolution-go:
    image: evoapicloud/evolution-go:latest
    ports:
      - "8080:8080"
    environment:
      SERVER_PORT: 8080
      CLIENT_NAME: evolution
      GLOBAL_API_KEY: your-secure-key-here
      POSTGRES_AUTH_DB: postgresql://postgres:password@postgres:5432/evogo_auth?sslmode=disable
      POSTGRES_USERS_DB: postgresql://postgres:password@postgres:5432/evogo_users?sslmode=disable
      DATABASE_SAVE_MESSAGES: "false"
      WADEBUG: INFO
      LOGTYPE: console
    depends_on:
      - postgres
    restart: unless-stopped

volumes:
  postgres_data:

Run with:

docker compose up -d

Verifying the Installation

After starting the service, verify it’s working correctly:

Health check

curl http://localhost:8080/

Access the Swagger documentation

Open in your browser:

http://localhost:8080/swagger/index.html

Create your first WhatsApp instance

curl -X POST http://localhost:8080/instance/create \
  -H "Content-Type: application/json" \
  -H "apikey: your-secure-key-here" \
  -d '{
    "instanceName": "my-instance",
    "integration": "WHATSAPP-BAILEYS"
  }'

Get the QR Code to connect

curl http://localhost:8080/instance/my-instance/qrcode \
  -H "apikey: your-secure-key-here"

Scan the QR Code with your phone’s WhatsApp to connect the instance.

Environment Variables

Complete table of available configuration variables:

Variable	Description	Default
`SERVER_PORT`	HTTP server port	`8080`
`CLIENT_NAME`	Client identifier	`evolution`
`GLOBAL_API_KEY`	API authentication key	Required
`POSTGRES_AUTH_DB`	Authentication database connection string	-
`POSTGRES_USERS_DB`	Users database connection string	-
`DATABASE_SAVE_MESSAGES`	Enable message persistence	`false`
`WADEBUG`	WhatsApp log level (`DEBUG`, `INFO`, `WARN`, `ERROR`)	`INFO`
`LOGTYPE`	Log output type (`console`, `json`)	`console`
`CONNECT_ON_STARTUP`	Reconnect instances on startup	`true`
`WEBHOOKFILES`	Include files in webhooks	`true`
`WEBHOOK_URL`	URL to receive webhooks	-
`AMQP_URL`	RabbitMQ connection URL	-
`AMQP_GLOBAL_ENABLED`	Enable RabbitMQ globally	`false`
`MINIO_ENABLED`	Enable MinIO/S3 storage	`false`
`MINIO_ENDPOINT`	MinIO endpoint	-
`MINIO_ACCESS_KEY`	MinIO access key	-
`MINIO_SECRET_KEY`	MinIO secret key	-
`MINIO_BUCKET`	MinIO bucket name	`evolution-media`
`MINIO_USE_SSL`	Use SSL for MinIO connection	`false`

Useful Commands (Docker)

# Build Docker image
make docker-build

# Run Docker container
make docker-run

Next Steps

After installation, you can:

Check the API Reference to learn about all available endpoints
Configure webhooks to receive real-time notifications
Integrate with RabbitMQ for asynchronous message processing

Getting Started

Configuration

Integrations

Prerequisites

Docker Installation

Step 1: Clone the repository

Step 2: Configure environment variables

Step 3: Build and run

Alternative: Docker Compose

Verifying the Installation

Health check

Access the Swagger documentation

Create your first WhatsApp instance

Get the QR Code to connect

Environment Variables

Useful Commands (Docker)

Next Steps

​Prerequisites

​Docker Installation

​Step 1: Clone the repository

​Step 2: Configure environment variables

​Step 3: Build and run

​Alternative: Docker Compose

​Verifying the Installation

​Health check

​Access the Swagger documentation

​Create your first WhatsApp instance

​Get the QR Code to connect

​Environment Variables

​Useful Commands (Docker)

​Next Steps

Prerequisites

Docker Installation

Step 1: Clone the repository

Step 2: Configure environment variables

Step 3: Build and run

Alternative: Docker Compose

Verifying the Installation

Health check

Access the Swagger documentation

Create your first WhatsApp instance

Get the QR Code to connect

Environment Variables

Useful Commands (Docker)

Next Steps