Add instance-discovery document + serving guide #68

Merged

raisondetredev merged 1 commit from refs/pull/68/head into main

2026-07-01 13:53:18 +02:00

raisondetredev commented

2026-07-01 13:53:00 +02:00

(Migrated from codeberg.org)

discovery/halkyon-learn.json is the canonical document (fill in anonKey);
discovery/README.md documents the contract (fields, CORS, https/path
normalisation) and how to serve it from the reverse proxy fronting
learn.halkyon.li — outside Kong so no apikey is required — with Caddy / nginx /
Traefik snippets.

Halkyon Learn's new domain-based login fetches a public /.well-known/halkyon-learn.json to learn a self-hosted instance's Supabase URL and publishable key, so learners never type the key (the Supabase analogue of Mastodon's /api/v1/instance; the anon key is publishable, so it's safe to serve unauthenticated). discovery/halkyon-learn.json is the canonical document (fill in anonKey); discovery/README.md documents the contract (fields, CORS, https/path normalisation) and how to serve it from the reverse proxy fronting learn.halkyon.li — outside Kong so no apikey is required — with Caddy / nginx / Traefik snippets.