From 668e001f28989ef7780cd8562c7c7ce1787a13ee Mon Sep 17 00:00:00 2001 From: Angus Hollands Date: Mon, 19 Oct 2026 15:59:44 +0000 Subject: [PATCH 1/2] Add docs on QUAY_ vars --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fa8821a..5ae9a05 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,12 @@ automatically build and tag images once every other week, so users have access t newer images *if* they would like, and admins can set default images for their communities as they desire. +## Customizing the template +There are two variables, that must be set in the GitHub repository settings, that control authentication with the Docker image registry: +- `QUAY_USERNAME` — a username for a service account with push privileges to a particular image repository. +- `QUAY_PASSWORD` — a password for the service account +- `IMAGE_PREFIX` — the prefix that images should use, e.g. `quay.io/2i2c/example-image-stack-` + ## Using older versions of images You can find the older versions of all these images by looking through the 'tags' @@ -59,4 +65,4 @@ page on quay.io for them: - [Project 1 Image Tags](https://quay.io/repository/2i2c/example-image-stack-project1?tab=tags) - [Project 2 Image Tags](https://quay.io/repository/2i2c/example-image-stack-project2?tab=tags) -We recommend using tags with a date! \ No newline at end of file +We recommend using tags with a date! From c5b7a7a369f0bdb5b820a5791880694b0897b3f6 Mon Sep 17 00:00:00 2001 From: Angus Hollands Date: Mon, 19 Oct 2026 16:04:55 +0000 Subject: [PATCH 2/2] docs: clarify secret vs variable --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5ae9a05..a3078e4 100644 --- a/README.md +++ b/README.md @@ -51,9 +51,11 @@ newer images *if* they would like, and admins can set default images for their communities as they desire. ## Customizing the template -There are two variables, that must be set in the GitHub repository settings, that control authentication with the Docker image registry: +There are two _secrets_🕵️, that must be set in the GitHub repository settings, that control authentication with the Docker image registry: - `QUAY_USERNAME` — a username for a service account with push privileges to a particular image repository. - `QUAY_PASSWORD` — a password for the service account + +Finally, set a _variable_📢 to specify the image prefix - `IMAGE_PREFIX` — the prefix that images should use, e.g. `quay.io/2i2c/example-image-stack-` ## Using older versions of images