mirror of
https://github.com/jmcorgan/fips.git
synced 2026-08-02 12:56:15 +00:00
Johnathan Corgan
b0e9627a77
Master is now the v0.4.0-dev line; next moves up to v0.5.0-dev for the wire-format-breaking work staged here. - Cargo: 0.4.0-dev → 0.5.0-dev - CHANGELOG Breaking-section header retargeted to v0.5.0; baseline bumped from v0.2.x to v0.3.x peers (master is now the v0.3.1-dev patch line and v0.4.0-dev minor line, so v0.5.0 breaks against v0.3.x, not v0.2.x) - README: badge v0.4.0--dev → v0.5.0--dev, three Status & Roadmap prose references retargeted - docs/reference/cli-fips.md: example version 0.4.0-dev → 0.5.0-dev
Reference
Information-oriented technical descriptions for lookup on demand. Reference content describes what is: wire formats, configuration keys, command-line flags, control-socket commands, default values, file paths, exit codes. It is consulted, not read end-to-end.
Reference is austere by design: minimal narrative, no opinions, no guidance on when to use a feature. The "why" lives in design/; the "how do I accomplish X" lives in how-to/.
Available Reference
| Document | Scope |
|---|---|
| wire-formats.md | All FMP and FSP message byte layouts, encapsulation walkthrough |
| configuration.md | Full YAML configuration reference for the daemon and gateway |
| security.md | nftables baseline, peer ACL, cryptographic primitives, rekey defaults, threat-resistance matrix |
| nostr-events.md | Kind 37195 advert, Kind 21059 traversal signaling, Kind 10050 inbox relays |
| transports.md | Per-transport statistics counter inventory |
| control-socket.md | Line-delimited JSON control protocol for the daemon and gateway |
| cli-fips.md | fips daemon CLI: options, exit codes, environment, files |
| cli-fipsctl.md | fipsctl control-client: subcommands, options, exit codes |
| cli-fipstop.md | fipstop live-status TUI: tabs, keybindings |
| cli-fips-gateway.md | fips-gateway service CLI: options, exit codes, files |