Skip to content

ADR 0048

github-actions[bot] edited this page Nov 22, 2026 · 1 revision

Status: accepted · Built: done · Date: 2026-11-22

Built: kodentuzo/whoami 0.1.0 and docs/guides/check-your-instance.md.

whoami, a test app for instances, lives in its own repository

Context

A new instance needs an app before its owner can check most of it: the database and migrations, the mail relay and provider, backups, the user pool, the legal facts and analytics. No example app existed, and the starter (spotcraft new) is a full app, not a check.

Decision

  • kodentuzo/whoami is a small app, in the spirit of traefik/whoami, that reports on what Spotcraft gives an app. It runs one check per service, and sends a test email only to an address the owner sets, at most once a minute.
  • It lives outside this repository, with its own versions and image, vindotski/whoami. It uses only the app contract (docs/contracts.md), as any app does, so it also shows when that contract changes.
  • It's public domain (the Unlicense), so anyone may copy it as the start of an app. A NOTICE lists the parts that come under other licenses.

Consequences

  • An owner can check an instance in a few minutes: Check your instance.
  • A change to the contract needs a whoami release too; its README lists what it checks.

Clone this wiki locally