OpenFollow Preview

Manual / Reference

Networking & Security

OpenFollow targets trusted LAN deployment. A few settings are worth reviewing before running on a shared production network.

Network configuration

Addressing is set per adapter under General → Network Interface Settings in the web UI, or on the device under Settings → Network Interfaces. The web form is gated by the Web PIN. On a host whose addressing OpenFollow can't manage, the web panel is read-only; on Debian, hand the network over to NetworkManager as described under Installation.

Network mode

  • Simple – one interface carries everything: PSN, discovery, marker sync, OTP, RTTrPM, OSC and network video. Interface picks it; Automatic lets the station choose.
  • Advanced – functions can be pinned to separate interfaces under Network Interface Assignment, and VLANs can be added.

Switching to Simple asks for confirmation first: every interface pin is cleared and every VLAN is removed, except the station interface's own and the one carrying your browser session. Switching to Advanced changes nothing.

Network Interface Settings

One row per adapter, with a green indicator when it is up with an address. Edit unlocks a row.

FieldDescription
LabelYour name for the adapter, up to 20 characters, unique. Shown in every interface picker. Its own Save stores only the label.
Port, Model, MAC addressAs reported: the USB socket, Built-in Ethernet or Wi-Fi.
MethodDHCP (automatic): the network assigns everything. DHCP with manual address: DHCP supplies subnet and router, the address is fixed. Static: you enter address, subnet mask and router.
IP address, Subnet mask, RouterSubnet mask is required for Static. Router is optional and must sit inside the subnet; leave it blank on a flat show LAN with no internet egress.
DNS Server 1–3Only for outside hostnames. Blank on an offline LAN.
Lease RemainingTime left on the DHCP lease.

Apply validates and saves the row; an invalid entry shows a banner and nothing is committed. Renew DHCP lease asks for a new lease. Cancel discards edits. Scan re-reads the adapter list. Changing the adapter that answers your browser drops the page.

Settings can be saved for an adapter that is not plugged in (DHCP, DHCP with manual address, or Static) and take effect when it comes up; DHCP with manual address needs the adapter plugged in to apply. An unplugged adapter with saved settings stays listed as Not connected; Forget deletes its settings, VLANs and label after asking.

An adapter on DHCP with no server answering takes a 169.254.x.x address within a few seconds, and the Operator Screen shows DHCP unavailable.

A USB Ethernet adapter is named after its MAC address, like enx88a29edf04e3, so the name stays with that adapter. A replacement adapter has a new name and needs its assignments re-picked. Give adapters a label to tell the names apart.

VLANs

In Advanced mode, + Add VLAN creates a sub-interface for one 802.1Q tag: pick the Parent interface and a VLAN ID (1–4094). It starts without an address. Remove VLAN stops anything pinned to it; it is refused for the interface answering your browser.

Network Interface Assignment

Advanced mode only. Functions are pinned by interface name, not IP address, so a pin survives a DHCP renewal. Station default is the interface every blank row follows; Auto-detect leaves it to the system. PSN in / out and Discovery / marker sync always follow Station default.

RowPins
OSC inputThe interface for the OSC multicast subscription. Has no effect unless a Multicast group is set. It does not restrict accepted sender addresses; use Allowed sender IPs.
RTTrPM output, each OSC DestinationThe interface the messages leave from. A destination the interface can't reach gets nothing.
Video inputThe interface the network camera is reached through. NDI, Pi Camera, USB cameras and the Media Gallery are not pinned.
Web UIBlank answers on every interface. Pinned, it answers only at that interface's address, and falls back to answering everywhere if the interface goes away. Takes effect after Save and Restart OpenFollow.

A pinned function stops when its interface is lost; it never moves to another interface. The Address column shows Interface down (or Not connected for an unplugged adapter), and the Operator Screen lists the function as a red row. It resumes on its own once the interface has an address again; a changed DHCP address is followed. A Video input pin shows Interface down or Wrong interface (camera reached through another interface).

If a web UI pin locks you out, open the station's own Network Interfaces screen on the Operator Screen and choose Serve web UI on all interfaces. Pins are not included in a configuration export.

Station address

