Skip to main content
The floe CLI connects to https://api.floe.one by default. You can point it at any Floe signaling server using the --server flag.

Usage

Both sender and receiver must use the same server:
Terminal
Point --server at the origin that serves /api and /ws. On a one-domain deployment that is the same address your users open in a browser, so this is all you need: the share link that floe send prints resolves to the same origin and opens the web client correctly. If you always use the same server, set it once in your environment instead of repeating the flag on every command:
Terminal
A flag always beats the variable, so you can still override it for a single command. Use FLOE_WEB the same way when your web app has its own hostname. See Flags Reference.

When the web client is on a different host

The browser link printed by floe send defaults to the same origin as --server. If your web client lives somewhere else, such as the two-subdomain layout, override it with --web:
Terminal
Without --web, that split deployment prints a link pointing at the signaling server, which serves no web app.

Local testing

To test against a local instance running on the default ports:
Terminal
The browser link will point to http://localhost:3000 automatically when using localhost:3001.

Desktop app

The Floe desktop app can target a self-hosted server too. Open Settings, expand Advanced, and put your origin in Server address, then press Test to confirm the app can reach it. Leave Share link address blank on a one-domain deployment: the app derives the share link from the server address using the same rule the CLI uses. Fill it in only when your web app has its own hostname. Use default server appears once a custom address is set and clears both fields back to api.floe.one. See Desktop Settings for what Test checks and what each result means. See Self-Hosting for instructions on running your own Floe instance.