Keysat
9e4c36c05b
Ports the in-repo KEYSAT_AGENT_GUIDE.md into the docs site as a first-class page rather than linking out to a raw markdown file on GitHub. The page covers authentication, scoped API keys, OpenAPI discovery, error envelope conventions, common workflows (issue / revoke / find / cancel / change-tier / free-machine), webhook event types + signature verification, robust-agent patterns, a "comp-license-via-email" recipe, and the operator-only operations that aren't exposed to any scoped key. Sidebar gains an "Agent integration" entry under Get started on every page (index, install, integrate, wire-format, operate, agent itself). Docs index "These docs cover" + "Where to next" grids each gain a third card pointing at the agent guide so it's discoverable from the introduction page even for visitors who don't scan the sidebar.
Keysat Docs
Operator-facing documentation for Keysat — the Bitcoin-native self-hosted software licensing service for StartOS.
This repo is a static HTML site. No build step. The deployed version lives at keysat.xyz/docs.
Pages
- index.html — Introduction. What Keysat is, why it exists, and the sovereignty thesis behind it.
- install.html — Operator setup walkthrough. Installing the .s9pk on StartOS, connecting BTCPay, creating your first product and policy, and sharing your buy URL.
- integrate.html — Wiring Keysat licensing into your own software. Code examples for the TypeScript, Python, and Rust SDKs; entitlement-gating patterns; offline verification.
- operate.html — Day-to-day operations. Managing licenses, suspending / revoking, search, audit log, discount codes, refund flows.
- wire-format.html — Specification of the signed license key format (LIC1 envelope, base32 alphabet, Ed25519 signature scheme). Useful for porting the SDK to a new language.
Local development
The site is self-contained — open any .html file in a browser, or serve
the directory with any static file server:
# Python
python3 -m http.server 8000
# or
npx serve .
Then visit http://localhost:8000.
Styling
All pages share docs.css. Brand assets live in assets/. The visual
language matches the rest of the Keysat surface (cream paper-textured
background, navy ink, gold accents, classical type — Manrope for display,
Inter for body, JetBrains Mono for code).
Contributing
Issues and pull requests welcome. Substantive changes — new sections, restructuring, factual corrections to the wire-format spec — are best discussed in an issue first.
License
MIT. See LICENSE.