mirror of
https://github.com/jmcorgan/fips.git
synced 2026-08-03 21:36:16 +00:00
Johnathan Corgan
7865557f8a
Brings v0.3.0 release content forward into the next-branch development line, preserves next's own version state, and updates operator-facing version references to v0.4.0-dev. Kept from master: - docs/releases/release-notes-v0.2.1.md and -v0.3.0.md (cumulative archive of shipped releases) - RELEASE-NOTES.md root mirror at v0.3.0 (tracks the most recent shipped release; will be replaced when the v0.4.0 release cycle begins on this line) - CHANGELOG entries: [0.3.0] and [0.2.1] sections inserted under the existing Breaking and [Unreleased] sections - All code, config, test, and documentation updates from master (openwrt yaml resync, doc-config IP placeholders, etc.) Kept from next (resolved against master's release-prep changes): - Cargo.toml / Cargo.lock at 0.4.0-dev (next's package version) - CHANGELOG ## Breaking section (next-specific v0.4.0 wire-format breaking work) and the empty ## [Unreleased] block for future v0.4.0 non-breaking work Updated to v0.4.0-dev for consistency with Cargo.toml: - README badge (v0.3.0--dev -> v0.4.0--dev) and status-section prose, rewritten to describe v0.4.0 wire-format-breaking work on this branch (Noise XX unification, FMP node profiles, slimmer MMP, extensible bloom-filter encoding) instead of the v0.3.0 testing-and-polishing narrative that applied while v0.3.0 was unreleased - docs/reference/cli-fips.md example version string
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 |