Skip to content

chore: Add GitHub Container Registry as alternative image source#24

Open
twk3 wants to merge 1 commit intomainfrom
docs/add-github-image-alternate
Open

chore: Add GitHub Container Registry as alternative image source#24
twk3 wants to merge 1 commit intomainfrom
docs/add-github-image-alternate

Conversation

@twk3
Copy link
Contributor

@twk3 twk3 commented Feb 27, 2026

Add documentation for using GitHub Container Registry (GHCR) as an alternative to AWS ECR for accessing Currents container images.

Checklist

  • PR title is Changelog-friendly: (fix|feat|chore): title [CSR-xxx]
  • User-friendly and meaningful description of the changes
  • Documentation was updated

Summary

  • Adds new "Alternative: GitHub Container Registry" section to docs/container-images.md
  • Documents the prerequisite of being invited to the private currents-dev/customer-images repository
  • Provides step-by-step instructions for GitHub PAT creation and GHCR authentication
  • Includes Docker Compose configuration example with DC_CURRENTS_IMAGE_REPOSITORY=ghcr.io/currents-dev/currents-
  • Adds mirroring instructions specific to the GHCR image naming convention

Review Hints

  • Single file change: docs/container-images.md
  • The new section is appended after the existing AWS ECR documentation
  • Note the different image naming pattern: GHCR uses currents- prefix (e.g., currents-api) vs ECR's path-based naming

Summary by cubic

Adds GHCR as an alternative source for Currents container images, with auth steps, Docker Compose config, and mirroring guidance. This helps customers who can’t use AWS IAM to pull images reliably.

  • Migration
    • Get invited to github.com/currents-dev/customer-images.
    • Create a GitHub PAT with read:packages and run docker login to ghcr.io.
    • Set DC_CURRENTS_IMAGE_REPOSITORY=ghcr.io/currents-dev/currents- and choose a tag (e.g., staging).
    • Mirror images to your own registry if needed; note GHCR uses the currents- prefix (e.g., currents-api).

Written for commit 06e8842. Summary will update on new commits.

@twk3 twk3 changed the title docs: Add GitHub Container Registry as alternative image source chore: Add GitHub Container Registry as alternative image source Feb 27, 2026
@twk3 twk3 requested a review from agoldis February 27, 2026 00:58
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

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.

1 participant