Skip to content
/ srtrelay Public

SRT relay server for distributing media streams to multiple clients.

License

Notifications You must be signed in to change notification settings

voc/srtrelay

Folders and files

NameName
Last commit message
Last commit date
Jan 9, 2025
Dec 26, 2024
Dec 26, 2024
Dec 24, 2024
Dec 20, 2021
Aug 8, 2021
Nov 6, 2023
Dec 25, 2024
Dec 24, 2024
Dec 10, 2022
Dec 25, 2024
Jun 11, 2024
Dec 26, 2024
Dec 26, 2024
Dec 26, 2024
Dec 24, 2024
Dec 24, 2024
Oct 31, 2020
Dec 24, 2024
Apr 11, 2022
Nov 17, 2023
Jan 9, 2025
Jan 9, 2025
Dec 24, 2024

Repository files navigation

srtrelay CI

Streaming-Relay for the SRT-protocol

Use at your own risk.

Quick start

Run with docker (Note: nightly image not recommended for production)

docker run ghcr.io/voc/srtrelay/srtrelay:latest

# start publisher
ffmpeg -i test.mp4 -c copy -f mpegts srt://localhost:1337?streamid=publish/test

# start subscriber
ffplay -fflags nobuffer srt://localhost:1337?streamid=play/test

Start docker with custom config. See config.toml.example

# provide your own config from the local directory
docker run -v $(pwd)/config.toml:/home/srtrelay/config.toml ghcr.io/voc/srtrelay/srtrelay:latest

Run with docker-compose

In your docker-compose.yml:

   srtrelay:
     image: ghcr.io/voc/srtrelay/srtrelay:latest
     restart: always
     container_name: srtrelay
     volumes:
       - ./srtrelay-config.toml:/home/srtrelay/config.toml
     ports:
       - "44560:1337/udp"

This will forward port 44560 to internal port 1337 in the container. Importantly, forwarding UDP is required. It will also copy a srtrelay-config.toml file in the same directory into the container to use as config.toml

Start the server with the usual

docker-compose up -d

Build with docker

You will need atleast docker-20.10

docker build -t srtrelay .

# run srtrelay
docker run --rm -it srtrelay

Build without docker

Install Dependencies

Requires >=libsrt-1.4.2, golang and a C compiler

Ubuntu

Debian 10:

Gentoo:

  • emerge net-libs/srt

Build

go build -o srtrelay

# run srtrelay
./srtrelay

Usage

Commandline Flags

# List available flags
./srtrelay -h

Configuration

Please take a look at config.toml.example to learn more about configuring srtrelay.

The configuration file can be placed under config.toml in the current working directory, at /etc/srtrelay/config.toml or at a custom location specified via the -config flag.

API

See docs/API.md for more information about the API.

Contributing

See docs/Contributing.md

Credits

Thanks go to