Download IRL Relay

Free to use, with an optional Pro licence for more inputs, destinations and quality. It runs on your own server with Docker (Unraid, a NAS, a Linux box, or Docker Desktop on Windows and Mac).

Install it

1. Unzip it on the computer that will run it. You get a folder called irl-relay holding a Dockerfile and an app folder. On Unraid, put it in /mnt/user/appdata/irl-relay.
2. Build it. Open a terminal in that folder (on Unraid, the >_ icon at the top right) and run this. The first time takes a few minutes, and the dot at the end matters.

   docker build -t irl-relay .

   Copy
3. Start it. Paste this as one line, after changing the password and the address (your home IP or a name like yourname.duckdns.org).

   docker run -d --name irl-relay --restart unless-stopped -p 8780:8780 -p 1935:1935 -p 8890:8890/udp -p 8889:8889 -p 8189:8189/udp -v /mnt/user/appdata/irl-relay-data:/data -e CONTROL_PASSWORD=choose-a-password -e PUBLIC_HOST=yourname.duckdns.org irl-relay

   Copy
   On Windows or Mac, replace /mnt/user/appdata/irl-relay-data with any folder you want to keep your settings in.
4. Open the control page at http://YOUR-SERVER:8780 and log in with the password you chose. The Help page inside the app walks you through the rest: adding your phone, adding Twitch or YouTube, and going live.

Got a Pro key?

In IRL Relay open Settings → Plan and licence, paste the key and press Activate. Without a key you keep the Free plan. Want to try Pro first? Request a free 7-day trial key.

Want OBS inside it?

Optional, and needs a stronger computer (about 4 cores). Build with this line instead of the one in step 2, and add -p 6080:6080 to the start line if you want the remote desktop. The Help page explains it.

docker build --build-arg WITH_OBS=1 -t irl-relay .

Use a graphics card? (optional)

By default IRL Relay encodes the video on the processor, which works everywhere. If your server has a graphics card, it can do that instead and leave the processor free. Switch it on later in Settings → Quality → Encoder, then press Test. If the card isn't set up properly, IRL Relay carries on with the processor and tells you why, so nothing breaks. The container just has to be given the card when you start it. Open the setup that matches yours:

docker run -d --name irl-relay --restart unless-stopped -p 8780:8780 -p 1935:1935 -p 8890:8890/udp -p 8889:8889 -p 8189:8189/udp -v /mnt/user/appdata/irl-relay-data:/data -e CONTROL_PASSWORD=choose-a-password -e PUBLIC_HOST=yourname.duckdns.org --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=GPU-your-uuid-here -e NVIDIA_DRIVER_CAPABILITIES=all irl-relay

curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg && curl -s -L https://nvidia.github.io/libnvidia-container/stable/deb/nvidia-container-toolkit.list | sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' | sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list && sudo apt-get update && sudo apt-get install -y nvidia-container-toolkit

sudo nvidia-ctk runtime configure --runtime=docker && sudo systemctl restart docker

docker run -d --name irl-relay --restart unless-stopped -p 8780:8780 -p 1935:1935 -p 8890:8890/udp -p 8889:8889 -p 8189:8189/udp -v /mnt/user/appdata/irl-relay-data:/data -e CONTROL_PASSWORD=choose-a-password -e PUBLIC_HOST=yourname.duckdns.org --gpus all irl-relay

curl -s -L https://nvidia.github.io/libnvidia-container/stable/rpm/nvidia-container-toolkit.repo | sudo tee /etc/yum.repos.d/nvidia-container-toolkit.repo && sudo dnf install -y nvidia-container-toolkit

sudo nvidia-ctk runtime configure --runtime=docker && sudo systemctl restart docker

docker run -d --name irl-relay --restart unless-stopped -p 8780:8780 -p 1935:1935 -p 8890:8890/udp -p 8889:8889 -p 8189:8189/udp -v /mnt/user/appdata/irl-relay-data:/data -e CONTROL_PASSWORD=choose-a-password -e PUBLIC_HOST=yourname.duckdns.org --gpus all irl-relay

docker run -d --name irl-relay --restart unless-stopped -p 8780:8780 -p 1935:1935 -p 8890:8890/udp -p 8889:8889 -p 8189:8189/udp -v /mnt/user/appdata/irl-relay-data:/data -e CONTROL_PASSWORD=choose-a-password -e PUBLIC_HOST=yourname.duckdns.org --gpus all irl-relay

docker build --build-arg WITH_GPU=1 -t irl-relay .

docker run -d --name irl-relay --restart unless-stopped -p 8780:8780 -p 1935:1935 -p 8890:8890/udp -p 8889:8889 -p 8189:8189/udp -v /mnt/user/appdata/irl-relay-data:/data -e CONTROL_PASSWORD=choose-a-password -e PUBLIC_HOST=yourname.duckdns.org --device /dev/dri irl-relay

    deploy:
      resources:
        reservations:
          devices:
            - driver: nvidia
              count: all
              capabilities: [gpu, video, compute, utility]

The built-in Help page has the same steps with more detail. This is a new feature: if your card won't start, the message under Encoder says what is missing.

Updating later

Download the new zip, replace the app folder with the new one, run the docker build line again, then docker rm -f irl-relay and run the start line again. Your settings, licence and clips are kept in the data folder, so nothing is lost. The control page shows a banner when a newer version is out.

All versions

Every release, newest first, with what changed. Download an older one if a newer version doesn't suit you. Your settings are kept in the data folder, so you can move between versions.