...
registry.brandbox.host/brandbox-product/runtime/puppeteer:latest
Enthaltene Software
Software | Version |
---|---|
Debian | 11 |
Nginx | 1.18 |
PHP | 8.1 |
Node.js | 14 |
Composer | 2.3 |
brandbox/component-puppeteer | 1.0.0 |
Lokale Konfiguration (Traefik)
Das Image kann in einer docker-compose.yml wie folgt eingebunden werden:
...
Umgebungsvariable | Wert |
---|---|
PUPPETEER_HOST | puppeteer.$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)
Bezeichnung | Beschreibung |
---|---|
source | Das zu rendernde HTML-Dokument,
|
target | Ein Datei-Pfad für die Ablage des erstellten mehrseitigen Dokuments |
timeout | Die Anzahl an Millisekunden, die der Renderprozess auf eine Reaktion wartet. Standardmäßig wird hier 60000 für 60 Sekunden gesetzt |
abort | Dieses 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)
Bezeichnung | Beschreibung |
---|---|
result | true für erfolgreiche Konvertierung, false im Fehlerfall |
log | Die Konsolen-Ausgabe von Puppeteer |
...