Docker en 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.
Welke versie u installeert
De openbare versie is een ontwikkelversie met de naam 0.3.0-dev. De naam blijft gelijk: elke publicatie vervangt de vorige en een build-id onderscheidt twee builds. Er bestaat nog geen stabiele versie: die wordt pas gepubliceerd als elk systeem en elk pakket van begin tot eind is getest. De opdrachten op deze pagina installeren daarom vanuit het kanaal dev. Een ontwikkelversie kan fouten bevatten: probeer haar eerst op een testsite voordat u erop vertrouwt.
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 op Mac of Linux
Docker Compose op Linux of een Mac (Docker Desktop, OrbStack, Colima), met de alles-in-één-image (control plane en data plane). De bestanden komen met uw ToutWAF-distributie (de map deploy, die niet in de openbare repository staat: die bevat alleen binaries en installers). De image bevat vooraf gecompileerde binaries per architectuur (bin/amd64 of bin/arm64) en er wordt nog geen image in een registry gepubliceerd. Alleen getest op Linux amd64; ongetest op een echte Mac, waar het geziene client-IP achter Docker Desktop het adres van de Docker-gateway is. De eenmalige inloggegevens verschijnen één keer in het log van de 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-cpBijwerken (containers)
Maak eerst een back-up. De updateknop van de console kan in een container niet werken: vervang de binaries in de map bin (of de image, zodra er een is gepubliceerd) en bouw opnieuw; de volumes, dus uw gegevens, blijven behouden.
docker compose up -d --buildVerwijderen
Het eerste blok verwijdert de services, de binaries en de door ToutWAF toegevoegde firewallregels en bewaart uw data. Het tweede wist ook configuratie, data en 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.