Configurazione dello sviluppatore: Istanza singola

Questo documento mostra la modalità di configurazione di un'istanza singola del client dell'API di WhatsApp Business su una macchina per sviluppatore per scopi di test. Per una configurazione di produzione, segui le istruzioni pertinenti elencate in Configurazioni di produzione.

Per configurare inizialmente un'istanza singola, controlla la nostra lista di requisiti e segui questi passaggi:

1. Creazione di una directory biz per gli script di configurazione
2. Acquisizione dei file di configurazione del client dell'API di WhatsApp Business
3. Impostazione della variabile ambientale WA_API_VERSION
4. Avvio del client dell'API di WhatsApp Business
5. Verifica dell'esecuzione dei contenitori
6. Esecuzione di un controllo integrità
7. Registrazione del client dell'API di WhatsApp Business

Dopo aver configurato completamente l'istanza, puoi scegliere di aggiornarla. Per disinstallare il client, segui questi passaggi.

Prima di iniziare

Prima di iniziare avrai bisogno di completare le seguenti azioni:

Altri prerequisiti

Assicurati di configurare un account test in locale in un ambiente di sviluppo. Servirà per uno sviluppo rapido e per testare nuove uscite.

Configurazione iniziale del client dell'API di 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"
    }
}

Aggiornamento del client dell'API di WhatsApp Business

Passaggio 1: modifica della variabile ambientale WA_API_VERSION con la nuova versione

La variabile ambientale WA_API_VERSION deve essere aggiornata al nuovo numero di versione mediante:

export WA_API_VERSION=new-whatsapp-version

Se stai eseguendo l'aggiornamento alla versione 2.33.4, il comando di esempio sarà:

~/biz $ export WA_API_VERSION=2.33.4

Passaggio 2: riavvio dei contenitori Docker

Riavvia i contenitori Docker eseguendo il seguente comando:

docker-compose up -d

L'output risultante dovrebbe essere simile al seguente:

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

Per gli utenti del database MySQL che eseguono l'aggiornamento alla versione v2.23.x e successive

Ora puoi avvalerti di un servizio di aggiornamento database per aggiornare il tuo database mentre l'app è ancora in esecuzione, evitando così tempi di inattività.

Passaggio 1: download del file di configurazione

Il file dbupgrade-compose.yml contiene dei campi indicanti la versione dei contenitori.

Esempio:

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

Passaggio 2: avvio del contenitore

Per aggiornare un'installazione, avvia il contenitore dbupgrade-service con la variabile ambientale WA_API_VERSION impostata sull'ultima versione:

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

Nota: se utilizzi un'orchestrazione che riavvia il contenitore dopo l'uscita verificatasi indipendentemente dal codice di uscita, avvia il servizio con la variabile ambientale EXIT_ON_SUCCESS impostata su FALSE per impedire l'uscita dal contenitore quando il codice di uscita è 0.

Passaggio 3: attesa della conclusione dell'aggiornamento

Se l'aggiornamento del database è avvenuto correttamente, il contenitore uscirà con codice 0. Puoi usare il comando Docker seguente per monitorare lo stato:

docker wait your-database-upgrade-container-name

Questa operazione genererà il codice di uscita del contenitore dbupgrade-service.

Passaggio 4: riavvio dei contenitori Coreapp e Webapp

Riavvia i contenitori Docker Coreapp e Webapp con la variabile ambientale WA_API_VERSION impostata sull'ultima versione:

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

Disinstallazione del client dell'API di WhatsApp Business

Se è necessario reimpostare l'ambiente di sviluppo rimuovendo tutti i contenitori, esegui il seguente comando dalla directory che contiene il file docker-compose.yml:

WA_API_VERSION={VERSION_NUMBER} docker-compose down

L'output risultante dovrebbe essere simile al seguente:

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

Per eliminare tutti i volumi definiti nel file docker-compose.yml in aggiunta ai contenitori, esegui il comando down con il parametro -v:

WA_API_VERSION={VERSION_NUMBER} docker-compose down -v

Risoluzione dei problemi

In casi in cui non è possibile utilizzare WADebug o l'esecuzione dello strumento restituisce degli errori, esegui il comando seguente per raccogliere i registri da tutti i contenitori:

docker-compose logs > debug_output.txt

Per raccogliere i registri di un determinato servizio, aggiungi il nome del servizio (waweb o wacore) al comando docker-compose logs:

docker-compose logs waweb > debug_output.txt

I registri sono disponibili nel file debug_output.txt nella directory corrente.

Ulteriori informazioni

• Configurazione per sviluppatore: High Availability e Multiconnect
• Installazione
• Configurazioni di produzione