mirror of https://github.com/jmcorgan/fips.git synced 2026-07-22 07:48:26 +00:00

Files

Johnathan Corgan d3cf1d6f25 Land v0.4.0 pre-release source content: docs, changelog, packaging

Bring the source tree to its finished v0.4.0 content state ahead of the
release candidate. Documentation, changelog, release notes, and
packaging metadata only; no code or version-string changes.

CHANGELOG.md: backfill the operator-visible changes that landed since
v0.3.0 (the show_metrics scraper query and fipsctl stats metrics, the
discovery dedup-cache-full counter, the off-rx_loop control read
surface and its new daemon-resolved fields, the fipstop TUI overhaul,
the TCP inbound cap now honoring max_connections, host-map hot-reload,
log-noise demotions, and the net bug fixes), topic-grouped rather than
replayed per commit; intra-cycle fixes folded into their feature
entries; the duplicate Unreleased Fixed section merged into one.

Release notes: author docs/releases/release-notes-v0.4.0.md to the
operator-upgrade bar and mirror it byte-for-byte into the root
RELEASE-NOTES.md. Attribute each feature to its author in Contributors
(Nym transport and the mixnet demo to @oleksky, opt-in mDNS LAN
discovery to @mmalmi).

README.md: add the Nym transport to the support matrix (Linux, macOS,
Windows; OpenWrt pending verification), the multi-transport bullet, and
the "What works today" list; fold mDNS LAN discovery into the existing
Nostr-discovery bullets; refresh the status narrative to v0.4.0 over a
global, public test mesh.

packaging/common/fips.yaml: add commented Nym transport and mDNS LAN
discovery example stanzas with verified field names and defaults.

Cargo.toml: add homepage, keywords, and categories crate metadata.

docs/reference: update the cli-fips version example to the released
form; document the new control-socket output fields and the typed
RejectReason families in control-socket.md; sync cli-fipstop.md with the
overhauled TUI keybindings.

2026-06-14 17:23:44 +00:00

3.7 KiB

Raw Permalink Blame History

`fips`

The FIPS mesh network daemon.

Synopsis

fips [-c FILE]

On Windows the same binary additionally accepts --install-service, --uninstall-service, and (used internally by the service control manager) --service.

Description

fips is the FIPS daemon. It loads a YAML configuration, resolves an identity, brings up the TUN adapter, listens on configured transports, authenticates peers, maintains the spanning tree, and forwards mesh traffic. There is one daemon per node.

The daemon stays in the foreground, logging to stderr, until it receives SIGINT or SIGTERM. On Windows, the service variant is controlled through the standard service control manager.

Options

Flag	Argument	Description
`-c`, `--config`	`FILE`	Use `FILE` as the configuration. Skips the default search paths.
`-V`	—	Print the short version (e.g. `0.4.0 (rev abcdef1)`).
`--version`	—	Print the long version: short version plus build target triple.
`-h`, `--help`	—	Print usage and exit.
`--install-service`	—	(Windows only) Install `fips` as a Windows service. Requires Administrator.
`--uninstall-service`	—	(Windows only) Uninstall the Windows service. Requires Administrator.
`--service`	—	(Windows only, internal) Run as a Windows service. Invoked by the service control manager — not for direct use.

There are no other CLI flags; all daemon behaviour is governed by the YAML configuration. See configuration.md.

Exit Codes

Code	Meaning
`0`	Clean shutdown after `SIGINT` / `SIGTERM`.
`1`	Failed to load configuration, resolve identity, construct the node, or start the node. The reason is printed to stderr before exit.

Environment

Variable	Description
`RUST_LOG`	Tracing filter directive. Overrides `node.log_level` from the config. Examples: `info`, `debug`, `fips=trace,fips::node::handlers::mmp=debug`.
`XDG_RUNTIME_DIR`	Used to derive the default control-socket path when `/run/fips` does not exist. See control-socket.md.
`FIPS_CONFIG`	(Windows service mode only) Path to the configuration file when the daemon runs under the service control manager.

The daemon also clamps the nostr_relay_pool, nostr_sdk, and nostr log targets to info whenever the effective log level is below trace, so that RUST_LOG=debug does not flood the journal with raw relay frames. To see those frames, set the level to trace.

Files

fips looks for fips.yaml in the following locations, lowest to highest priority. All present files are merged in priority order; the highest-priority value wins.

Priority	Path	Purpose
1	`/etc/fips/fips.yaml`	System-wide defaults
2	`~/.config/fips/fips.yaml`	User preferences
3	`~/.fips.yaml`	Legacy user config
4	`./fips.yaml`	Deployment-specific overrides

Adjacent to the highest-priority config file the daemon reads (or writes, on first start) the identity files:

File	Mode	Purpose
`fips.key`	`0600`	Bech32 nsec for the persistent identity (Unix only; Windows inherits parent ACLs).
`fips.pub`	`0644`	Bech32 npub corresponding to `fips.key`.

When node.identity.persistent is false (the default), a fresh keypair is written to these files on every start.

The control socket path is derived per control-socket.md.

3.7 KiB Raw Permalink Blame History

fips