Docker

Prerrequisitos: Antes de continuar con la instalación de Evolution API v2 usando Docker, asegúrese de que ya haya configurado los servicios necesarios, como PostgreSQL y Redis. Siga los enlaces a continuación para más detalles:

Estas instrucciones de instalación asumen que ya tiene Docker instalado en su máquina. Puede encontrar información sobre cómo instalar Docker en la Documentación Oficial de Docker.

Evolution API v2 está lista para Docker y puede desplegarse fácilmente con Docker en modo standalone o swarm. El repositorio oficial de Evolution API contiene todos los archivos de composición necesarios para instalar y ejecutar la API.

Docker Compose

Desplegar Evolution API v2 usando Docker Compose simplifica la configuración y gestión de sus contenedores Docker. Le permite definir su entorno Docker en un archivo docker-compose.yaml y luego usar un solo comando para iniciar todo.

Archivo Docker Compose

El siguiente ejemplo ilustra cómo configurar Docker Compose para entornos standalone, es decir, un único servidor en ejecución. Para la sincronización de dos servidores en paralelo o mayor escalabilidad, utilice Docker Swarm, recomendado para usuarios más avanzados.

Configuración Standalone

Atención: Los comandos aquí descritos como docker compose, pueden no funcionar en versiones más antiguas de Docker. Si está usando una versión más antigua, sustitúyalos por docker-compose.

Docker standalone es adecuado cuando Evolution API se ejecutará en una sola máquina, sin necesidad de escalabilidad inmediata. Esta es la forma más conveniente para la mayoría de los usuarios. Para comenzar, cree un archivo docker-compose.yml con el siguiente contenido:

version: '3.9'
services:
  evolution-api:
    container_name: evolution_api
    image: evoapicloud/evolution-api:v2.1.1
    restart: always
    ports:
      - "8080:8080"
    env_file:
      - .env
    volumes:
      - evolution_instances:/evolution/instances

volumes:
  evolution_instances:

A continuación, cree un archivo .env en el mismo directorio con el siguiente contenido mínimo:

AUTHENTICATION_API_KEY=cambiame

Para más configuraciones, puede obtener el archivo de ejemplo en el repositorio oficial. Consulte también la guía de variables de entorno aquí.

Iniciando la API

Navegue hasta el directorio que contiene el archivo docker-compose.yml y ejecute el siguiente comando para iniciar los servicios definidos en el archivo:

docker compose up -d

Este comando descargará las imágenes Docker necesarias, creará los servicios, redes y volúmenes definidos, e iniciará el servicio de Evolution API.

Verificando los Logs

Después de ejecutar el comando docker compose up, puede verificar los logs para confirmar si los servicios están en ejecución correctamente:

docker logs evolution_api

Deteniendo el Servicio

Para detener el servicio, utilice el comando:

docker compose down

Accediendo a la API

Abra su navegador y acceda a http://localhost:8080 para verificar si Evolution API está operativa.

Docker Swarm

Para configurar y gestionar un clúster Docker Swarm para Evolution API v2, siga las instrucciones a continuación. Docker Swarm es ideal para entornos que requieren escalabilidad y alta disponibilidad.

Instalación de Docker Swarm

Configurando el Servidor Manager

Si está utilizando un servidor de Hetzner, ejecute:

sudo apt-get update && apt-get install -y apparmor-utils

Paso 1: Configuración del Hostname

Cambie el hostname de la máquina para identificarla en el clúster:

hostnamectl set-hostname manager1

Edite el archivo /etc/hosts para agregar el nuevo nombre:

nano /etc/hosts

Agregue la línea:

127.0.0.1    manager1

Reinicie el sistema para aplicar los cambios:

reboot

Verifique el hostname:

hostnamectl

Paso 2: Instalación de Docker Instale Docker ejecutando:

curl -fsSL https://get.docker.com | bash

Paso 3: Iniciando el Swarm Inicie Docker Swarm:

docker swarm init --advertise-addr IP_SERVER

Paso 4: Configuración de la Red de Docker Swarm Cree la red overlay para Docker Swarm:

