larvit/plainpages
3
0
Fork 0
Code Issues 1 Pull Requests 6 Actions Packages Projects Releases Wiki Activity

Push auto-release tags as renovate-bot so release.yml fires, and give the Docker Hub page its short description #196

Merged
lilleman merged 6 commits from item-1 into main 2026-10-31 11:24:19 +01:00
Conversation 0 Commits 6 Files Changed 10
+13 -14
1 changed files with 13 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit ee4d09df06 - Show all commits
README.md
+13 -14
View File
@@ -24,6 +24,16 @@ cd plainpages
docker compose up -d # http://localhost:3000, live-reloads on source changes docker compose up -d # http://localhost:3000, live-reloads on source changes
``` ```
To try it without a clone, save the `compose.yml` the
[Docker Hub page](https://hub.docker.com/r/larvit/plainpages) shows. Then extract the Ory config
the image ships and start, with `X.Y.Z` the release that page names:
```bash
docker run --rm larvit/plainpages:X.Y.Z tar -cf - ory | tar -xf -
mkdir -p plugins
docker compose up -d
```
**2. Sign in.** Open <http://localhost:3000> and sign in as the seeded admin — **2. Sign in.** Open <http://localhost:3000> and sign in as the seeded admin —
**`admin@plainpages.local` / `admin`**. **`admin@plainpages.local` / `admin`**.
@@ -1591,11 +1601,10 @@ tags sync to [Docker Hub](https://hub.docker.com/r/larvit/plainpages), releases
The [contract check](#contract-versioning) guards the tag before anything is published, refusing one The [contract check](#contract-versioning) guards the tag before anything is published, refusing one
whose `major.minor` disagrees with `HOST_API_VERSION` and naming the value to set. whose `major.minor` disagrees with `HOST_API_VERSION` and naming the value to set.
**The Docker Hub overview** and short description are published by a separate `publish-overview` **The Docker Hub overview** is published by a separate `publish-overview` job from
job from [`release-tooling/dockerhub-overview.md.tmpl`](release-tooling/dockerhub-overview.md.tmpl), with [`release-tooling/dockerhub-overview.md.tmpl`](release-tooling/dockerhub-overview.md.tmpl), with
`{{VERSION}}` rendered to the release, so the Plainpages tag it tells adopters to pull cannot go `{{VERSION}}` rendered to the release, so the Plainpages tag it tells adopters to pull cannot go
stale. The description must open a sentence of this README, and every command the overview shows stale. The same job sets the page's short description. Its sidecar pins are Renovate-managed and gated against this repo's own compose files, so the
must appear here too. Its sidecar pins are Renovate-managed and gated against this repo's own compose files, so the
quick start stays a topology CI has actually run. quick start stays a topology CI has actually run.
It is its own job for two reasons: the images are already pushed and irreversible by then, so a Hub It is its own job for two reasons: the images are already pushed and irreversible by then, so a Hub
outage leaves the promotion green and the images untouched; and the page has its own door — run the outage leaves the promotion green and the images untouched; and the page has its own door — run the
@@ -1667,16 +1676,6 @@ the one-shot bootstrap) — and mounts no source. Secrets come from the environm
running insecure. Before going live, supply the production secrets and any SSO credentials — the running insecure. Before going live, supply the production secrets and any SSO credentials — the
**only** manual prep ([What you must supply](#what-you-must-supply-the-only-manual-prep)). **only** manual prep ([What you must supply](#what-you-must-supply-the-only-manual-prep)).
**From the published image**, without a clone: save the `compose.yml` the
[Docker Hub page](https://hub.docker.com/r/larvit/plainpages) shows, then extract the Ory config the
image ships and start, with `X.Y.Z` the release you deploy:
```bash
docker run --rm larvit/plainpages:X.Y.Z tar -cf - ory | tar -xf -
mkdir -p plugins
docker compose up -d
```
**Back up the `pgdata` volume.** Once a plugin declares [storage](#plugin-storage), Postgres holds **Back up the `pgdata` volume.** Once a plugin declares [storage](#plugin-storage), Postgres holds
business data that exists nowhere else, alongside Ory's identities — the stack stops being business data that exists nowhere else, alongside Ory's identities — the stack stops being
reproducible from the image and config alone. Snapshot the volume, or `pg_dump` each database on a reproducible from the image and config alone. Snapshot the volume, or `pg_dump` each database on a