keysat-docs/README.md

Keysat Docs

Operator-facing documentation for Keysat — the self-hosted, Bitcoin-paid 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.