EqualifyEverything / equalify-reflow

docs(self-host): vendor-neutral deployment guide (#135)
The repo's README pitches Reflow as "maintained openly for any organisation," but docs/how-to/ only had a dev-environment guide and SSO recipe — nothing for operators standing up a real deployment of their own. New contributors evaluating the project had nowhere to go between `make dev` and "read the AGENTS.md plus every config field and figure it out yourself." This adds docs/how-to/self-host.md: a pragmatic, deliberately vendor-neutral walkthrough covering: - What you're running (api-gateway + docling-serve + Redis + S3 + AI). - The three reasonable container layouts (sidecar / separate services / separate boxes) and when each makes sense. - The minimum env-var set, called out by intent rather than dumped. - Which six values are sensitive and need a secret-injection mechanism. - A complete docker-compose.self-host.yml as a single-VM starting point. - A platform-agnostic checklist for k8s/ECS/Nomad/Swarm. - Multiple options for every external dependency so AWS isn't implicit: MinIO/Garage/R2/B2/Wasabi/Floci alongside S3 for storage; Anthropic API direct alongside Bedrock for AI. - Which health endpoint goes on liveness vs readiness probes. - Pointers into architecture.md / authentication.md / configure-sso.md for anything deeper than the quickstart. Linked from AGENTS.md's "Common workflows" so the next contributor notices it. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Blake Bertuccelli-Booth Blake Bertuccelli-Booth committed on May 15, 2026, 06:49 PM
Showing 2 changed files +278 additions -0 deletions
Browse files at this commit →