Documentation#
Linux 0.9.0 release and downloads
These manuals cover the HyperNet infrastructure: network authority, consenting hosts, storage, routes and service operation. The separate Suite manuals cover the graphical browser, terminal viewer, mail and client commands.
Choose a starting point#
| Goal | Reading order |
|---|---|
| Browse or use an existing network | Use the Suite's installation, local preview and network-connection guides. No Core host is required. |
| Operate a new network | Installation, security, host requirements, authority, network preparation, then runtime. |
| Offer storage or a service | Hosting consent, service runtime, then the relevant service manual below. |
| Write or review Pages | Pages, HyperPage format, media, then the Suite's authoring and review commands. |
| Integrate another application | Application access, protocol overview, application protocol, then the exact domain contract. |
| Diagnose or recover a deployment | Diagnostics, runtime, package updates; use network recovery only for exceptional authority loss. |
Operate the network#
| Manual | What it covers |
|---|---|
| Installation | Build and package requirements, installation boundaries and the first-deployment sequence. |
| Hosting | Local operator consent, mandatory confinement, persistent storage and resource selection. |
| Authority | Independent trust, separate roles, replicated decisions and retained state. |
| Network preparation | Native identities, certificate requests, pinned peer inputs and clock configuration. |
| Authority runtime | Setup, preview, consent, startup, status, stop, withdrawal, renewal and managed operation. |
| Service runtime | Import, activate, supervise and recover a separately consented service. |
| Clock observation | Authenticated time sources, signed observations and clock failure handling. |
| Application streams | Reusable authenticated duplex streams, local SDK binding and finite session lifecycle. |
| Private routes | Relays, application endpoints, outbound attachments and privacy limits. |
| Network policies | Participation, privacy, publication and recovery-custody policy changes. |
| Tier administration | Explicit grants and policy history; tier labels do not grant authority. |
| Operational audit | Bounded signed events, retention and separately pinned witnesses. |
| Diagnostics | Local redacted snapshots and explicit export without collecting private logs. |
| Signed packages | Bundle verification, independently accepted trust, installation and removal. |
| Package updates | Signed update targets, retained floors and interrupted installation. |
| Committee replacement | Certified handoff from a functioning committee to its successor. |
| Network recovery | New-network recovery after authority loss and independent client acceptance. |
| Content backups | Consented encrypted archives and restoration under current authority. |
| Qualification | Native platform requirements, representative checks and evidence boundaries. |
Publications, communication and storage#
| Feature | Behaviour | Host operation |
|---|---|---|
| Pages | Publication and review, declarative markup | Page store, durable content |
| Media | Static assets and local motion | Media store |
| Search | Network catalogues and local search | Indexing requires separate host consent and permission. |
| Federation | Bilateral sharing and destination review | Bridge service |
| Private mail and recipient-selected storage | Mail store | |
| Transfers | Recipient-approved encrypted transfer | Transfer store |
| SSH | Separately consented fixed-command services | Uses the service lifecycle and a separately prepared OpenSSH image. |
| Applications | Scoped credentials and explicit disclosure | An application grant does not grant host or administrator access. |
Sealed publication commands belong to the Suite's confidential-publication guide. Storage consent and current recipient permissions still apply; encryption does not bypass publication review.
Protocol and implementation reference#
These documents define contracts and schemas. Use the operation manuals above for commands and the current supported workflow; a requirement is not evidence that a deployment has been tested.
| Reference | Subject |
|---|---|
| Requirements | Product requirements and client independence. |
| Contract index | Relationship between the policy, wire, authority and runtime contracts. |
| Protocol overview | Canonical objects, exact retries and domain boundaries. |
| Wire contract | Signed envelopes, field encodings, proofs and bounds. |
| Authority contract | Consensus, fresh reads, durable voting and recovery rules. |
| Policy contract | Capabilities, version references and restrictive state. |
| Runtime contract | Management, consent, readiness and connection requirements. |
| Authority replica | Native signer configuration, persistence and protocol operation. |
| Mail protocol | Mailbox manifests, one-use packages, claims and encrypted delivery. |
| Transfer protocol | Offers, acceptance, encrypted chunks and effect receipts. |
| SSH protocol | Key possession, fixed-command leases and supervision. |
| Application protocol | Application registration, delegation and restrictive grants. |
| Source layout | Implementation modules and their responsibilities. |
| Dependencies | Locked components and licences. |
| System-library licences | Runtime library notices and source accompaniment. |
Terms and command conventions#
| Term | Meaning |
|---|---|
| Bootstrap | Independently authenticated initial network identity, policy and appointed authorities. |
| Authority replica | One of the four appointed voters maintaining ordered network state. A storage host has no vote by default. |
| Grant | Explicit permission for named actions and scope. Membership and tier labels are separate. |
| Operator consent | The hardware operator's approval of exact local software, resources, exposure and finite lifetime. |
| Profile | A validated configuration describing one specific client, host, service or route. Profiles are not interchangeable credentials. |
| Receipt | Evidence of an exact recorded result or effect; it is not permission for a new action. |
| Retained floor | Durable minimum accepted history or generation used to reject older state. |
| Sealed Page | A reviewed encrypted publication decrypted by authorised readers. |
| Withdrawal | A durable restrictive decision. Stopping a process alone does not withdraw consent. |
Commands are run from a trusted checkout or installed package unless stated
otherwise. /Private/..., example addresses and angle-bracket values are
placeholders, not usable credentials or pre-created files. Substitute the exact
independently verified outputs from the preceding steps. Keep live state outside
the checkout and installation. Protect secret inputs; never put them in issues
or shared command captures.
A process can be running while its quorum, permissions or clock are unavailable. A historical receipt does not establish present readiness. A timeout does not prove that an operation failed: retain its exact identity and use its documented recovery path.