Docker y 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.
La versión que se instala
La versión pública es una versión de desarrollo, llamada 0.3.0-dev. Su nombre no cambia: cada publicación sustituye a la anterior y un identificador de compilación distingue dos compilaciones. Todavía no existe ninguna versión estable: solo se publicará cuando cada sistema y cada paquete se hayan probado de extremo a extremo. Por eso, los comandos de esta página instalan desde el canal dev. Una versión de desarrollo puede contener errores: pruébela en un sitio de prueba antes de confiar en ella.
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 en Mac o Linux
Docker Compose en Linux o en un Mac (Docker Desktop, OrbStack, Colima), con la imagen todo en uno (plano de control y plano de datos). Los archivos vienen con su distribución de ToutWAF (la carpeta deploy, que no está en el repositorio público, que solo contiene binarios e instaladores). La imagen incluye binarios precompilados por arquitectura (bin/amd64 o bin/arm64) y aún no se publica ninguna imagen en un registro. Probada solo en Linux amd64; sin probar en un Mac real, donde la IP de cliente que se ve detrás de Docker Desktop es la de la puerta de enlace de Docker. Las credenciales de un solo uso aparecen una vez en el registro del plano de control.
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-cpActualizar (contenedores)
Haga primero una copia de seguridad. El botón de actualización de la consola no puede funcionar en un contenedor: sustituya los binarios de la carpeta bin (o la imagen, cuando se publique una) y reconstruya; los volúmenes, es decir sus datos, se conservan.
docker compose up -d --buildDesinstalar
El primer bloque elimina los servicios, los binarios y las reglas de cortafuegos añadidas por ToutWAF, y conserva sus datos. El segundo elimina además la configuración, los datos y los registros.
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.