The station is reachable at its .local name (mDNS address, read-only, follows the station name; shown on the Operator Screen as the web address). On a venue network with its own DNS, set a Custom domain name (FQDN) under General → Station Settings → Advanced Settings. It must resolve to this station in the venue's DNS, is registered with DHCP, and replaces the .local name on the Operator Screen; the .local name keeps working. Saving a changed name reconnects every network interface, so each link drops for a few seconds. Remove FQDN on the device's Network Interfaces screen clears it.

Web PIN

Set a numeric PIN (1–32 digits) under General → Station Settings → Web access PIN (leave empty to disable). While unset, every web route is open. Once set:

  • Browsers must enter the PIN to reach any non-asset route.
  • Peer-to-peer broadcasts between OpenFollow instances are authenticated with the PIN. The PIN itself never travels on the wire.

Treat the PIN as operator credentials. Anyone who has it can change settings and install a software update onto the device.

Leaving the PIN unset is acceptable on bench networks only. Production setups should always have one.

OSC input allowlist

OpenFollow accepts /marker/<id> x y z on the OSC input port (default 8765). Without a sender allowlist, any device on the LAN can hijack marker positions.

Configure under Input → OSC Input → Allowed sender IPs as a comma-separated list:

192.168.1.10, 192.168.1.20, 10.0.0.50

List one IP per authorised control surface – the touchscreen, the lighting console, the show control machine. Leave blank only when you are absolutely sure the LAN is trusted (e.g. dedicated point-to-point cable to a single sender).

Peer broadcast

OpenFollow instances discover each other on the LAN. The Apply to all stations button on the Camera & Lens Calibration and Grid sections pushes that section to peers. Outgoing peer requests are restricted to private destinations only:

  • RFC 1918 – 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16
  • Link-local – 169.254.0.0/16
  • Loopback – 127.0.0.0/8

Public destinations are rejected. Peer requests are authenticated with the Web PIN; a peer with a different PIN (or no PIN) rejects the request.

Software updates

Updates are installed from General → Software Update as signed .ofupdate bundles, online or from a file. See Updating. Anyone with the Web PIN can install an update and restart the service; there is no separate update credential.

Time sync

A Raspberry Pi has no battery-backed clock, so on startup – and whenever its network address changes – a station with internet access sets its clock over NTP from the time server run by the Physikalisch-Technische Bundesanstalt (PTB), the national metrology institute of the Federal Republic of Germany. It runs in the background alongside the automatic update check and fails silently on a show LAN with no uplink, so it never blocks startup or the render path.

Multicast on managed switches

PSN and OTP are multicast, and OSC input is too when a Multicast group is set (default 239.20.20.20). Managed switches need IGMP snooping enabled with a querier on the relevant VLAN.

If a console doesn't see PSN despite OpenFollow sending, run tcpdump -ni any host 236.10.10.10 on a Linux box on the same VLAN. Visible there but not at the console = switch fabric dropping multicast.

Wired vs Wi-Fi

Use wired Ethernet for production.

VLANs and routing

If your venue runs separate VLANs for control vs production traffic, OpenFollow should typically live on the show-control or lighting VLAN with the consoles. Crossing VLANs:

  • OSC unicast routes between VLANs trivially if the router permits it.
  • Multicast (PSN, OTP, and OSC input when a multicast group is set) needs PIM or another multicast routing protocol on the router. Most production networks don’t bother – keep OpenFollow and PSN consumers on the same VLAN.

Ports used by OpenFollow

ServicePortProtocolDirection
Web UI (primary)80TCPInbound
Web UI (alternative)8080 or 2010TCPInbound
PSN data56565UDP multicastOutbound
OTP5568UDP multicastOutbound
RTTrPM36700UDP unicastOutbound
OSC input8765UDPInbound
OSC outputsper transmitterUDP/TCPOutbound
Peer discovery50505 on 239.255.50.50UDP multicastBidirectional
Marker catalog sync50506 on 239.255.50.50UDP multicastBidirectional

OpenFollow binds the configured web port (default 80) and at most one alternative (8080 or 2010, whichever is free). Behind a host firewall, allow inbound on whichever Web UI port the diagnostics surface reports as Serving on, plus the OSC input port.