Docs

I want to…

GoalStart here
Try bouine locally in 5 minutesQuick start →
Deploy on Kubernetes with HelmDeploy on Kubernetes →
Replace Varnish or NGINXMigration guides →
Configure cache policy, TLS, or clusteringConfiguration →
Operate bouine in production (invalidation, monitoring, upgrades)Operations →
Understand the internalsArchitecture →
Contribute to bouineContributing →

Sections

  • Getting started — install, quick start, Docker, Kubernetes, and example configs.
  • Configuration — YAML reference, cache policy, storage tiers, TLS, clustering, and Helm chart values.
  • Operations — lifecycle, invalidation, monitoring, dashboard, Kubernetes ops, and troubleshooting.
  • Architecture — layered design, cache engine, storage, clustering, and performance.
  • Guides — migration from Varnish or NGINX, reverse proxy examples, and capacity planning.
  • Contributing — contributor workflow, codebase map, and security.
  • Reference — CLI commands, admin API, and response headers.