Instalación de desarrollador: una sola instancia

En este documento, se muestra cómo configurar una única instancia del cliente de la API de WhatsApp Business en un equipo de desarrollador con fines de prueba. Para configurar la producción, sigue las instrucciones relevantes indicadas en Instalaciones de producción.

Para configurar una única instancia, consulta nuestra lista de requisitos y sigue estos pasos:

1. Crea un directorio biz para almacenar los scripts de configuración
2. Obtén los archivos de configuración del cliente de la API de WhatsApp Business
3. Configura la variable de entorno WA_API_VERSION
4. Inicia el cliente de la API de WhatsApp Business
5. Verifica que los contenedores se estén ejecutando
6. Ejecuta una comprobación de estado
7. Registra el cliente de la API de WhatsApp Business

Una vez que hayas configurado por completo tu instancia, podrás optar por actualizarla. Para desinstalar el cliente, sigue estos pasos.

Antes de empezar

Antes de empezar, necesitarás completar lo siguiente:

Otros requisitos previos

Asegúrate de configurar una cuenta de prueba local en un entorno de desarrollo. Es útil para un desarrollo rápido y para poner a prueba nuevos lanzamientos.

Configuración inicial del cliente de la API de WhatsApp Business

~/biz $ export WA_API_VERSION=CURRENT-WA-API-VERSION

    wacore:
    image: docker.whatsapp.biz/coreapp:v${WA_API_VERSION:?Run docker-compose with env var WA_API_VERSION (ex. WA_API_VERSION=2.31.4 docker-compose <command> <options>)}

~/biz $ docker-compose up -d

Creating volume "biz_whatsappMedia" with local driver
Creating volume "biz_mysqlData" with local driver
Creating biz_db_1 ... done
Creating biz_wacore_1 ... done
Creating biz_waweb_1  ... done

~/biz $ docker-compose ps

~/biz $ docker-compose ps
     Name                    Command               State                   Ports
-------------------------------------------------------------------------------------------------
biz_db_1       docker-entrypoint.sh mysqld      Up      0.0.0.0:33060->3306/tcp, 33060/tcp
biz_wacore_1   /opt/whatsapp/bin/wait_on_ ...   Up      6250/tcp, 6251/tcp, 6252/tcp, 6253/tcp
biz_waweb_1    /opt/whatsapp/bin/wait_on_ ...   Up      0.0.0.0:9090->443/tcp

{
    "health": {
        "gateway_status": "unregistered"
    }
}

Actualización del cliente de la API de WhatsApp Business

Paso 1: Cambia la variable de entorno WA_API_VERSION por la nueva versión

La variable de entorno WA_API_VERSION debe actualizarse a la nueva versión mediante lo siguiente:

export WA_API_VERSION=new-whatsapp-version

Si haces una actualización a la versión 2.33.4, el comando de ejemplo sería el siguiente:

~/biz $ export WA_API_VERSION=2.33.4

Paso 2: Reinicia los contenedores Docker

Reinicia los contenedores Docker ejecutando lo siguiente:

docker-compose up -d

El resultado se verá como en el siguiente ejemplo:

biz_db_1 is up-to-date
Recreating biz_wacore_1 ... done
Recreating biz_waweb_1  ... done

Para usuarios de la base de datos MySQL que actualizan a la versión v2.23.x o a una superior

Ahora puedes utilizar un servicio de actualización de versión de base de datos que te permite actualizar la base de datos con la app en ejecución y así evitar tiempo de inactividad.

Paso 1: Descarga los archivos de configuración

El archivo dbupgrade-compose.yml tiene campos que indican la versión del contenedor.

Ejemplo:

services:
  dbupgrade:
    image: docker.whatsapp.biz/coreapp:v${WA_API_VERSION:-2.21.3}

Paso 2: Inicia el contenedor

Para actualizar la versión de una instalación, inicia el contenedor dbupgrade-service con la variable de entorno WA_API_VERSION configurada con el valor de la versión más reciente:

WA_API_VERSION=new-whatsapp-version docker-compose -f dbupgrade-compose.yml up -d

Nota: Si utilizas una orquestación que reinicia el contenedor al salir, independientemente del código de salida, inicia el servicio con la variable de entorno EXIT_ON_SUCCESS configurada en FALSE para evitar salir del contenedor cuando el código de salida sea 0.

Paso 3: Espera a que la actualización finalice

Si la base de datos se actualiza con éxito, el código del contenedor al salir será 0. Puedes utilizar el siguiente comando Docker para hacer un seguimiento del estado:

docker wait your-database-upgrade-container-name

El resultado devuelto será el código de salida del contenedor dbupgrade-service.

Paso 4: Reinicia los contenedores de la app principal y de la app web

Reinicia el contenedor Docker de la app web y el de la app principal con la variable de entorno WA_API_VERSION configurada con la versión más reciente:

WA_API_VERSION=new-whatsapp-version docker-compose up -d

Cómo desinstalar el cliente de la API de WhatsApp Business

Si debes eliminar todos los contenedores para restablecer el entorno de desarrollo, ejecuta el siguiente comando desde el directorio que contiene el archivo docker-compose.yml:

WA_API_VERSION={VERSION_NUMBER} docker-compose down

El resultado se verá como en el siguiente ejemplo:

Stopping biz_waweb_1  ... done
Stopping biz_wacore_1 ... done
Stopping biz_db_1     ... done
Removing biz_waweb_1  ... done
Removing biz_wacore_1 ... done
Removing biz_db_1     ... done

Si, además de los contenedores, quieres eliminar todos los volúmenes definidos en el archivo docker-compose.yml, ejecuta el comando down con el parámetro -v:

WA_API_VERSION={VERSION_NUMBER} docker-compose down -v

Solución de problemas

En los casos en que no se pueda utilizar WADebug o cuando al ejecutar la herramienta se devuelvan errores, ejecuta el siguiente comando para recopilar registros de todos los contenedores:

docker-compose logs > debug_output.txt

Para recopilar los registros de un servicio específico, agrega el nombre del servicio (waweb o wacore) al comando docker-compose logs:

docker-compose logs waweb > debug_output.txt

Puedes encontrar los registros en el archivo debug_output.txt en el directorio actual.

Más información

• Instalación de desarrollador: alta disponibilidad y multiconexión
• Instalación
• Configuraciones de producción