Docs

Register → download → install → onboard.

1. Register

Request membership on the join page — you choose your account password there. The membership authority reviews applications; once approved, your identifier and password enroll every node you run via the onboarding wizard.

Already applied? Sign in to check your application status.

2. Install

One command — downloads the latest release, verifies the checksums, installs both binaries:

curl -fsSL https://git.federatedsearch.org/frx/frxd/raw/branch/main/install.sh | sh

Prebuilts: static Linux x86_64 (musl — no runtime dependencies) and macOS (Apple Silicon + Intel). The script checks your platform and stops with build instructions anywhere else. Pin a version or change the destination: curl -fsSL …/install.sh | FRX_VERSION=v0.1.13 FRX_DEST=~/.local/bin sh. Manual downloads and checksums: releases.

3. … or build it (it's Rust)

With a Rust toolchain (rustup.rs), one command compiles and installs both frxd and frx into ~/.cargo/bin:

cargo install --locked --git https://git.federatedsearch.org/frx/frxd.git

Or from a checkout:

git clone https://git.federatedsearch.org/frx/frxd.git
cd frxd
cargo build --release

Binaries land in target/release/. Source and spec (rfc.txt): git.federatedsearch.org/frx/frxd.

4. Onboard

frxd --onboarding
  1. Paste the credential block from step 1.
  2. The wizard generates your keys, enrolls them with the MA, verifies the signed registry against the pinned MA key, and wires the federation relays — no domains, DNS, or open ports needed on your side.
  3. Index a directory and mark what you share:

The credential block is reusable: run the wizard on every node you operate — each node binds its own key to your identifier. If the token leaks, the MA revokes it and issues a fresh one.

frxd add ~/documents --name docs --shared --exposure metadata
frxd serve

Search local-first with frx search "..."; broadcast to the federation with frx query "...". Nothing is shared until a collection is explicitly marked --shared.