Skip to content

Simplify deployment docs with GHCR images and Docker Compose#9

Merged
amavashev merged 2 commits intomainfrom
claude/docker-deployment-setup-Utjlk
Mar 12, 2026
Merged

Simplify deployment docs with GHCR images and Docker Compose#9
amavashev merged 2 commits intomainfrom
claude/docker-deployment-setup-Utjlk

Conversation

@amavashev
Copy link
Copy Markdown
Contributor

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:

    • Option A: Docker Compose with GHCR images (recommended for end users) — no Java/Maven required
    • Option B: Docker Compose from source (for development) — builds JARs inside Docker
    • Option C: Running from source (manual Java/Maven approach)
  • Updated deploying-the-full-cycles-stack.md:

    • Changed from build: context: to image: ghcr.io/runcycles/... for both cycles-server and cycles-admin
    • Made ADMIN_API_KEY configurable via environment variable with sensible default
    • Removed manual mvn clean package build steps from the quick start path
    • Added health check verification commands with expected output
    • Added guidance on pinning specific version tags for reproducible deployments
    • Introduced Option B explaining multi-stage Dockerfiles and docker-compose.full-stack.yml
  • Updated self-hosting-the-cycles-server.md:

    • Restructured prerequisites to show Docker/Compose as primary option
    • Replaced manual Dockerfile/compose examples with references to pre-built images
    • Added docker-compose.prod.yml as the recommended quick start
    • Clarified that multi-stage Dockerfiles handle compilation automatically
    • Added references to docker-compose.full-stack.yml variants for running with Admin Server
    • Removed verbose Dockerfile and compose examples in favor of simpler command-based instructions

Notable Details

  • Both guides now emphasize that Docker handles all Java/Maven compilation internally via multi-stage builds
  • Version pinning guidance helps users achieve reproducible deployments
  • Health check verification steps provide confidence that services are running correctly
  • Documentation acknowledges the existence of both cycles-server and cycles-server-admin repositories and how they work together

https://claude.ai/code/session_01KUZof47HegFKWBxfFjcSia

claude added 2 commits March 12, 2026 15:19
- 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants