How nfltr Works
Draft
This page is a draft for review.
nfltr connects machines you own through a relay: the hosted one at nfltr.xyz, or your own relay (beta). This page explains the parts, the flow of one connection, what the relay can and cannot see, and the limits today. Agent orchestration (nfltr-orch) is not part of nfltr and is not publicly available.
The parts
- The client. The
nfltrcommand on each machine. It enrols the machine (nfltr config login, ornfltr config set-relayfor your own relay), serves local services (nfltr http,nfltr cat serve,nfltr up) and connects to services of other machines (nfltr cat pipe,nfltr cat forward,nfltr cat ssh,nfltr cat cp). - The relay. Carries traffic between your machines and to share links. It is nfltr.xyz, or a relay you run with
nfltr relay serve(beta). Machines connect out to it, so only the relay needs an open port. - Machines. Each enrolled machine holds a certificate of its own, made on it; machines of one account reach each other's services by name (
nfltr machines list).
The flow of one connection
- Enrol. Each machine enrols once and keeps its certificate (Getting Started).
- Serve. A machine serves a local service through the relay, for example
nfltr cat serveor a service in annfltr upfile. - Connect. Another machine of the account connects by machine and service name, for example
nfltr cat pipe; a browser opens a share link fromnfltr httpornfltr up. - Carry. The relay forwards the bytes between the two ends. It routes only inside one account, unless a group rule allows more (Organisations).
What the relay can and cannot see
Always visible to the relay: your account, machine names, which machine connects to which and when, and the size and timing of traffic. It holds no machine key: each machine's key is made on it and never leaves it.
| Feature | What the relay sees |
|---|---|
nfltr cat with --allow-group (cat pipe, cat cp, cat forward, cat serve --exec) | Encrypted end to end between the two machines of your organisation (TLS with their machine certificates). The relay sees the two machines, the service, and sizes and timing; not the bytes, file names or commands. |
nfltr http (tunnels and their share links) | Encrypted end to end by default: TLS ends on your machine. Readable at the relay only in inspectable mode (--mode inspectable), which features that read requests at the relay need, such as routes. |
nfltr cat serve (raw TCP tunnels, without --allow-group) | Readable at the relay, unless the protocol inside is encrypted (SSH is). |
Where it runs
- Hosted (nfltr.xyz). We run the relay. Your machines connect out to it. What leaves your network: your machines' traffic to nfltr.xyz, encrypted end to end where the table above says so.
- Your own relay (beta).
nfltr relay serveon a machine of yours, with your TLS certificate or a pinned self-signed one, andnfltr config set-relayon each machine. Nothing in nfltr calls out on its own: only your relay and any STUN or TURN server you configure are contacted.nfltr updatereaches nfltr's download server only when you run it. Share links work on a domain of yours with a wildcard certificate; no dashboard or failover in the beta (tutorial).
Limits today
- One relay host. nfltr.xyz runs on a single relay host, without high availability: a deploy or restart interrupts connections for up to a minute or two, and agents reconnect by themselves. Your own relay is also one process.
- Beta pieces. Your own relay is a beta, with machines enrolled by single-use codes, share links only on a domain of yours, and no dashboard or private LAN.
Next
- Getting Started: install, enrol a machine, share an app.
- Run Your Own Relay (Beta): step by step.
- Architecture and Guarantees: the layers and what each guarantees.