Entwickler-Setup: Einzelinstanz

In diesem Dokument wird gezeigt, wie du für Testzwecke eine Einzelinstanz des WhatsApp Business API-Client auf einem Entwicklercomputer einrichtest. Befolge für ein Produktions-Setup die entsprechenden Anweisungen unter Produktions-Setups.

Beim erstmaligen Setup einer Einzelinstanz lies dir die Liste der Anforderungen durch und führe die folgenden Schritte aus:

1. Ein biz-Verzeichnis für die Setup-Skripts erstellen
2. Die Konfigurationsdateien für den WhatsApp Business API-Client abrufen
3. Die Umgebungsvariable WA_API_VERSION festlegen
4. Den WhatsApp Business API-Client starten
5. Verifizieren, dass die Container ausgeführt werden
6. Eine Systemdiagnose durchführen
7. Den WhatsApp Business API-Client registrieren

Nachdem das Setup deiner Instanz vollständig abgeschlossen ist, kannst du die Instanz upgraden. Mit diesen Schritten kannst du den Client deinstallieren.

Bevor du beginnst

Bevor du beginnst, musst du die folgenden Aufgaben ausführen:

Weitere Voraussetzungen

Vergewissere dich, dass du ein lokales Testkonto in einer Entwicklungsumgebung eingerichtet hast. Dies ermöglicht eine schnelle Entwicklung und das Testen neuer Versionen.

Erst-Setup des WhatsApp Business API-Client

~/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"
    }
}

Upgrade des WhatsApp Business API-Clients

Schritt 1: Die Umgebungsvariable WA_API_VERSION in die neue Version ändern

Die Umgebungsvariable WA_API_VERSION sollte auf die neue Version aktualisiert werden. Verwende hierfür:

export WA_API_VERSION=new-whatsapp-version

Bei einem Upgrade auf Version 2.33.4 lautet der Befehl beispielsweise wie folgt:

~/biz $ export WA_API_VERSION=2.33.4

Schritt 2: Die Docker-Container neu starten

Starte die Docker-Container neu, indem du folgenden Code ausführst:

docker-compose up -d

Die Ausgabe sollte in etwa wie folgt aussehen:

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

Für MySQL-Datenbanknutzer, die ein Upgrade auf Version v2.23.x und höher durchführen

Dir steht nun ein Datenbankaktualisierungsdienst zur Verfügung, mit dem du deine Datenbank bei ausgeführter Anwendung aktualisieren kannst, um Ausfallzeiten zu vermeiden.

Schritt 1: Die Konfigurationsdatei herunterladen

Die Datei dbupgrade-compose.yml beinhaltet Felder mit Angaben zur Containerversion.

Beispiel:

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

Schritt 2: Den Container starten

Starte für ein Upgrade der Installation den Container „dbupgrade-service“, während die Umgebungsvariable WA_API_VERSION auf die aktuellste Version festgelegt ist:

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

Hinweis: Wenn du eine Orchestrierung verwendest, mit welcher der Container beim Beenden unabhängig vom Exit-Code neu gestartet wird, solltest du die Umgebungsvariable EXIT_ON_SUCCESS auf FALSE festlegen, wenn du den Dienst startest. So vermeidest du, dass der Container beendet wird, wenn der Exit-Code 0 lautet.

Schritt 3: Warten, bis das Upgrade abgeschlossen ist

Verläuft das Datenbank-Upgrade erfolgreich, wird der Container mit dem Code 0 beendet. Mit dem folgenden Docker-Befehl kannst du den Status nachverfolgen:

docker wait your-database-upgrade-container-name

Hiermit wird der Exit-Code des Containers „dbupgrade-service“ ausgegeben.

Schritt 4: Coreapp- und Webapp-Container neu starten

Starte die Coreapp- und Webapp-Docker-Container neu, während für die Umgebungsvariable WA_API_VERSION auf die aktuellste Version festgelegt ist:

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

Deinstallation des WhatsApp Business API-Clients

Wenn du deine Entwicklungsumgebung durch Entfernen aller Container zurücksetzen musst, führe den folgenden Befehl in dem Verzeichnis aus, das die Datei docker-compose.yml enthält:

WA_API_VERSION={VERSION_NUMBER} docker-compose down

Die Ausgabe sollte in etwa wie folgt aussehen:

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

Um zusätzlich zu den Containern alle in der Datei docker-compose.yml definierten Volumes zu entfernen, führe den Befehl down mit dem Parameter -v aus:

WA_API_VERSION={VERSION_NUMBER} docker-compose down -v

Problembehebung

Für den Fall, dass WADebug nicht verwendet werden kann oder bei Ausführung des Tools Fehler ausgegeben werden, führe zur Sammlung von Protokollen aus allen Containern den folgenden Befehl aus:

docker-compose logs > debug_output.txt

Hänge zum Sammeln von Protokollen eines bestimmten Dienstes den Dienstnamen (waweb oder wacore) an den Befehl docker-compose logs an:

docker-compose logs waweb > debug_output.txt

Du findest die Protokolle in der Datei debug_output.txt im aktuellen Verzeichnis.

Mehr erfahren

• Entwickler-Setup: Hochverfügbarkeit und Multiconnect
• Installation
• Produktions-Setups