Simplify deployment docs with GHCR images and Docker Compose#9
Merged
Simplify deployment docs with GHCR images and Docker Compose#9
Conversation
- Rewrite full stack guide: GHCR images as primary option, source build as dev option - Remove manual mvn package step (multi-stage Dockerfile handles builds) - Add version pinning guidance for production deployments - Update self-hosting guide with GHCR, source build, and full-stack options https://claude.ai/code/session_01KUZof47HegFKWBxfFjcSia
- Rename second 'Option B' to 'Option C: Running from source' - Add REDIS_PASSWORD to cycles-server in GHCR docker-compose example https://claude.ai/code/session_01KUZof47HegFKWBxfFjcSia
5 tasks
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
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.
Summary
This PR updates the deployment documentation to prioritize Docker Compose with pre-built GHCR images as the recommended path, reducing friction for end users who don't have Java/Maven installed. It also clarifies the different deployment options and adds health check verification steps.
Key Changes
Reorganized deployment options in both quickstart guides:
Updated
deploying-the-full-cycles-stack.md:build: context:toimage: ghcr.io/runcycles/...for both cycles-server and cycles-adminADMIN_API_KEYconfigurable via environment variable with sensible defaultmvn clean packagebuild steps from the quick start pathdocker-compose.full-stack.ymlUpdated
self-hosting-the-cycles-server.md:docker-compose.prod.ymlas the recommended quick startdocker-compose.full-stack.ymlvariants for running with Admin ServerNotable Details
cycles-serverandcycles-server-adminrepositories and how they work togetherhttps://claude.ai/code/session_01KUZof47HegFKWBxfFjcSia