Skip to content

Run the GHCR image

Use the public GitHub Container Registry image when you want PayloadStash isolated from the host's Python environment.

Browse published images and tags

The GHCR package page lists every published image version, its available tags, publication date, digest, and pull command. Choose a versioned tag when you need a reproducible installation.

Prerequisites

  • Docker Engine or Docker Desktop
  • An amd64-compatible Docker runtime, or emulation for linux/amd64

The current repository container flow explicitly targets linux/amd64. On Apple Silicon or other architectures, Docker may use emulation and run more slowly.

Run from your working directory

The following command mounts the current host directory at /working, uses that as the container working directory, and leaves output on the host:

docker run --rm --platform linux/amd64 \
  -v "$(pwd):/working" -w /working \
  ghcr.io/ericwastaken/payloadstash:latest \
  run ./config/config-example.yml --out ./output --yes

Validate the same configuration without making requests:

docker run --rm --platform linux/amd64 \
  -v "$(pwd):/working" -w /working \
  ghcr.io/ericwastaken/payloadstash:latest \
  validate ./config/config-example.yml

All paths passed to PayloadStash must be visible inside the container. With this mount style, host paths below the current directory map directly below /working.

Use secrets

Keep the secrets file inside the mounted working directory and pass its container-visible relative path:

docker run --rm --platform linux/amd64 \
  -v "$(pwd):/working" -w /working \
  ghcr.io/ericwastaken/payloadstash:latest \
  run ./config/config.yml --out ./output --yes \
  --secrets ./config/secrets.env

Choose and update the image tag

  • :latest follows the newest published stable release.
  • A version tag such as :1.2.0 pins runs to one reproducible release.
  • A prerelease tag such as :1.3.0-rc.1 must be selected explicitly and does not replace :latest.

Normal commits to main do not publish container images. PayloadStash publishes to GHCR only when a GitHub Release is published.

Refresh the moving tag with:

docker pull --platform linux/amd64 ghcr.io/ericwastaken/payloadstash:latest

Remove it with docker image rm ghcr.io/ericwastaken/payloadstash:latest.

Different paths in packaged Docker helpers

The repository's packaged Docker helper uses ./config → /app/config and ./output → /app/output. Those /app paths apply to that helper and Compose flow; the direct GHCR commands above deliberately use /working instead.