Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

registry.brandbox.host/brandbox-product/runtime/puppeteer:latest

Enthaltene Software

SoftwareVersion
Debian11
Nginx1.18
PHP8.1
Node.js14
Composer2.3
brandbox/component-puppeteer1.0.0

Lokale Konfiguration (Traefik)

Das Image kann in einer docker-compose.yml wie folgt eingebunden werden:

...

UmgebungsvariableWert
PUPPETEER_HOSTpuppeteer.$COMPOSE_PROJECT_NAME.local.brandbox.de  (wie in docker-compose.yml definiert)
PUPPETEER_PROTOCOL https


Cluster-Konfiguration (Kubernetes)

  • Es muss ein Deployment mit dem Image registry.brandbox.host/brandbox-product/runtime/puppeteer:latest eingerichtet werden
  • Es muss ein Service mit dem Namen service-puppeteer eingerichtet werden, der auf dieses Deployment verweist

...

Diese Standardwerte existieren bereits im Rancher-Manager und werden beim Redeploy über die Gitlab-Pipeline automatisch gesetzt.

Verwendung

Das Image stellt eine einfache Rest-Schnittstelle bereit, mit der HTML-Dokumente an Puppeteer übergeben werden können:

https://service-url/puppeteer?source=SOURCE&target=TARGET

Parameter (GET)

BezeichnungBeschreibung
source

Das zu rendernde HTML-Dokument,

targetEin Datei-Pfad für die Ablage des erstellten mehrseitigen Dokuments
timeoutDie Anzahl an Millisekunden, die der Renderprozess auf eine Reaktion wartet. Standardmäßig wird hier 60000 für 60 Sekunden gesetzt
abortDieses Argument muss entweder weggelassen oder gesetzt werden. Falls gesetzt, wird der Render-Prozess bei einem Fehler sofort abgebrochen, falls es nicht gesetzt wurde, werden Fehlermeldungen zwar protokolliert aber übergangen.

Rückgabewerte (JSON)

BezeichnungBeschreibung
result

true für erfolgreiche Konvertierung, false im Fehlerfall

logDie Konsolen-Ausgabe von Puppeteer

...