From 15142fbc67510f499b5bc54f1c8c3a081cca13d0 Mon Sep 17 00:00:00 2001 From: Bryan AuBuchon Date: Wed, 27 May 2026 14:39:38 -0500 Subject: [PATCH] docs: add ghcr.io pull command to Docker section The Docker image is published to ghcr.io, not Docker Hub. The README mentioned a Docker image exists but never provided the registry location, causing customer confusion. Adds the pull command and corrects the registry reference. --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 864f91e3..f66ae4c3 100644 --- a/README.md +++ b/README.md @@ -88,9 +88,11 @@ Each option can optionally be overridden via environment variables or command-li ## Running using Docker Image -A docker image is published that contains a built binary file and startup instruction for the `gokeyless` process. An example of the usage of this docker file is in `docker-compose.example.yaml` - -This examples shows how you may provide the same configuration options through environment variables and provide a mount with a directory for private keys instead of through a `gokeyless.yaml` file. +A Docker image is published to [GitHub Container Registry](https://github.com/cloudflare/gokeyless/pkgs/container/gokeyless) (`ghcr.io`) — not Docker Hub. Supported architectures: `linux/amd64` and `linux/arm64`. +```sh +docker pull ghcr.io/cloudflare/gokeyless:latest +``` +An example of configuring and running the container using environment variables (in place of a gokeyless.yaml file) is in docker-compose.example.yaml. ## Testing