Skip to content

Getting started

This walkthrough takes you from a fresh sign-in to a live review session: create a stream key, create a room, connect an encoder, go live, and share the link. It assumes Farbstrom is already deployed and you have the admin password.

Throughout, <host> is your Farbstrom domain (e.g. stream.yourdomain.com).

1. Sign in to the admin panel

Open https://<host>/admin. Enter your admin password. If two-factor authentication or a passkey is enabled on your account, complete that prompt too. (See Settings to set these up.)

2. Create a stream key

A stream key is the credential your encoder uses to push video in.

  1. Go to the Stream keys tab.
  2. Click + New Key, give it a recognizable name (e.g. Main Suite), and create it.

The key's card shows the ingest URLs you'll need in step 4. More detail in Stream keys.

3. Create a room

  1. Go to the Rooms tab and click + New Room.
  2. Fill in the room:
    • Name — e.g. Client Review — Project X.
    • Delivery modeWebRTC (sub-second, recommended) for most reviews; LLHLS for broader compatibility; Farbplay (SRT) for the native app.
    • Stream key — select the key from step 2.
    • Expires — optional; the room stops working after this time.
    • Optional: a password, a waiting room, and audio defaults (noise reduction, echo cancellation, push-to-talk).
  3. Save. The room appears as a card with its shareable links.

Full detail in Rooms.

4. Connect your encoder

The Stream keys tab lists the full ingest URL for every protocol next to your key — copy the one you need straight into your encoder, no hand-editing required. SRT is recommended (lowest latency, H.265 passthrough); RTMP is the universal fallback.

Step-by-step instructions, protocol guidance, and recommended encoder settings are in Encoders and OBS Studio.

5. Go live

Start streaming in your encoder. Within a moment the room goes live, and the stream shows up on the admin Dashboard with its bitrate, resolution, and duration.

6. Invite viewers

Each room card has two links:

  • Viewer link (https://<host>/watch/<slug>) — share this with participants.
  • Presenter (host) link — grants presenter controls; share only with co-hosts.

Use the copy buttons on the card. If the room has a password, share that separately.

7. Admit and moderate

If the room has a waiting room, participants appear in the room card (and the roster) until you Admit them — individually or all at once. You can also mute or remove participants during the session.

8. End the room

When you're done, click End Room on the card. Viewers see a "session has ended" screen.

Next steps

Farbstrom is licensed under AGPL-3.0.