docker network create --driver=overlay network_public

Anote el comando generado para registrar los Workers:

docker swarm join --token HASH IP_SERVER:2377

Configurando el Servidor Worker

Si está utilizando un servidor de Hetzner, ejecute:

sudo apt-get update && apt-get install -y apparmor-utils

Paso 1: Configuración del Hostname

Cambie el hostname de la máquina para identificarla en el clúster:

hostnamectl set-hostname worker1

Edite el archivo /etc/hosts para agregar el nuevo nombre:

nano /etc/hosts

Agregue la línea:

127.0.0.1    worker1

Reinicie el sistema para aplicar los cambios:

reboot

Paso 2: Instalación de Docker Instale Docker ejecutando:

curl -fsSL https://get.docker.com | bash

Paso 3: Agregar el Worker al Clúster Ejecute el comando obtenido anteriormente para agregar el Worker al clúster:

docker swarm join --token HASH IP_SERVER:2377

Prerrequisitos para Evolution API vía Swarm

Instalación de Traefik

Para instalar Traefik en Docker Swarm, siga las instrucciones a continuación:

En el servidor manager, cree un archivo traefik.yaml:

nano traefik.yaml

Agregue el siguiente contenido al archivo:

version: "3.7"

services:
  traefik:
    image: traefik:2.11.2
    command:
      - "--api.dashboard=true"
      - "--providers.docker.swarmMode=true"
      - "--providers.docker.endpoint=unix:///var/run/docker.sock"
      - "--providers.docker.exposedbydefault=false"
      - "--providers.docker.network=network_public"
      - "--entrypoints.web.address=:80"
      - "--entrypoints.web.http.redirections.entryPoint.to=websecure"
      - "--entrypoints.web.http.redirections.entryPoint.scheme=https"
      - "--entrypoints.web.http.redirections.entrypoint.permanent=true"
      - "--entrypoints.websecure.address=:443"
      - "--certificatesresolvers.letsencryptresolver.acme.httpchallenge=true"
      - "--certificatesresolvers.letsencryptresolver.acme.httpchallenge.entrypoint=web"
      - "--certificatesresolvers.letsencryptresolver.acme.email=su@email.com"
      - "--certificatesresolvers.letsencryptresolver.acme.storage=/etc/traefik/letsencrypt/acme.json"
      - "--log.level=DEBUG"
      - "--log.format=common"
      - "--log.filePath=/var/log/traefik/traefik.log"
      - "--accesslog=true"
      - "--accesslog.filepath=/var/log/traefik/access-log"
    deploy:
      placement:
        constraints:
          - node.role == manager
      restart_policy:
        condition: on-failure
        delay: 5s
      labels:
        - "traefik.enable=true"
        - "traefik.http.middlewares.redirect-https.redirectscheme.scheme=https"
        - "traefik.http.middlewares.redirect-https.redirectscheme.permanent=true"
        - "traefik.http.routers.http-catchall.rule=hostregexp(`{host:.+}`)"
        - "traefik.http.routers.http-catchall.entrypoints=web"
        - "traefik.http.routers.http-catchall.middlewares=redirect-https@docker"
        - "traefik.http.routers.http-catchall.priority=1"
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock:ro"
      - "vol_certificates:/etc/traefik/letsencrypt"
    ports:
      - target: 80
        published: 80
        mode: host
      - target: 443
        published: 443
        mode: host
    networks:
      - network_public

volumes:
  vol_certificates:
    external: true
    name: volume_swarm_certificates

networks:
  network_public:
    external: true
    name: network_public

Ejecute el comando a continuación para hacer el despliegue del stack de Traefik:

docker stack deploy --prune --resolve-image always -c traefik.yaml traefik

Despliegue de Evolution API v2

Finalmente, para desplegar Evolution API v2 en Docker Swarm, use el archivo de configuración disponible aquí con el siguiente contenido:

version: "3.7"

