> ## Documentation Index
> Fetch the complete documentation index at: https://www.floe.one/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Glossary

> Plain definitions of the words Floe and these docs use, from share link and relay to WebRTC and STUN, each with a link to the page that explains it.

This page explains the words you meet in Floe and in these docs, in one or two plain sentences
each. Every entry ends with a link to the page that covers the subject properly.

<h2 id="the-short-version">
  The short version
</h2>

Most of Floe comes down to six of these words. A [share link](#share-link) or a
[room code](#room-code) brings the other person into a [room](#room) on Floe's
[signaling server](#signaling-server). The two devices then connect, by a
[direct connection](#direct-connection) or through a [relay](#relay), and the files never pass
through the signaling server.

<h2 id="words-you-see-in-floe">
  Words you see in Floe
</h2>

Labels on screen, and the names Floe gives to what it shows you.

<h3 id="floe-blocked-file">
  .floe-blocked file
</h3>

A file from a request link that Floe Desktop saved with `.floe-blocked` added to its name, so File
Explorer leaves it alone. Floe does this to the few file types that File Explorer opens by itself,
such as shortcuts (`.lnk` and `.url`). Delete it if you did not expect it, and rename it back only
if you did and you trust the sender. See [Request links](/docs/desktop/request-links#renamed-files).

<h3 id="part-file">
  .part file
</h3>

A file that Floe Desktop or the `floe` CLI is still receiving, named like `report.pdf.part`. It
gets its real name only once it is complete and has passed its checks. Anything in the folder
without `.part` is whole. See [Receiving files](/docs/desktop/receiving#if-a-transfer-stops-partway).

<h3 id="auto-accept">
  Auto-accept
</h3>

A check on one request link in Floe Desktop that lets files through that link save without the
Accept step. It is off on every new link, and an unusual drop still asks first. See
[Request links](/docs/desktop/request-links#auto-accept).

<h3 id="badge">
  badge
</h3>

The dot and word at the top right of the transfer card. In the web app it reads **Offline**,
**Ready**, **Direct** or **Relay**, and the last two tell you which way your files travel. See
[Sending files](/docs/web-app/sending#watch-the-connection).

<h3 id="drop">
  drop
</h3>

One sending through a request link: everything one person sends in one go. A request link takes
one drop and is then used up. See [Request links](/docs/desktop/request-links#what-a-request-link-is),
or [Sending through a request link](/docs/web-app/request-links) if you are the one sending.

<h3 id="hide-my-ip">
  Hide my IP
</h3>

A setting that sends everything through the [relay](#relay), so the other person sees the relay's
address and not yours. It limits a transfer to 2 GB. Floe Desktop calls it **Hide my IP address**,
a request link's page **Hide my IP (relay only, 2 GB per drop)**, and the CLI `--relay-only`. See
[Relay fallback](/docs/how-it-works/relay-connection#turning-it-off-and-the-opposite).

<h3 id="network-relay-fallback">
  Network relay fallback
</h3>

The checkbox on the web app's sending page that lets Floe use the [relay](#relay) when a direct
connection is not possible. It is checked by default, and shows only until you create the link.
These docs also call it relay fallback, and the CLI's `--no-relay` is its nearest equivalent. See
[Sending files](/docs/web-app/sending#decide-whether-the-relay-is-allowed).

<h3 id="peer">
  peer
</h3>

The other device in a transfer. The web app's status line uses the word: "Waiting for peer" means
your page is waiting for the other device to join. See
[Sending files](/docs/web-app/sending#watch-the-connection).

<h3 id="request-link">
  request link
</h3>

A link made in Floe Desktop that works the other way around: whoever opens it sends files to the
PC that made it. It has `/r/` in its address and takes one drop. See
[Request links](/docs/desktop/request-links).

<h3 id="room-code">
  room code
</h3>

Three words, such as `olive-tiger-castle`, that the receiver can type in place of a link.
`floe send` and Floe Desktop show one, and it works for 10 minutes at most. The web app neither
makes nor accepts room codes. See
[How a transfer works](/docs/how-it-works/signaling#code-and-link-lifetime).

<h3 id="sha-256-matched">
  SHA-256 matched
</h3>

What Floe shows when every file of a transfer matched the [SHA-256](#sha-256) the sender
computed. It means the files arrived intact, not that they are safe to open. The CLI prints the
words. The web app's main page and Floe Desktop show a green check mark in place of them, and a
screen reader reads it as "SHA-256 matched". See
[File checks](/docs/how-it-works/file-checks#what-you-see-in-each-app).

<h3 id="share-link">
  share link
</h3>

The web address a sender gives the receiver. Opening it joins that one transfer, and it works only
while the sender is still connected. See [Sending files](/docs/web-app/sending#create-the-link).

<h2 id="how-a-transfer-travels">
  How a transfer travels
</h2>

The ideas behind where your files go and who can see what.

<h3 id="direct-connection">
  direct connection
</h3>

A connection straight from one device to the other, with no server carrying the files. Floe sets
no size limit on it, and most transfers are direct. See
[Direct connections](/docs/how-it-works/direct-connection).

<h3 id="encrypted-end-to-end">
  encrypted end to end
</h3>

Scrambled on your device and unscrambled only on the other person's, so nothing in between can
read your files. That includes Floe's own servers, and every transfer works this way. See
[Encryption](/docs/how-it-works/encryption).

<h3 id="signaling-server">
  Floe's server / signaling server
</h3>

The server that introduces two devices so they can connect to each other. It passes their
connection details and never receives your files. These docs call it Floe's server or the
signaling server. See [How a transfer works](/docs/how-it-works/signaling#what-the-server-does).

<h3 id="in-app-browser">
  in-app browser
</h3>

The small browser built into another app, such as Instagram or Facebook, that opens links inside
that app. File transfers work poorly there, so Floe asks you to open the link in your own browser.
See [Receiving files](/docs/web-app/receiving#if-floe-says-open-in-your-browser).

<h3 id="ip-address">
  IP address
</h3>

The number that identifies your connection on the internet. It can show your internet provider and
roughly where you are. On a direct connection the other person's device learns it. See
[Known limitations](/docs/how-it-works/known-limitations#the-other-person-learns-your-ip-address).

<h3 id="peer-to-peer">
  peer-to-peer
</h3>

Sent from one device to the other, with no server in between that stores the files or can read
them. Floe's server only introduces the two devices. See
[How a transfer works](/docs/how-it-works/signaling).

<h3 id="relay">
  relay / TURN relay
</h3>

A server both devices can reach that passes the encrypted data along when they cannot connect
directly. It cannot read the files, and a transfer through it is limited to 2 GB. Relay, TURN
relay, relay fallback, **Network relay fallback**, **Hide my IP** and `--relay-only` all refer to
this one server: some name it, and some are the settings that allow or require it. See
[Relay fallback](/docs/how-it-works/relay-connection).

<h3 id="room">
  room / room id
</h3>

The private meeting point on Floe's server for one transfer. It holds two devices, one sender and
one receiver, and turns a third away. Its room id is a long random code, and a share link carries
it after the `#`. Whoever has the room id can join while the room has a free place, so it is the
part of the link to keep private. See [How a transfer works](/docs/how-it-works/signaling#a-room-holds-exactly-two-people).

<h3 id="self-hosted">
  self-hosted
</h3>

Run on your own server instead of on floe.one. You run Floe's server and the web app yourself, and
these docs call that setup an instance. The CLI and Floe Desktop can be pointed at it. See
[Self-hosting overview](/docs/self-hosting/overview).

<h3 id="sha-256">
  SHA-256
</h3>

A fingerprint worked out from a file's contents. When the sender's and the receiver's fingerprints
match, the file arrived unchanged. Floe never shows the value itself, only whether every file
matched. See [File checks](/docs/how-it-works/file-checks#the-sha-256-check).

<h2 id="technical-terms">
  Technical terms
</h2>

Names you can skip until an error message or a setup page uses one.

<h3 id="cli">
  CLI
</h3>

Short for command-line interface: a program you use by typing commands in a terminal. Floe's is
the `floe` command, for macOS, Windows and Linux. See [Install the CLI](/docs/cli/installation).

<h3 id="data-channel">
  data channel
</h3>

The encrypted connection between the two devices that carries the files. It is part of
[WebRTC](#webrtc), and the signaling server is not part of it. See
[Encryption](/docs/how-it-works/encryption#how-the-encryption-works).

<h3 id="docker-compose">
  Docker Compose
</h3>

A tool that starts a set of packaged programs with one command, from one settings file. It is the
standard way to run your own Floe. See [Docker quickstart](/docs/self-hosting/quickstart).

<h3 id="dtls">
  DTLS
</h3>

The encryption that protects a WebRTC connection. It is the protection behind `https` web
addresses, called TLS, adapted to this kind of connection. See
[Encryption](/docs/how-it-works/encryption#how-the-encryption-works).

<h3 id="ice">
  ICE
</h3>

The step in which the two devices try the network paths between them and keep one that works. Its
result decides whether a transfer is direct or relayed. See
[Direct connections](/docs/how-it-works/direct-connection#how-floe-decides-a-connection-counts-as-direct).

<h3 id="mark-of-the-web">
  mark of the web
</h3>

The tag Windows puts on a file that came from the internet, so that it takes care before opening
it. Floe Desktop and the CLI put it on every file they receive on Windows, where the drive can
keep it. See [Receiving files](/docs/desktop/receiving#received-files-are-marked-as-downloads).

<h3 id="nat">
  NAT
</h3>

The way a router lets many devices share one public address. Because of it, two devices usually
cannot reach each other without help, which is what [STUN](#stun) and the [relay](#relay) are for.
Carrier-grade NAT is the same done by a provider for many customers at once, as some mobile
carriers do, and it can force the relay.
See
[Direct connections](/docs/how-it-works/direct-connection#how-two-devices-on-different-networks-find-each-other).

<h3 id="package-manager">
  package manager
</h3>

A tool that installs and updates programs for you, such as Homebrew, winget or Scoop. It is the
fastest way to install the `floe` CLI. See [Install the CLI](/docs/cli/installation#package-managers).

<h3 id="path">
  PATH
</h3>

The list of folders your terminal searches when you type a command name. `floe` runs by name only
when its folder is on that list. See
[Troubleshooting](/docs/troubleshooting#floe-is-not-found-after-installing).

<h3 id="rate-limit">
  rate limit
</h3>

A cap on how many requests one network address may make in a set time, 60 seconds for most. Past
it, Floe's server refuses more until earlier requests are old enough, so it clears by itself. See
[Limits](/docs/reference/limits#server-limits).

<h3 id="reverse-proxy">
  reverse proxy
</h3>

A web server, such as Caddy or nginx, placed in front of Floe that receives visitors' requests and
passes them on. A self-hosted Floe in production normally sits behind one. See
[Reverse proxy](/docs/self-hosting/reverse-proxy).

<h3 id="smartscreen">
  SmartScreen
</h3>

The Windows warning shown the first time you run a program that carries no publisher's signature.
Floe Desktop from GitHub shows it, and the Microsoft Store version does not. See
[Install the desktop app](/docs/desktop/installation#choose-a-channel).

<h3 id="stun">
  STUN
</h3>

A helper server that tells a device what its address looks like from the internet, so two devices
can try to connect directly. It never sees a file. See
[Direct connections](/docs/how-it-works/direct-connection#how-two-devices-on-different-networks-find-each-other).

<h3 id="turn">
  TURN
</h3>

The technical name for the kind of [relay](#relay) Floe uses. Where these docs say TURN or TURN
relay, they mean the relay. See [Relay fallback](/docs/how-it-works/relay-connection).

<h3 id="url-fragment">
  URL fragment
</h3>

The part of a web address after the `#`. A browser does not send it when it requests a page, so
the room id Floe keeps there stays out of web server logs. See
[Security and privacy](/docs/security-privacy#the-room-secret-stays-out-of-every-server-log).

<h3 id="webrtc">
  WebRTC
</h3>

The technology, built into browsers, that connects two devices to each other and encrypts what
passes between them. Floe uses it to carry your files, in the web app, Floe Desktop and the CLI
alike. See [How a transfer works](/docs/how-it-works/signaling).

<h3 id="websocket">
  WebSocket
</h3>

A connection that stays open so a program and a server can send each other messages at any time.
The CLI and Floe Desktop use one to talk to Floe's server, and the web app uses a library called
Socket.IO for the same job. See
[Architecture](/docs/reference/architecture#two-signaling-transports-one-room-registry).

<h3 id="webview2">
  WebView2
</h3>

A Microsoft component that Floe Desktop uses to draw its window. Windows 11 includes it, and Floe
offers to install it when it is missing. See
[Install the desktop app](/docs/desktop/installation#requirements).


## Related topics

- [File size limits and the 2 GB relay cap](/docs/how-it-works/2gb-limit.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.