Skip to content

1. Requirements

Check each item on the relay host before following the Quick Start.

1.1 Operating System

Linux is the only supported operating system. The relay may run on macOS or Windows, but that is not tested.

1.2 Software

Requirement Check Expected
Docker Engine (install) docker --version Prints a version
Docker Compose v2 plugin (install) docker compose version Prints a version. start.sh uses docker compose; the older standalone docker-compose command does not work with it.
Docker without sudo (steps) docker ps Prints a table, not permission denied
git git --version Prints a version

1.3 Network

Requirement Why Check
Inbound TCP port 1935 on the relay host, from the streaming PC OBS sends its stream to the relay on this port After the relay starts, from the streaming PC: nc -zv <RELAY_IP> 1935 (Linux, macOS) or Test-NetConnection <RELAY_IP> -Port 1935 (Windows PowerShell) succeeds
Outbound TCP port 1935 from the relay host The relay forwards the stream to Twitch and YouTube over the Real-Time Messaging Protocol (RTMP) nc -zv use10.contribute.live-video.net 1935 and nc -zv a.rtmp.youtube.com 1935 each print a line containing succeeded or open
Outbound HTTPS from the relay host Building the image downloads the base image and packages docker compose build --pull completes
Streaming PC address inside PUBLISH_IP_RANGE The relay refuses streams from any other address. The default allows 172.16.0.0/12 and 192.168.0.0/16. See OBS Is Refused

<RELAY_IP> is the relay host's LAN address. If a proxy server sits between the relay host and the internet, it must allow both outbound HTTPS and outbound RTMP.

1.4 Bandwidth and Hardware

The relay host's upload must carry every service at once. See Bandwidth Requirements and CPU Considerations.

1.5 See Also