Référence on bouine

CLI

Mon, 01 Jan 0001 00:00:00 +0000

Commands

bouine serve --config /etc/bouine/config.yaml
bouine config validate <file>
bouine config schema
bouine completion bash|zsh|fish
bouine purge <url> --token <token>
bouine ban host_regex=example.com path_regex=^/api --token <token>
bouine refresh <url> --token <token>
bouine cluster peers
bouine version

--server defaults to 127.0.0.1:9000. All commands default to port 9000 so --server is optional when running locally.

API d'administration

Mon, 01 Jan 0001 00:00:00 +0000

Authentication

All write endpoints require a bearer token. See Authentication for full details on token resolution, environment variables, and config file setup.

Pass the token in requests:

curl -X POST http://127.0.0.1:9000/v1/purge \
 -H "Authorization: Bearer your-secret-token" \
 -H "Content-Type: application/json" \
 -d '{"url":"https://example.com/page"}'

Exempt endpoints (no token required)

These are always accessible without authentication — required for K8s probes and Prometheus scraping:

En-têtes de réponse

Mon, 01 Jan 0001 00:00:00 +0000

X-Cache

Indique comment la réponse a été servie.

Valeur	Description
`HIT`	Servi depuis le cache (frais)
`MISS`	Récupéré depuis l’origine et mis en cache
`STALE`	Servi depuis le cache (stale, dans la fenêtre stale-while-revalidate ou stale-if-error)
`BYPASS`	Cache contourné (no-store, no-cache, ou cache désactivé pour la route)
`REVALIDATED`	Requête conditionnelle à l’origine a renvoyé 304, servi depuis le cache avec une fraîcheur mise à jour

curl -sI http://localhost:8080/get | grep x-cache
# X-Cache: HIT

Age

L’âge de l’objet en cache en secondes, calculé comme le temps écoulé depuis l’en-tête Date de la réponse originale plus tout le temps passé dans les forward proxies upstream. Mis à jour à chaque cache hit.

Go SDK

Mon, 01 Jan 0001 00:00:00 +0000

The bouine Go SDK (pkg/bouineapi) provides typed methods for every admin API endpoint. It shares wire types with the Cobra CLI and the admin server, so there is no drift between the SDK and the API.