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

Files

Johnathan Corgan 77fdd52fe0 docs: reviewer feedback pass on Nostr-discovery surface

Walk through reviewer feedback on the Nostr-discovery docs and
land 18 items.

Bulk patterns:

- `external_addr` / `public: true` semantics consistently
  misdescribed. The advert path is gated on `cfg.is_public()`;
  inside that branch the daemon picks an address by precedence
  (`external_addr`, non-wildcard `bind_addr`, STUN). The docs
  treated `public: true` and `external_addr` as alternatives when
  they are stacked: `public: true` is the master switch and
  `external_addr` populates the address inside it. Reconciled
  across `enable-nostr-discovery.md` and `advertise-your-node.md`:
  add `public: true` to the `external_addr` examples; replace
  "STUN as a logging cross-check" with "STUN is skipped entirely";
  fix "neither flag is needed" for direct public bind (both flags
  still required); make the publish-tutorial Step 3 conditional
  on the chosen Step 2 path (STUN runs only on the `public: true`
  path); rewrite the troubleshooting "wrong public IP advertised"
  bullet with two coherent fixes.

- `udp:nat` overpromised as a symmetric-NAT solution. Symmetric
  NAT on either side typically defeats the punch. Reframe
  `udp:nat` as best-effort hole-punching for nodes without a
  directly reachable UDP endpoint in the how-to, the publish
  tutorial (intro, callout, section heading rewrite from "If
  you're behind symmetric NAT" to "If your direct UDP advert
  isn't reachable"), the consume tutorial's "What's next"
  pointer, and `tutorials/README.md`. Promote reachability over
  named NAT classes: STUN can confirm the public IP but not that
  the listener-port mapping is open.

- YAML "silently ignores unknown keys" is wrong. Config parser
  rejects unknown fields via `serde(deny_unknown_fields)` on the
  per-section structs; misspelled fields refuse the daemon's
  start with a parse-error line in the journal. Fixed in the
  publish tutorial's troubleshooting and the open-discovery
  tutorial's `policy` typo bullet.

Mechanical fixes:

- Repoint stale anchors. `getting-started.md` and
  `configuration.md` linked to `#installation` / `#inspect` on
  the README; the README has no such headings. Repoint to
  `#quick-start` and `cli-fipsctl.md`. Two stale anchors in the
  publish tutorial pointing at non-existent sub-scenarios in the
  how-to (`#sub-scenario-2c-...`,
  `#sub-scenario-2b-tor-onion-node`) repointed to the correct
  anchors.

- Drop the `fipsctl show status` claim from the open-discovery
  troubleshooting bullet (`show_status` doesn't include
  `discovery.nostr.policy`). Replace with daemon startup logs.

- Fix the `advertise: false` parenthetical in the consume-only
  tutorial (`default_advertise()` returns `true`; we set `false`
  explicitly for the consume-only path).

- Drop the "supplies a relay list" overstatement in two
  activation paragraphs (the how-to and the design doc). Default
  relay / STUN-server lists ship in the config; both are
  optional overrides.

- Add the missing `transports.udp.public` entry to the
  open-discovery tutorial's prerequisites checklist. Tutorial
  users coming out of advertise-your-node could be on either the
  direct-UDP (`public: true`) or `udp:nat` (`public: false`)
  path; list both.

Files: docs/getting-started.md, docs/reference/configuration.md,
docs/how-to/enable-nostr-discovery.md, docs/tutorials/README.md,
docs/tutorials/advertise-your-node.md,
docs/tutorials/resolve-peers-via-nostr.md,
docs/tutorials/open-discovery.md,
docs/design/fips-nostr-discovery.md.

2026-05-10 21:56:09 +00:00

9.3 KiB

Raw Blame History

Getting Started with FIPS

FIPS (Free Internetworking Peering System) is a self-organizing encrypted mesh network built on Nostr identities. Your machine becomes a node in the mesh with a self-generated cryptographic identity, and existing networking software — SSH, web servers, file transfer, anything IPv6-native — runs over the mesh unchanged.

There are two common ways to deploy FIPS, and the rest of this guide and the linked docs branch accordingly:

As an overlay on top of existing IP networks (Ethernet, WiFi, the public internet, Tor), FIPS lets your node reach any other peer regardless of NAT, ISP, or physical location.
From the ground up over non-IP transports — raw Ethernet, WiFi, Bluetooth — FIPS provides a complete permissionless network without any pre-existing IP infrastructure, ISP, or DNS.

The two paths share a lot of common ground — install, identity, configuration. They diverge mainly in transport setup and the deployment topology you choose.

There is no central server. Any node can run; any pair of running nodes can mesh.

What you'll need

A Linux, macOS, or Windows host. Linux is the most exercised platform; macOS and Windows installers are available.
The pre-built installer for your platform (see the project README's Quick start section for download links), or a source checkout if you want to build the installer yourself.
For the source-build path only: a working Rust toolchain (the version pinned in rust-toolchain.toml is auto-installed by rustup), and the platform-specific build dependencies listed in packaging/README.md.

Install

FIPS is installed by running a binary installer for your platform. The installer drops the daemon and CLI tools into system locations, installs systemd / launchd / Windows-service unit files, places a default fips.yaml, and creates the fips system group. There is no cargo install path: the daemon needs more than just binaries copied into place.

You can either build the installer yourself from source, or download a pre-built one from the release distribution. Both paths produce the same installer artifacts and the same post-install state.

From the release distribution

The most direct path. The release distribution carries a per-platform installer:

Debian/Ubuntu — .deb package
Arch Linux — fips AUR package
OpenWrt — .ipk package
macOS — .pkg installer
Windows — .zip with service-install scripts
Generic systemd Linux — .tar.gz with an install.sh script

See the project README's Quick start section for download links and per-platform invocations.

From source

For development, custom builds, or unsupported architectures. The packaging/ tree builds the same installer formats locally; you then apply the resulting installer the same way you would a downloaded one.

git clone https://github.com/jmcorgan/fips.git
cd fips/packaging
make deb         # or: tarball, ipk, aur, pkg, zip, all

The resulting installer lands in deploy/ at the project root. Apply it the same way you would a downloaded one (for example sudo dpkg -i deploy/fips_*.deb on Debian/Ubuntu).

See packaging/README.md for per-format build details, cross-target options, and the full make target list.

What's installed and running

Here's what the installer leaves on your machine, what's running, and what you'll need to set up yourself.

Binaries installed system-wide:

fips (daemon)
fipsctl (control-socket client)
fipstop (live-status TUI)
fips-gateway

Files placed on disk:

/etc/fips/fips.yaml — default daemon config (preserved on upgrade).
/etc/fips/fips.nft — mesh-interface nftables baseline (used only when the firewall service is enabled).
/etc/fips/fips.d/ — empty drop-in directory for operator nftables additions.
Systemd, launchd, or Windows-service unit files for the four fips services.

System changes:

A fips system group is created. Add your user to it (sudo usermod -aG fips $USER, then re-login) to run fipsctl and fipstop without sudo.
The runtime directory /run/fips/ exists with mode 0750 root:fips.

Services enabled and started on boot:

fips.service — the daemon. Brings up the fips0 TUN adapter, listens on the configured transports, and exposes the control socket at /run/fips/control.sock.
fips-dns.service — wires .fips hostname resolution into the host resolver (a /etc/systemd/resolved.conf.d/ drop-in pointing at [::1]:5354 on systemd hosts).

Services installed but not enabled (operator opt-in):

fips-firewall.service — applies /etc/fips/fips.nft to the mesh interface. See how-to/enable-mesh-firewall.md.

What's working out of the box:

The daemon is running with a fresh ephemeral identity — a new Nostr keypair is generated on every start.
The fips0 TUN adapter exists with the daemon's mesh address.
The daemon's transport listeners are up: UDP 0.0.0.0:2121 and TCP 0.0.0.0:8443. They are inert at this point because no other node knows your daemon's npub yet — see "What's not yet configured" below.
.fips hostname resolution is plumbed into the host resolver.

What's not yet configured — these are what guide your next steps:

No peers. The daemon has nobody to talk to until you add a static peer entry, enable Nostr-mediated discovery, or bring up a transport (Ethernet, Bluetooth) where peers find each other automatically on the same physical link.
Ephemeral identity. Your node's npub changes every restart. The persistent-identity tutorial walks through pinning the daemon to a stable Nostr keypair for any node others will reference by name.
Mesh firewall not active. Inbound exposure on fips0 follows the host's existing firewall rules until you enable the baseline service.

Reaching mesh nodes by name

A FIPS node is identified by its Nostr public key (npub1...). For ordinary IP software running over the mesh — SSH, web browsers, ping, file transfer — use the form <npub>.fips as the destination; the local .fips resolver translates that to the corresponding mesh IPv6 address so the FIPS node can be found. The resolver runs entirely on your machine and does not generate any external DNS traffic.

For shorter forms, the resolver also consults two host maps before falling back to direct npub lookup: /etc/fips/hosts (shipped pre-populated with the public test mesh roster, and freely editable for your own entries) and the alias: field on configured peers in fips.yaml. So test-us01.fips, my-laptop.fips, or any other shortname you map resolves the same way <npub>.fips does. See how-to/host-aliases.md for the full mechanics.

Join the test mesh

The fastest way to see FIPS in action is to connect your daemon to the public FIPS test mesh. The Join the Test Mesh tutorial walks through adding a single static peer entry, watching the link come up, and reaching both that peer and a second mesh node forwarded through it — a ten-minute exercise that demonstrates the central FIPS guarantee that one good peer connects you to the rest of the mesh.

Where to go next

Documentation is organised into four sections, each with a different job. Pick the one that matches what you want to do.

Tutorials

Step-by-step lessons that take you from zero to a working setup. Read these end-to-end. Start with Join the Test Mesh and follow with ipv6-adapter-walkthrough to understand what each piece does, then move on to persistent-identity and the three Nostr-discovery tutorials — resolve-peers-via-nostr, advertise-your-node, and open-discovery — to give your node a stable npub, look up peer endpoints, publish your own, and join the ambient discovery namespace. Then host-a-service for hosting a service on your node, and ground-up-mesh for the second deployment mode where two devices peer over Ethernet, WiFi, or Bluetooth with no IP between them.

How-To Guides

Task-oriented recipes for operators with a specific goal: enable a firewall, deploy the LAN gateway, set up Bluetooth peering, diagnose an MTU problem, configure persistent identity. Each guide takes the shortest correct path from "I want to do X" to "X is done".

Reference

Lookup material consulted on demand: wire formats, configuration keys, command-line flags, control-socket commands. Austere by design; no guidance on when to use a feature.

Design

Architectural and protocol-level explanations: the mesh layer, the session layer, the spanning tree, Bloom-filter discovery, the unified MTU model, the IPv6 adapter. Read these to understand why FIPS makes the choices it does.

The design section's fips-concepts.md is a good entry point if you want the mental model before touching any commands.

9.3 KiB Raw Blame History