BonVoyage API Gateway

BonVoyage is a standalone API gateway with a C++/Seastar data plane and a Go control plane. Its operating model keeps request ownership shard-local, turns declarative configuration into immutable snapshots, and makes rejected changes visible through validation and ACK/NACK outcomes.

Pre-release documentation

This site describes the staging candidate for the first public release. It is not yet a supported production release, and no public-source license is granted until the approved LICENSE and release notices are published.

Run the local stack

From the repository root:

docker compose -f deploy/compose/local.yml up --build

Then verify the fixed readiness route:

curl --fail --show-error http://127.0.0.1:8080/bonvoyage/ready

The expected response is ready. Continue with the Docker quickstart for health, metrics, shutdown, and troubleshooting checks.

Choose your path

Goal	Start with
Evaluate locally	Requirements and Docker quickstart
Verify a running stack	Verify a local deployment
Validate desired-state YAML offline	Validate a configuration
Format accepted YAML without changing its meaning	Format a configuration
Look up release-matched help for a field	Explain a configuration field
Compare two accepted configurations without exposing values	Compare configurations
Check or migrate an explicit configuration-schema pair	Migrate a configuration
Preview an immutable artifact and local changes	Preview a configuration
Understand the runtime	System model
Understand safe changes	Configuration lifecycle
Look up every YAML parameter, constraint, and example	YAML parameter reference
Review tool behavior	Configuration authoring contract
Integrate release-matched field completion	Configuration completion metadata
Reuse compiler-backed configuration fragments	Configuration snippets
Present stable configuration failures and remediation	Configuration diagnostics
Replay accepted and rejected YAML decisions	Configuration test corpus
Review assistant safety, consent, and claim boundaries	Assistant skill contract
Inspect the shared adversarial assistant evaluation corpus	Assistant skill evaluations
Install the release-bound ChatGPT/Codex authoring skill	ChatGPT and Codex configuration skill
Install the release-bound Claude Code authoring skill	Claude Code configuration skill
Check current scope	Supported capabilities
Report a defect or vulnerability	Support and security

Evidence boundary

Performance and security claims belong to an exact source revision, artifact, configuration, workload, and environment. This documentation does not turn shared-host directional measurements into dedicated-hardware claims, and it does not claim universal superiority over NGINX, Envoy, or another gateway.