From 7bd4097e7205ac3e713aca41cd01ceb86be6b460 Mon Sep 17 00:00:00 2001 From: "Juan A." <30204147+jaas666@users.noreply.github.com> Date: Sun, 19 Oct 2025 00:31:03 -0500 Subject: [PATCH] Document container image sources in README Added section on container image sources for Docker Hub and GHCR. Signed-off-by: Juan A. <30204147+jaas666@users.noreply.github.com> --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index bf64f495..255d478e 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,20 @@ be secure, reliable, compact, and simple to use. It only requires that you provide the credentials or URL needed to download a Foundry Virtual Tabletop distribution. +## Container Image Sources ## + +You can pull this container image from either **Docker Hub** or the **GitHub Container Registry (GHCR)** — both contain identical, up-to-date versions of the image. + +| Registry | Image URL | Example Pull Command | +|-----------|------------|----------------------| +| 🐳 Docker Hub | [`felddy/foundryvtt`](https://hub.docker.com/r/felddy/foundryvtt) | `docker pull felddy/foundryvtt:13` | +| 🦊 GitHub Container Registry | [`ghcr.io/felddy/foundryvtt`](https://ghcr.io/felddy/foundryvtt) | `docker pull ghcr.io/felddy/foundryvtt:13` | + +> [!TIP] +> You can substitute either registry URL in any of the examples below. +> For example, use `ghcr.io/felddy/foundryvtt:13` instead of `felddy/foundryvtt:13` +> in your `docker run` or `docker compose` commands. + ## Prerequisites ## - A functioning [Docker](https://docs.docker.com/get-docker/) installation.