Skip to content

naulon docs

Deeper references behind the root README. Start with whichever side you're on.

Getting your site tolled

You run a site and want machines to pay to read or cite it.

  • integration-guide.md: start here. The two endpoints you serve with @naulon/sdk, in Next.js or Express, plus the self-check before you go live.
  • credits-api.md: the GET /credits/:slug contract: a slug in, an author-wallet split out, 404 = free. Who gets paid.
  • settlement-notifications.md: the signed settlement.completed webhook naulon sends you when a payment settles. Your earnings ledger, and the HMAC trust boundary.

Operating a gate

You run the toll proxy in front of a site.

  • operating.md: the operator console: health, live toll traffic, earnings, and config sanity, and how to expose it safely.
  • configuration.md: every environment variable the gate, the console and the agent read, what it does, and what happens if you leave it alone. The reference behind .env.example.
  • crawler-policy.md: allow, charge or block per crawler, what the policy file may not say (humans read free), and how verified bot identity (Web Bot Auth) is checked.
  • crawl-adapters.md: the crawl seam: implement the adapter interface for your own CMS instead of forking the crawler, and conformance-test it.
  • DEPLOY.md: click-by-click to host the gate on Vercel + Supabase in front of a real site.

Buying

You're on the paying side, running an agent that reads and cites tolled sources.

  • buying.md: the wayfarer agent and the MCP server: the tools, the spend envelope the model can't widen, discovery, and what a payment leaves you holding.

Protocol

  • citation-license.md: the Citation License Token (CLT) spec: a signed, independently verifiable receipt an agent keeps as provenance and re-presents for a free re-read. Claims, verifier rules, security invariants.

The wire contracts (credits-api, settlement-notifications, citation-license) are the breaking-change boundary self-hosters depend on. The runnable counterparts: packages/sdk/examples/next-credits/ for the publisher side, examples/meridian/ for a full toll.