Skip to content

docs: add ghcr.io pull command to Docker section #562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dt-dtran merged 1 commit into from
May 27, 2026
Merged

docs: add ghcr.io pull command to Docker section #562

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading