aboutsummaryrefslogtreecommitdiffstats
path: root/docs/operations.md
Commit message (Collapse)AuthorAgeFilesLines
* transport: wire versions spoken side by sidetv3 days1-14/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | A build speaks wire versions OLDEST to VERSION and writes each node the newest both speak (wire::choose), as the node's SPEAKS says; the oldest until it says. The identity layer keeps that per address (Book::speaks): a SPEAKS from an address sets it for the address, and for every address of the node proven there, and a new address of a node takes it over. Paths encodes each message for an address in its version (Transport::encode_in; Transport::encode is the newest). So that two nodes know what the other speaks once they have proven themselves to each other, before any other message goes between them, a SPEAKS goes ahead of every WHO and ME, and WHO and ME are read in every version from 52 on (wire::PROOFS): their tags and layout never change. Without that, a node whose oldest version is past the other's couldn't read its proofs, and the two would never get to the handshake that says what each speaks. A SPEAKS naming no version this build speaks is logged as a message of another version is, naming the node to upgrade, the versions as ranges. A 0.0.1 node takes a SPEAKS from an address not yet proven for any other message from there: it drops it, and asks WHO. This build speaks 52 alone, so nothing it sends changes but the SPEAKS ahead of the proofs. A release adding a version encodes and decodes the older ones from their own, frozen, types.
* Cargo.toml: Automerge pinned to exactly 0.12.0tv3 days1-1/+2
| | | | | | | | | | Nodes build remakes' snapshots and a federation's founding changes byte for byte, as Automerge encodes them: a build with another Automerge rejoins instead of switching, and could build another genesis change. `automerge = "0.12"` let `cargo update`, or a distribution building without the lock, take any 0.12.x. It names exactly 0.12.0 now, which the lock holds already, so that moving it is a change made on purpose, said in the change log.
* wire: a peer on another version is named older or newer, with what to upgradetv3 days1-8/+9
| | | | | | | | | | | A node meeting messages of a wire version it doesn't speak logged `Peer speaks another wire version (another build)`, with the versions as fields only. It says now, in the message, which build is the newer and which node to upgrade: this one, where the peer's is newer (`upgrade this node to talk with it`), else the peer's (`upgrade that node`), with the peer's version and the ones this build speaks. Its fields are the peer's version and the oldest and newest this build speaks.
* Cargo.toml: version 0.0.1v0.0.1tv3 days1-1/+1
| | | | | | | The version said 1.0.0, a placeholder, while the only release is 0.0.0: `continuum --version` and libp2p's agent version said 1.0.0 of every build. 0.0.1 is the release to come; adding Cargo.lock. The --version example in operations.md says so too.
* peers: what each peer said it speaks and knows, in GET /peerstv3 days1-1/+2
| | | | | | | | | | | | | | | | GET /peers shows, of each peer, what it said with its handshakes (SPEAKS): its `knows`, the wire versions it speaks, the oldest and the newest, and the newest revision of the federation it knows; null where it said nothing, a build from before SPEAKS or no handshake from it since the node started. `localKnows` is the node's own. So every swarm, federated or not, shows which builds its nodes run, as far as each heard. `swarm::speaking::shown` shapes it, for GET /events/counts too, whose `knows` is the same; docs/openapi.yaml has it once, as `Knows`. Without the federation feature, a revision reads as one this continuum doesn't know. `Speaking::of` is now used in every build, not only federated ones, which warned of it as dead code.
* release: --version says what decides which builds work togethertv3 days1-0/+13
| | | | | | | | | | | | | | | | `continuum --version` and `continuum-party --version` say, after the release, the wire versions the build speaks, the federation and the revisions of it it knows (with the `federation` feature), and the Automerge version it makes documents with: continuum 1.0.0 wire versions 52 to 52 federation 1: the base revision, revision 1 (merge-events) automerge 0.12.0 `-V` says the release alone, as before; continuum-party had no version at all. The Automerge version is the one the crate itself reports (`document::engine_version`), so it follows Cargo.lock.
* docs: what a release's version says of upgrading to ittv3 days1-3/+19
| | | | | | | | | | | | | | | | | | | A release is tagged v<version>, and its version says, from the operator's side, how to upgrade to it from the release before: a patch one node at a time, fixes only (a fix to what the federation judges comes as a revision); a minor one node at a time still, adding to the API or bringing a revision the parties then pass; a major one every node close together, a flag day: no wire version both releases speak, a document, change or snapshot built otherwise, files the node can't restart with, the API or continuum-party changed other than by adding, or a new federation. Before 1.0.0 any release may be a flag day, and its tag's message says whether it is. operations.md and the federation's upgrades guide say so; a node speaking one wire version, every change of the format is a major release. architecture.md said wire formats grow by appending so that a swarm upgrades node by node, which no build does: every change bumps the version, and builds tell each other apart instead.
* transport: SPEAKS, which wire versions a node speaks and what it knowstv3 days1-5/+11
| | | | | | | | | | | | | | | | | | | | | | | Before each HELLO and each HELLO_REPLY, a node sends SPEAKS: the oldest and the newest wire version it speaks, and the ID of the newest revision of the federation it knows. It stands outside the wire versions, its first byte 0, which no version is, laid out as no build changes: that byte, the oldest, the newest, then 32 bytes of the revision's ID where there is one; a reader takes those and leaves whatever follows, which a later build may add. So a peer on another build reads it too, and nodes on different builds can say what they run, which a rollout needs. A build from before it takes it for a message of another wire version and logs that once of the peer (version=0), reading the rest of the peer's messages as before: SPEAKS rolls out node by node, with no change of VERSION. The node keeps what each peer said last (`swarm::speaking`, at most 4096 peers). It counts as `hello` traffic. `OLDEST`, the oldest version this build reads, is `VERSION` for now: a range for a later build to widen. operations.md also says what is so of the other-version warning now: every transport logs it once per peer at warn, not Mycelium alone.
* docs: references to another document's section linked to ittv4 days1-21/+28
| | | | | | | | Where a document names a section of another after linking to it ("([`store.md`](store.md), Pinned checkpoints)"), the name links to that section too, by the id both GitHub and cgit's about filter give its heading; paragraphs that grew past the width are wrapped anew, links and code kept on one line each.
* login: the session cookie Secure behind a TLS proxytv2026-11-081-1/+4
| | | | | | | | | | | Review finding 12, browsers: the session cookie had no Secure flag. Behind a TLS proxy, the token it carries went over plain HTTP if someone typed http://. POST /auth/session now sets Secure when the request came over TLS, as the proxy says (X-Forwarded-Proto, or Forwarded's proto, of the first hop). A client saying so itself only keeps its own cookie off plain HTTP. operations.md's nginx example sets the header.
* dashboard: without LINKS; LINKS removedtv2026-11-071-2/+1
| | | | | | | | | The dashboard reads every member's links from the members themselves; LINKS and LINKS_REPLY, swarm::links and their wire tags go (wire version bumped). Nodes the browser can't reach are drawn from what the reachable ones measure. Auth plan M3.
* docs: tokens through a proxy; token formats latertv2026-11-071-13/+51
| | | | | | | | operations.md: an nginx proxy passing requests with a token on to the node and asking the others for its own login. future-work: other token formats. Auth plan M2.
* add stream heartbeattv2026-11-031-3/+4
|
* api: allow listening to Unix socketstv2026-11-021-9/+45
|
* api: support serving under a path prefixtv2026-11-021-0/+4
|
* api: /stream & dashboard send X-Accel-Bufferingtv2026-11-021-0/+5
|
* api: allow auth delegationtv2026-11-021-0/+22
|
* add documentationtv2026-11-021-0/+149