aboutsummaryrefslogtreecommitdiffstats
path: root/docs/guides/federation/getting-started.md
Commit message (Collapse)AuthorAgeFilesLines
* docs/guides/federation: led by the new commandstv3 days1-30/+17
| | | | | | | | | | | Getting started lets makefu in with `propose admit`, lass seeing what it votes on before it casts, and reads with `values` and `status`; the upgrades guide proposes a revision with `propose revision`, the checkpoints guide a checkpoint with `propose checkpoint`, the keys guide names keys anew with `propose keys` and writes a namespace again from `values --json`; the troubleshooting guide points at `status` and at forks by what they are for. The JSON and `next` stay where a version is written by hand.
* share/bash-completion: continuum-partytv3 days1-1/+5
| | | | | | | | | | | | | | | | | A hand-written completion, where distributions package it: share/bash-completion/completions/continuum-party, read by bash-completion when first needed (it uses _init_completion and _filedir where they are, plain compgen else). It completes the commands, the intents of `propose` and `fork` (`fork` without `checkpoint`, with `proposal`), the options of each, files where one is taken, `--federation` from ~/.config/continuum/federations (or $XDG_CONFIG_HOME's), and `--revision` and `propose revision` from the features `--version` names. From the node, asked with the options given before the command: the proposals on the current version by hash (`proposals`), for vote, show and fork proposal; the parties (`status`), for remove, give, keys and nodes; and the places holding a value (`values`), for write and values.
* continuum-party found: a federation's first version from its partiestv3 days1-1/+11
| | | | | | | | | | | | The founders wrote the first version as JSON by hand. `found PARTY=KEY|FILE...` writes it: each party with its keys, an authorized_keys line or a file of them, again for more, since 0; --nodes PARTY=NODE,... their node lists, empty where not given; --rule PATH=WRITER the rules in order, `nobody` for false, and without any, each party writing under home/{party}/; --revision FEATURE a later revision. It is checked as a first version (Version::read, changes_validly), and goes to standard output, for `root` to make the root of. The feature lookup is shared with `next` (adding).
* continuum node-id: a node key's ID, without starting the nodetv3 days1-5/+5
| | | | | | | | | The founders name each node by its ID in the first version, before the federation starts; getting it meant starting a node once with --node-key-create and reading its log. `continuum node-id FILE` prints the node ID of the key FILE holds and exits, `--create` making the key there first where there is none (saying so on standard error). Logs are off for it, as for --print-config: the ID goes to standard output alone.
* continuum-party: a directory for each federation, the only one used unaskedtv3 days1-3/+4
| | | | | | | | | | | | | | | | | | | A party named its node, key and record on every command, or a file of them with --config; one voting in several federations kept files apart by hand. Without --config, the client now reads a federation's own directory, `continuum/federations/NAME` in $XDG_CONFIG_HOME or ~/.config: its `party.toml` of the client's options, its record (`record`) and, where there, its key (`key`); options on the command line, or `record` and `key` in `party.toml`, win. `--federation NAME` chooses one; where there is only one, it is used without being named; where there are several, the client says which there are and asks for one. `root`, `judge` and `twice`, using no options, read none. `init --federation NAME` begins a federation's directory, only its owner reading it, its `party.toml` holding the options given on the command line with it (`node`, `token`, `key`, the key's path made absolute; the node's default left out), and the record in it.
* docs: references to another document's section linked to ittv4 days1-2/+3
| | | | | | | | 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.
* continuum-party propose: the proposal's hash, and --yestv4 days1-7/+7
| | | | | `propose` says the proposal's hash, the version's, which `vote` takes; with `--yes`, it votes `true` on it too, by the record, as `vote` does.
* continuum-party next: the version after the current one, to changetv4 days1-2/+9
| | | | | | | `next` prints the current version numbered on, naming its hash as the version it changes, and without the checkpoint it names, whose heads are behind: what a party changes and proposes. The guides begin a version with it.
* guides: a party writes its node list without a votetv4 days1-1/+2
| | | | | | | Where a reader adding a node looks (getting started, proposing a version, who syncs), the guides say that a party writes its node list itself, signed with a key its version names, and link to how; a version names a list anew only where its party can't.
* guides: keys in an ssh-agentslopulus5 days1-2/+4
| | | | | | A party's key is `ssh-ed25519` or `ecdsa-sha2-nistp256`; the client signs with a private key file or through an ssh-agent holding the key, given its public key. Code of its own signing with ECDSA makes `s` low, which `ssh-keygen` does only half the time.
* events: the store's summary names the node's party, and whether it votes for ittv5 days1-1/+2
| | | | | | `GET /events` names the party the node is of (`party`, `--store-party`) and whether it votes for it by itself (`votesByItself`, `--store-vote-key`), and so casts a vote by hand (`POST /admin/events/vote`): what a page offering votes through the node asks.
* continuum-party: options from configuration files, as the node'stv5 days1-1/+5
| | | | | | | | | `continuum-party` takes its options (`node`, `token`, `key`, `record`: `config::PARTY_OPTIONS`) on the command line and in configuration files of the node's format: `--config`, repeatable, arguments winning, `--unset`, includes and imports. The configuration's loader takes the options it reads as a table (`config::with_options`, `config::merged`, `file::load_with`), the node's or the client's, and a key naming none of them is an error in either; `node` and `token` are secrets, never logged.
* guides: getting started with a federationtv5 days1-0/+189
`docs/guides/federation/` holds the guides to a federated swarm, the design saying what the rules are and they how to live by them. The first: two parties start a federation, a node each, write, read, and let a third party in by their votes. The README points to them.