# bouine

> Bouine is a cloud-native HTTP cache in Go - RFC9111 compliant, zero-alloc hit path, gossip clustering, no external K/V store.

- [Comparer bouine](https://bouine.org/fr/compare/): Side-by-side comparison of bouine against Envoy, NGINX, HAProxy, Varnish, and Caddy — across DevOps, SRE, and Software Engineer criteria.
- [Documentation](https://bouine.org/fr/docs/): Documentation complète pour les utilisateurs et contributeurs : installation, configuration, exploitation, dépannage et extension de bouine en toute sécurité.

## Comparer bouine

> Side-by-side comparison of bouine against Envoy, NGINX, HAProxy, Varnish, and Caddy — across DevOps, SRE, and Software Engineer criteria.


## Documentation

> Documentation complète pour les utilisateurs et contributeurs : installation, configuration, exploitation, dépannage et extension de bouine en toute sécurité.

- [Démarrage](https://bouine.org/fr/docs/getting-started/): Installez bouine, exécutez-le localement, mettez en cache votre première réponse, déployez avec Docker ou Kubernetes et adaptez des exemples de configuration.
- [Configuration](https://bouine.org/fr/docs/configuration/): Référence de configuration YAML de bouine : listeners, stockage, origin pools, routes, cache, cluster, TLS et observabilité.
- [Opérations](https://bouine.org/fr/docs/operations/): Runbook pour exploiter bouine : cycle de vie, authentification, invalidation du cache, supervision, dashboard, opérations Kubernetes et dépannage.
- [Architecture](https://bouine.org/fr/docs/architecture/): How bouine is structured internally: listeners, pipeline, storage, cache engine, origin pools, clustering, and observability.
- [Guides](https://bouine.org/fr/docs/guides/): Guides pas à pas pour migrer depuis Varnish ou NGINX, modèles d'intégration et capacity planning.
- [Contribuer](https://bouine.org/fr/docs/contributing/): Guide du contributeur couvrant la configuration locale, le flux de développement, le format des commits, les vérifications de pull request et les standards du projet.
- [Référence](https://bouine.org/fr/docs/reference/): Référence de la CLI, de l'API d'administration et des en-têtes de réponse.
- [FAQ](https://bouine.org/fr/docs/faq/): Frequently asked questions about bouine.

### Démarrage

> Installez bouine, exécutez-le localement, mettez en cache votre première réponse, déployez avec Docker ou Kubernetes et adaptez des exemples de configuration.

- [Installation](https://bouine.org/fr/docs/getting-started/install/): Installez bouine depuis Docker Hub, les binaires de releases GitHub ou les sources, et comprenez les prérequis de chaque méthode.
- [Démarrage rapide](https://bouine.org/fr/docs/getting-started/first-cache/): Démarrez un petit serveur d'origine, placez bouine devant celui-ci et vérifiez le comportement MISS puis HIT via les en-têtes et les métriques.
- [Docker](https://bouine.org/fr/docs/getting-started/docker/): Exécutez l'image Docker officielle de bouine, montez une configuration personnalisée et construisez des images multi-architectures rapides localement.
- [Kubernetes](https://bouine.org/fr/docs/getting-started/kubernetes/): Déployez bouine sur Kubernetes avec Helm, configurez le gossip StatefulSet, vérifiez la découverte des pairs et effectuez des rolling updates.
- [Example configurations](https://bouine.org/fr/docs/getting-started/examples/): Ready-to-adapt bouine YAML examples for static sites, self-served static files, API gateways, bouine-in-front-of-Cloudflare, and e-commerce routes.

### Configuration

> Référence de configuration YAML de bouine : listeners, stockage, origin pools, routes, cache, cluster, TLS et observabilité.

- [Politique de cache](https://bouine.org/fr/docs/configuration/cache-policy/): Understand how bouine chooses TTLs, overrides them per-route, serves stale content, applies negative caching, jitters expirations, refreshes proactively before expiry, and builds cache keys.
- [Streaming et réponses live](https://bouine.org/fr/docs/configuration/streaming/): Comment bouine streame les corps de réponse, sert les Server-Sent Events et shedde la charge excessive quand l'origine est lente.
- [Servir des fichiers statiques](https://bouine.org/fr/docs/configuration/static-files/): Serve files directly from a local directory without a separate origin server. Path traversal defense, MIME types, ETags, range requests, and optional cache integration.
- [Storage tiers](https://bouine.org/fr/docs/configuration/storage/): Understand bouine's hot and warm storage tiers, SIEVE eviction, capacity planning, and operational tuning.
- [TLS](https://bouine.org/fr/docs/configuration/tls/): Configure TLS termination with certificate management, SNI, and automatic reload.
- [Clustering](https://bouine.org/fr/docs/configuration/cluster-modes/): Configure bouine clustering: consistency modes, gossip membership, peer fetch, mTLS, invalidation propagation, and metrics.
- [Helm chart reference](https://bouine.org/fr/docs/configuration/helm/): All configurable values for the bouine Helm chart with defaults, descriptions, and production deployment tips.
- [Fonctionnalités expérimentales](https://bouine.org/fr/docs/configuration/experimental/): Opt-in experimental features that may become stable in future releases.

### Opérations

> Runbook pour exploiter bouine : cycle de vie, authentification, invalidation du cache, supervision, dashboard, opérations Kubernetes et dépannage.

- [Cycle de vie](https://bouine.org/fr/docs/operations/lifecycle/): Start, stop, and drain bouine in production and Kubernetes.
- [Authentification](https://bouine.org/fr/docs/operations/authentication/): Configure and retrieve the admin bearer token protecting all write endpoints.
- [Invalidation du cache](https://bouine.org/fr/docs/operations/cache-invalidation/): Purge by URL, predicate ban, surrogate-key invalidation, and soft-purge refresh — and how they propagate across cluster peers.
- [Modes de cohérence du cluster](https://bouine.org/fr/docs/operations/cluster-modes/): Verify, diagnose, and switch between strong and eventual cluster consistency modes.
- [Supervision](https://bouine.org/fr/docs/operations/monitoring/): Prometheus metrics, access log fields, OpenTelemetry tracing, and admin API endpoints for observing bouine.
- [Guide d'observabilité](https://bouine.org/fr/docs/operations/observability/): End-to-end guide for wiring Prometheus, Loki, Tempo, and Grafana Alloy to collect metrics, logs, and traces from a bouine cluster.
- [Opérations Kubernetes](https://bouine.org/fr/docs/operations/kubernetes/): Scale, update, and verify cluster health for bouine running on Kubernetes.
- [Tableau de bord](https://bouine.org/fr/docs/operations/dashboard/): Access the built-in operator dashboard for live cache metrics, route performance, cluster health, and one-click invalidation.
- [Propagation Cloudflare CDN](https://bouine.org/fr/docs/operations/cloudflare/): Forward bouine cache invalidation operations to Cloudflare's edge so both caches stay in sync.
- [Dépannage](https://bouine.org/fr/docs/operations/troubleshooting/): Troubleshoot common bouine production issues: cache misses, cluster problems, rolling restart failures, invalidation, and origin health.

### Architecture

> How bouine is structured internally: listeners, pipeline, storage, cache engine, origin pools, clustering, and observability.


### Guides

> Guides pas à pas pour migrer depuis Varnish ou NGINX, modèles d'intégration et capacity planning.

- [Migration depuis NGINX](https://bouine.org/fr/docs/guides/nginx-migration/): Migrate from NGINX proxy_cache to bouine by mapping directives, cache keys, stale serving, and observability concepts.
- [Exemples de reverse proxy](https://bouine.org/fr/docs/guides/reverse-proxies/): Deploy bouine in front of Caddy, Traefik, HAProxy, and nginx with ready-to-adapt configuration examples.
- [Migration depuis Varnish](https://bouine.org/fr/docs/guides/varnish-migration/): Complete migration guide from Varnish Cache to bouine: conceptual mapping, VCL vs YAML side-by-side, parity tables, behavioral differences, and FAQ.
- [Planification de capacité](https://bouine.org/fr/docs/guides/capacity-planning/): Size bouine for your workload: estimate hot and warm tier capacity, choose cluster mode and replica count, and plan for growth.
- [Benchmarks](https://bouine.org/fr/docs/guides/benchmarks/): Benchmark methodology and results comparing bouine against Varnish, NGINX, and Envoy across cache hit, miss, and mixed workloads.
- [Production readiness checklist](https://bouine.org/fr/docs/guides/production-checklist/): Checklist to review before deploying bouine to production.
- [Compatibilité avec les service mesh](https://bouine.org/fr/docs/guides/service-mesh/): Run bouine alongside Istio, Linkerd, and Cilium service meshes.

### Contribuer

> Guide du contributeur couvrant la configuration locale, le flux de développement, le format des commits, les vérifications de pull request et les standards du projet.

- [Guide du code](https://bouine.org/fr/docs/contributing/codebase/): Carte des packages bouine orientée contributeur, couches, bonnes premières tâches et règles pour modifier le comportement de cache en toute sécurité.
- [Sécurité](https://bouine.org/fr/docs/contributing/security/): Signalement de sécurité, périmètre pris en charge, classes de vulnérabilités à fort impact et checklist de durcissement opérationnel pour bouine.

### Référence

> Référence de la CLI, de l'API d'administration et des en-têtes de réponse.

- [CLI](https://bouine.org/fr/docs/reference/cli/): bouine command-line interface reference.
- [API d'administration](https://bouine.org/fr/docs/reference/api/): Admin API endpoints, authentication, and response formats.
- [En-têtes de réponse](https://bouine.org/fr/docs/reference/headers/): En-têtes de réponse HTTP ajoutés par bouine.
- [Go SDK](https://bouine.org/fr/docs/reference/go-sdk/): Use the bouine Go SDK to manage cache invalidation, check health, and inspect cluster peers programmatically.