The builder’s charter · in the protocol site’s dress
For builders of clients, hosts and tools.
Planned · shown with invented examples
What are you building?
Pick one. The page shows the sections that bind it, each MUST quoted, and what to read. Nothing is stored, and coming back to this page starts from nothing chosen.
The sections that bind it
- §3.1: “A Pool MUST be retrievable as a JSON document, either from a public Git repository or from a Pool API endpoint that returns the same shape.”
- §5.1: “A Profile MUST NOT be added to a Pool without the owner’s explicit consent.”
- §5.3: “Implementations MUST process withdrawal within 60 seconds of receipt.”
- §9.1: “the Pool MUST enter
dormantstatus. Pool members MUST see a notice. The well-known file MUST reflect dormancy.” - §10.2: “MUST list, for each discoverable Pool on the domain, its
manifest_url,visibilityandstatus”
Read, in this order
- K.1 The Protocol as a Reader Meets ItWritten for this edition
- K.2 Licensing and GovernanceWritten for this edition
- K-4.7 The Personal Data a Pool HoldsRewritten for this edition from Field Manual Ch 4.7 · the original
- K-8.5 Security and Reliability for a Pool Host or ClientRewritten for this edition from Field Manual Ch 8.5 · the original
- K-7.1 Being Found: The Registry and the Well-Known FileRewritten for this edition from Field Manual Ch 7.1 · the original
The sections that bind it
- §4.5: “a v1-conforming UI MUST render it alongside every Profile.”
- §5.1: “A Profile MUST NOT be added to a Pool without the owner’s explicit consent.”
- §5.3: “Implementations MUST process withdrawal within 60 seconds of receipt.”
- §7: “A v1-conforming implementation MUST support all three layers.”
Read, in this order
- K.1 The Protocol as a Reader Meets ItWritten for this edition
- K.2 Licensing and GovernanceWritten for this edition
- K-4.7 The Personal Data a Pool HoldsRewritten for this edition from Field Manual Ch 4.7 · the original
- K-8.5 Security and Reliability for a Pool Host or ClientRewritten for this edition from Field Manual Ch 8.5 · the original
The sections that bind it
- §2.2: “Parsers MUST read h-card fields where present and MUST NOT infer values that contradict explicit h-card markup.”
- §2.3: “Implementations MUST record which fields were h-card-derived and which were inferred.”
- §2.5: “Photos MUST be referenced by URL only. Kindling and Pools MUST NOT store photo bytes.”
- §2.7: “Compliant Pools and crawlers MUST NOT include such a Profile in any Pool, registry, or discovery surface.”
Read, in this order
- K.1 The Protocol as a Reader Meets ItWritten for this edition
- K.2 Licensing and GovernanceWritten for this edition
- K-4.7 The Personal Data a Pool HoldsRewritten for this edition from Field Manual Ch 4.7 · the original
The sections that bind it
- §6.2: “MUST validate against
schemas/kindling_message.schema.json” - §4.5: “a v1-conforming UI MUST render it alongside every Profile.”
- §7.1: “Messages from unverified senders MUST be quarantined or rejected per the recipient’s per-profile preference.”
Read, in this order
- K.1 The Protocol as a Reader Meets ItWritten for this edition
- K.2 Licensing and GovernanceWritten for this edition
- K-8.5 Security and Reliability for a Pool Host or ClientRewritten for this edition from Field Manual Ch 8.5 · the original
The sections that bind it
- §8.4: “MUST NOT be the only way a Pool is discoverable”
- §10.3: “MUST respect
Cache-Controlheaders” - §7.3: “Implementations MUST be able to subscribe to one or more lists and filter accordingly.”
- §5.1: “A Profile MUST NOT be added to a Pool without the owner’s explicit consent.”
Say “built on Kindling” for these; “Kindling-conformant” belongs to the 4 classes until a later version names more (K.1).
Read, in this order
- K.1 The Protocol as a Reader Meets ItWritten for this edition
- K.2 Licensing and GovernanceWritten for this edition
- K-7.1 Being Found: The Registry and the Well-Known FileRewritten for this edition from Field Manual Ch 7.1 · the original
The articles
Everything in this edition is open. Ten of the Field Manual chapters these lean on are rewritten in this edition for a Kindling reader, each keeping its source number with a K- prefix. The originals, and every other Field Manual chapter, live on solo.joshwolf.net, the Library edition: Volume 1 and Chapter 10.9 are open there; the rest open free with an email.
Art. I
The protocol as a reader meets it
All twelve sections, read for what each asks of you.
- K.1 The Protocol as a Reader Meets ItWritten for this edition
- K-4.7 The Personal Data a Pool HoldsRewritten for this edition from Field Manual Ch 4.7 · the original
- K-8.5 Security and Reliability for a Pool Host or ClientRewritten for this edition from Field Manual Ch 8.5 · the original
- K-7.1 Being Found: The Registry and the Well-Known FileRewritten for this edition from Field Manual Ch 7.1 · the original
Art. II
Licensing and governance
Code under Apache 2.0, specification text under CC BY 4.0, and how a section changes.
- K.2 Licensing and GovernanceWritten for this edition
Art. III
What the protocol leaves out
§1.3 lists “a chargeable surface at the connection layer” among the non-goals, and K.1 shows which of the site’s ten lines rest on no MUST. The Field Manual’s moats chapter is the case the protocol answers.
A builder who will sell something beside the protocol reads K.3, money beside the introduction.
- K-3.5 What Lasts When People Can LeaveRewritten for this edition from Field Manual Ch 3.5 · the original
Art. IV
The quick start
Clone, validate, parse, ask. Every command runs only inside the clone.
- The quick startTool · works in your browser, stores nothing
Art. V
The Pool manifest walkthrough
The 9 required fields of §3.2, one at a time.
- The Pool manifest walkthroughTool · works in your browser, stores nothing
Art. VI
Try it as Hollis
The confirmation step of §5.2, as the owner of a page meets it.
- Try it as HollisTool · works in your browser, stores nothing
Art. VII
Before you go further
Volume 10 of the Field Manual, on solo.joshwolf.net, with Chapter 10.4 first.
- 10.4 Loneliness and IdentityFrom the Field Manual, on solo.joshwolf.net
For a Kindling reader Read it as it stands. This edition adds nothing to it.
- 10.9 Crisis and Support DirectoryFrom the Field Manual, on solo.joshwolf.net
For a Kindling reader The crisis and support directory, open to everyone without a link.