These installation instructions assume you have already installed Docker on your machine. You can find
information on how to install Docker in the
Official Docker Documentation.
Docker Run
Quick Start
CLI installation is recommended for quick deployment, mainly for testing or development. It should not be
used for production. Instead, we recommend that you use docker-compose for
easier deployment and maintenance.
docker run
on the command line interface.
Terminal
apikey
header set.
Quick Start with Volumes
You can also deploy using Docker volumes to keep your EvolutionAPI’s persistent data and all WhatsApp instances on your local machine, avoiding issues with container restarts by usingdocker run
on the command line interface.
Run the following command to deploy EvolutionAPI with the necessary volumes. This command maps the evolution_store
and evolution_instances
volumes to their respective directories inside the container.
Terminal
Docker Compose
Deploying EvolutionAPI using Docker Compose simplifies the setup and management of your Docker containers. It allows you to define your Docker environment in adocker-compose.yaml
file and then use a single command to start everything.
This is a Docker Compose example for standalone environments, i.e., a single running server. For synchronization of two servers in parallel, use Swarm. This is for more advanced Docker users.
Standalone
Warning: the commands featured here as
docker compose
might not work on older versions, and must be replaced by docker-compose
.docker-compose.yml
file with this content:
docker-compose.yml
.env
file in the same directory with the following:
.env
For more configurations, take the example file from the
official repository. And see the
guide here.