services:
  evolution_v2:
    image: evoapicloud/evolution-api:v2.1.1
    volumes:
      - evolution_instances:/evolution/instances
    networks:
      - network_public
    environment:
      - SERVER_URL=https://evo2.site.com
      - DEL_INSTANCE=false
      - DATABASE_ENABLED=true
      - DATABASE_PROVIDER=postgresql
      - DATABASE_CONNECTION_URI=postgresql://postgres:CONTRASEÑA@postgres:5432/evolution
      - DATABASE_SAVE_DATA_INSTANCE=true
      - DATABASE_SAVE_DATA_NEW_MESSAGE=true
      - DATABASE_SAVE_MESSAGE_UPDATE=true
      - DATABASE_SAVE_DATA_CONTACTS=true
      - DATABASE_SAVE_DATA_CHATS=true
      - DATABASE_SAVE_DATA_LABELS=true
      - DATABASE_SAVE_DATA_HISTORIC=true
      - DATABASE_CONNECTION_CLIENT_NAME=evolution_v2
      - RABBITMQ_ENABLED=false
      - RABBITMQ_URI=amqp://admin:admin@rabbitmq:5672/default
      - CACHE_REDIS_ENABLED=true
      - CACHE_REDIS_URI=redis://evo_redis:6379/1
      - CACHE_REDIS_PREFIX_KEY=evolution_v2
      - CACHE_REDIS_SAVE_INSTANCES=false
      - CACHE_LOCAL_ENABLED=false
      - S3_ENABLED=true
      - S3_ACCESS_KEY=
      - S3_SECRET_KEY=
      - S3_BUCKET=evolution
      - S3_PORT=443
      - S3_ENDPOINT=files.site.com
      - S3_USE_SSL=true
      - AUTHENTICATION_API_KEY=429683C4C977415CAAFCCE10F7D57E11
    deploy:
      mode: replicated
      replicas: 1
      placement:
        constraints:
          - node.hostname == evolution-manager
      labels:
        - traefik.enable=true
        - traefik.http.routers.evolution_v2.rule=Host(`evo2.site.com`)
        - traefik.http.routers.evolution_v2.entrypoints=websecure
        - traefik.http.routers.evolution_v2.tls.certresolver=letsencryptresolver
        - traefik.http.routers.evolution_v2.service=evolution_v2
        - traefik.http.services.evolution_v2.loadbalancer.server.port=8080
        - traefik.http.services.evolution_v2.loadbalancer.passHostHeader=true

volumes:
  evolution_instances:
    external: true
    name: evolution_v2_data

networks:
  network_public:
    external: true
    name: network_public

Después de configurar y guardar el archivo, haga el despliegue del stack con el comando:

docker stack deploy --prune --resolve-image always -c evolution_api_v2.yaml evolution_v2

Accediendo a la API

Abra su navegador y acceda a https://evo2.site.com para verificar si Evolution API está operativa.

Primeros Pasos

Configuración

Integraciones

Docker Compose

Archivo Docker Compose

Configuración Standalone

Iniciando la API

Verificando los Logs

Deteniendo el Servicio

Accediendo a la API

Docker Swarm

Instalación de Docker Swarm

Configurando el Servidor Manager

Configurando el Servidor Worker

Prerrequisitos para Evolution API vía Swarm

Instalación de Traefik

Despliegue de Evolution API v2

Accediendo a la API

​Docker Compose

​Archivo Docker Compose

​Configuración Standalone

​Iniciando la API

​Verificando los Logs

​Deteniendo el Servicio

​Accediendo a la API

​Docker Swarm

​Instalación de Docker Swarm

​Configurando el Servidor Manager

​Configurando el Servidor Worker

​Prerrequisitos para Evolution API vía Swarm

​Instalación de Traefik

​Despliegue de Evolution API v2

​Accediendo a la API

Docker Compose

Archivo Docker Compose

Configuración Standalone

Iniciando la API

Verificando los Logs

Deteniendo el Servicio

Accediendo a la API

Docker Swarm

Instalación de Docker Swarm

Configurando el Servidor Manager

Configurando el Servidor Worker

Prerrequisitos para Evolution API vía Swarm

Instalación de Traefik

Despliegue de Evolution API v2

Accediendo a la API