documentation

how to run groundshade.

Start with getting started if you've never deployed it. Jump to operating for daily workflows and the tuning table. Architecture explains what happens on the request path. Search with the button in the nav, or press /.

• 01 getting started Drop GroundShade in behind Caddy, nginx, or HAProxy. Five minutes to a working request path.
• 02 operating groundshade Daily operator guide. Configuration, defense levels, fast-lane allowlists, the admin dashboard, the metrics reference, and the tuning table.
• 03 deployment hardening Pre-deploy security checklist. Admin port, trusted proxies, body limits, and reload safety. Read this once before publishing.
• 04 behind cloudflare Running GroundShade behind Cloudflare orange-cloud. Required trusted_proxies, what works, what gets silenced, and the Caddy recipe.
• 05 architecture The mental model. Workspace shape, request lifecycle, in-memory state surfaces, concurrency model, and explicit non-goals.
• 06 building from source Build GroundShade locally or for production. Local Docker images, multi-arch builds, Cargo profiles, cache strategies, and image layout.
• 07 faq Common GroundShade questions. PoW choice, JA4 setup behind Caddy, dashboard exposure, Cloudflare compatibility, healthcheck cascades, and self-protection.

These pages are the source of truth. Source code lives at codeberg.org/groundshade/groundshade; the v1 implementation spec lives in SPEC.md next to the code.