Docker e 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.
A versão que instala
A versão pública é uma versão de desenvolvimento, chamada 0.3.0-dev. O nome não muda: cada publicação substitui a anterior e um identificador de compilação distingue duas compilações. Ainda não existe nenhuma versão estável: só será publicada quando cada sistema e cada pacote tiverem sido testados de ponta a ponta. Por isso, os comandos desta página instalam a partir do canal dev. Uma versão de desenvolvimento pode conter erros: experimente-a num site de teste antes de depender dela.
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 em Mac ou Linux
Docker Compose em Linux ou num Mac (Docker Desktop, OrbStack, Colima), com a imagem tudo em um (plano de controlo e plano de dados). Os ficheiros vêm com a sua distribuição ToutWAF (a pasta deploy, que não está no repositório público, o qual só contém binários e instaladores). A imagem inclui binários pré-compilados por arquitetura (bin/amd64 ou bin/arm64) e ainda não é publicada nenhuma imagem num registo. Testada apenas em Linux amd64; não testada num Mac real, onde o IP de cliente visto atrás do Docker Desktop é o endereço do gateway do Docker. As credenciais de utilização única aparecem uma só vez no registo do plano de controlo.
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-cpAtualizar (contentores)
Faça primeiro uma cópia de segurança. O botão de atualização da consola não pode funcionar num contentor: substitua os binários da pasta bin (ou a imagem, quando existir uma publicada) e reconstrua; os volumes, ou seja, os seus dados, são mantidos.
docker compose up -d --buildDesinstalar
O primeiro bloco remove os serviços, os binários e as regras de firewall adicionadas pelo ToutWAF, e mantém os seus dados. O segundo apaga também a configuração, os dados e os registos.
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.