Skip to content

Document container image sources in README #1301

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Document container image sources in README #1301

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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down