Docker und Compose
Run the control plane and the data plane in containers with Docker Compose, on Linux or a Mac: start, first-login credentials, upgrade and uninstall.
Welche Version Sie installieren
Die öffentliche Version ist eine Entwicklungsversion mit dem Namen 0.3.0-dev. Ihr Name bleibt gleich: Jede Veröffentlichung ersetzt die vorherige, und eine Build-Kennung unterscheidet zwei Builds. Eine stabile Version gibt es noch nicht: Sie wird erst veröffentlicht, wenn jedes System und jedes Paket durchgängig getestet wurde. Die Befehle auf dieser Seite installieren deshalb aus dem Kanal dev. Eine Entwicklungsversion kann Fehler enthalten: Probieren Sie sie auf einer Test-Site aus, bevor Sie sich darauf verlassen.
At a glance
- One image runs the control plane (console and API) or the data plane, selected with TOUTWAF_ROLE; the compose file starts one of each.
- The files (the deploy folder) come with your ToutWAF distribution: they are not in the public repository, which holds binaries and installers only.
- On the very first start, the toutwaf-cp logs show once the secret console address and the generated username and password: copy them, they are written nowhere else.
- The console is published on 127.0.0.1 only: to reach it remotely, use an SSH tunnel, a VPN or a TLS reverse proxy with an allow-list. Never publish 9443 on a public interface.
The commands, step by step
Docker Compose auf Mac oder Linux
Docker Compose unter Linux oder auf einem Mac (Docker Desktop, OrbStack, Colima) mit dem All-in-one-Image (Control Plane und Data Plane). Die Dateien kommen mit Ihrer ToutWAF-Distribution (der Ordner deploy, der nicht im öffentlichen Repository liegt: Dieses enthält nur Binärdateien und Installer). Das Image enthält vorkompilierte Binärdateien je Architektur (bin/amd64 oder bin/arm64), und es wird noch kein Image in einer Registry veröffentlicht. Nur auf Linux amd64 getestet; auf einem echten Mac ungetestet, wo die hinter Docker Desktop sichtbare Client-IP die Docker-Gateway-Adresse ist. Die einmaligen Zugangsdaten erscheinen einmal im Log der Control Plane.
cd deploy/docker
# bin/amd64/{toutwaf-cp,toutwaf-dp,toutwafctl} (Intel Mac, Linux x86-64)
# bin/arm64/{toutwaf-cp,toutwaf-dp,toutwafctl} (Apple Silicon, Linux ARM)
cp .env.example .env
docker compose up -d --build
docker compose logs toutwaf-cpAktualisieren (Container)
Erstellen Sie zuerst eine Sicherung. Die Update-Schaltfläche der Konsole kann in einem Container nicht funktionieren: Ersetzen Sie die Binärdateien im Ordner bin (oder das Image, sobald eines veröffentlicht ist) und bauen Sie neu; die Volumes und damit Ihre Daten bleiben erhalten.
docker compose up -d --buildDeinstallieren
Der erste Block entfernt die Dienste, die Binaries und die von ToutWAF angelegten Firewall-Regeln und behält Ihre Daten. Der zweite löscht zusätzlich Konfiguration, Daten und Logs.
docker compose downdocker compose down -vWhat is not verified
We prefer to say it plainly.
- Tested end to end on Linux x86-64 only. An Intel Mac, an Apple Silicon Mac (linux/arm64) and Windows with Docker Desktop are not tested on real hardware.
- No image is published to a registry: building needs the prebuilt release binaries. Native macOS is not provided.
- The in-console update and the firewall helper do not work in a container: you update by replacing the image. A single control-plane instance, with SQLite.