buzz-relay-startos

Imported from Start9-Community/buzz-relay-startos (AGENTS.md). Install upstream with npx skills add Start9-Community/buzz-relay-startos. Copyright stays with the author.

AGENTS.md

This is a StartOS service-package repository — it builds a .s9pk for StartOS.

Develop it inside a StartOS packaging workspace created by start-cli s9pk init-workspace, which provides the packaging guide and agent context one level up. If you're reading this in a bare clone with no workspace, the full guide is at https://docs.start9.com/packaging.

Start every task at the recipe index — ../start-technologies/projects/start-sdk/docs/src/recipes.md (or https://docs.start9.com/packaging/recipes.html). It maps an intent ("prompt the user to create admin credentials", "expose a web UI") to the constructs, the reference pages, and a named production package to copy. Find the recipe before you read this package's neighbours: a package you reach by grepping may be non-conformant, and the recipe outranks it.

Freshly scaffolded? Work the New Package Checklist (or https://docs.start9.com/packaging/new-package-checklist.html) from top to bottom. It is a guide page, not a file in this repo — read it, don't copy it in.

Keep README.md (technical reference for an AI support or administering agent) and instructions.md (end-user docs) in sync with your changes. This file restates neither: whoever changes the package has both, so it carries only what they don't — repo mechanics, a change that looks right and is not, where the next thing gets added, a naming trap, a build or test invocation particular to this repo.

Fix a defect you spot rather than reporting it — you have the package open and the context to be sure. File a GitHub issue on this repo only when the call isn't yours to make: you can't pin the cause down, two defensible fixes exist, or it's too large to ride on the work in hand. An open issue is a report, not a queue — implement one when you're asked to or when it's labelled Approved, then close it with Closes #<n>.

Don't record work in the repo instead: no TODO.md, no NOTES.md, no PLAN.md. What you verified, tried, and decided belongs in the commit message and the PR body.

This repo

• Keep every process but Caddy on loopback, behind the one binding. buzz-pair-relay has no auth and leaves path restriction and read timeouts to the proxy, so keep the matcher exact (path /pair /pair/) and caddy validate assets/Caddyfile after any edit. Add a new endpoint as a Caddy path, never a second binding: StartOS disables a public domain on every sibling of the binding it was added to.
• Fix /data/git ownership with the chown-git oneshot, not an idmap mount — idmap was tested on a box and left the relay crashing the same way.
• Keep Redis on a volume with --appendonly yes, not the volumeless cache recipe — upstream expects pub/sub and presence state to survive a restart.
• Normalize every pubkey an action takes with toHexPubkey — it turns the NIP-19 decoder's diagnostics into translated copy, and list-members reports hex.