docs: add deployment guide - #126
Merged
Merged
Conversation
Document how VolX runs in production: the six-container Docker Compose stack on a single always-on server, the Cloudflare Tunnel exposure model (only the API published, no inbound ports), Docker Hub image registry with latest + git-sha tags, the gated CI -> build -> pull-deploy pipeline, deploy.sh behaviour, the runtime/secret configuration, and the on-chain keeper bridge.
Review feedback: the secrets section conflated CI build secrets with the server runtime .env. Split them into two tables (server .env vs GitHub Actions secrets), make explicit that the Docker Hub repos are public so the server pulls anonymously and DOCKER_USERNAME/PASSWORD are never written to the server .env, and note that the keeper timing constants are baked into the compose file rather than .env-overridable.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Add
docs/deployment.md— a dedicated production deployment guide, so "how VolX is deployed" lives in one place instead of scattered across the README.Contents
volx-*services (compose projectvolx-prod), which ports are published (only the API, loopback-only) and which stay internal.latest+ git-sha tags, server pulls (no source checkout).ci→deploy(build matrix → push → SSH-over-Cloudflare-Access → write.envfrom secrets →deploy.sh), with the concurrency/serialization guarantees.deploy.sh— the idempotent pull-and-apply (recreates only changed services)..env+ GitHub Actions secrets tables; the rotate-both-or-drift note.Notes