Quickstart

Get ReplayVOD running locally and record your first Twitch stream. This guide uses Docker Compose and SQLite. For other setup options, see the installation guide.

Prerequisites

You’ll need Docker with Compose installed. On Windows, use Docker Desktop.

1. Register a Twitch app

Create an application in the Twitch developer console. Set its OAuth redirect URL to:

http://localhost:8080/api/v1/auth/twitch/callback

You’ll need the Client ID and Client Secret during installation.

If you’re using a domain, replace http://localhost:8080 with your site’s URL, keeping /api/v1/auth/twitch/callback at the end. For example, use https://replayvod.example/api/v1/auth/twitch/callback as the redirect URL and set PUBLIC_BASE_URL=https://replayvod.example during installation.

2. Install

macOS / Linux

curl -fsSL https://replayvod.com/install.sh | sh

Follow the prompts and enter your Twitch app credentials. For this setup, keep the SQLite profile and http://localhost:8080 URL. The installer creates the configuration files, generates a session secret, and offers to start ReplayVOD.

Windows

In PowerShell, clone the repository and open the environment file:

git clone https://github.com/befabri/replayvod.git
Set-Location replayvod
Copy-Item server/.env.example server/.env
notepad server/.env

Set TWITCH_CLIENT_ID and TWITCH_SECRET to your app credentials. Generate a random session secret in PowerShell:

$sessionBytes = New-Object byte[] 32
$sessionRng = [System.Security.Cryptography.RandomNumberGenerator]::Create()
$sessionRng.GetBytes($sessionBytes)
$sessionRng.Dispose()
[BitConverter]::ToString($sessionBytes).Replace("-", "").ToLowerInvariant()

Copy the result into SESSION_SECRET, save the file, then start ReplayVOD:

docker compose --env-file server/.env --profile sqlite up -d

3. Sign in

Open http://localhost:8080 and sign in with Twitch. The first successful sign-in becomes the owner unless you’ve set OWNER_TWITCH_ID to a specific account.

For automatic recording, open System → EventSub and choose polling for a local setup. Restart the server if the dashboard asks you to. Polling checks Twitch for live streams without needing a public callback URL.

You can also use direct EventSub or the Connect relay to receive live notifications from Twitch.

4. Record your first stream

Choose whether to record a channel that’s live now, save a past broadcast, or record future streams automatically.

Record a live stream now

1. Open Library → Channels and select the channel.
2. Select Download, then Download now.
3. Choose video or audio and an available quality, then select Start download.

The channel must be live. This records the current stream without creating a schedule.

If you can’t find a channel, follow it on Twitch, then sign out of ReplayVOD and sign back in. ReplayVOD imports your followed channels when you sign in. This also applies to the channel picker when creating a schedule.

Save a past broadcast

Open Recordings → Archive and paste a Twitch VOD link under Paste links, then add it to the queue. You can also use Browse a channel to look up a channel by name or link and select its available videos. You don’t need to follow the channel on Twitch.

See Archive VODs for recording settings and queue controls.

Record a channel automatically

1. Open Recordings → Schedules and select New schedule.
2. Choose the channel and recording quality. Leave the optional filters empty to record every stream from that channel.
3. Select Create.

ReplayVOD records matching streams while the server is running and live detection is enabled. See Schedules & title tracking for filters and other options.

Viewers can request a channel; admins and owners create schedules.

Live recordings appear in Recordings → Downloads; archive downloads appear in Recordings → Archive. Watch saved recordings in Library → Videos.

Next steps

• Watching recordings: browse the library and resume playback.
• Users & invitations: give other people access.
• Configuration: change server settings.
• Troubleshooting: diagnose setup and recording problems.