Getting started
This path establishes a working RelayTV endpoint before adding optional media servers or companion apps.
1. Confirm the model fits
Section titled “1. Confirm the model fits”RelayTV is not installed inside a smart TV or streaming stick. It runs on a Linux host connected directly to the television and renders playback through that host.
Review requirements before choosing hardware.
2. Install on the display host
Section titled “2. Install on the display host”mkdir -p ~/relaytvcd ~/relaytvcurl -fsSL https://relaytv.app/install.sh | bashThe installer explains its choices and asks before installing Docker when it is missing. See Install RelayTV before running it if you want to review the script, force a runtime, or use an existing source checkout.
3. Open the local Web UI
Section titled “3. Open the local Web UI”From a phone or computer on the same network, open:
http://YOUR_RELAYTV_HOST:8787/uiThe host may be an IP address or a local DNS name.
4. Verify a first playback
Section titled “4. Verify a first playback”Paste a supported media URL into the Web UI and choose Play now. Confirm:
- the media starts on the attached display
- the Web UI shows current playback state
- play, pause, and seek control the endpoint
- queueing a second item does not interrupt the current item
If the Web UI works but the display does not, start with display troubleshooting.
5. Secure and integrate
Section titled “5. Secure and integrate”- Read the security and network model.
- Add Android, Home Assistant, or a media service.
- Learn the update path.
Canonical server source: installation guide. Reviewed 2026-08-29.
