Service: Restreamer - EyevinnOSC/community GitHub Wiki

Restreamer

Restreamer (serviceId datarhei-restreamer, catalog page) by datarhei is a free, open source, self-hosted live streaming solution that ingests a video source and pushes it to multiple platforms at once. It is a long-running service instance with up to 10 GiB of storage per instance. License: Apache-2.0.

What it can do

  • Ingest a stream over RTMP, RTMPS or SRT, or pull from an HLS, RTMP or file URL.
  • Push the stream simultaneously to YouTube Live, Twitch, Facebook Live and any custom RTMP destination.
  • Be configured through a built-in web interface.

Creating an instance

Call create-service-instance with serviceId: "datarhei-restreamer". The only option is the instance name; use letters, numbers and underscores, at most 20 characters. There are no dependencies.

{ "name": "mystream" }

Verify with wait-for-service-ready or get-instance-status, then describe-service-instance for the URL and ingest endpoints. Open the URL: on first launch Restreamer asks you to create an admin username and password, which become the permanent login.

Options

Option Required Type Meaning
name Yes string Name of the instance. Letters, numbers and underscores, at most 20 characters.

Using the instance

Source. In the web UI choose Add Source: RTMP (push from OBS, ffmpeg or another encoder to the RTMP ingest URL shown in the UI), URL (pull from an HLS, RTMP or file URL), or a webcam/capture device when running locally with hardware access.

Destinations. Choose Add Destination, pick a platform or enter a custom RTMP URL, and enter the platform's stream key:

Platform RTMP URL
YouTube Live rtmp://a.rtmp.youtube.com/live2
Twitch rtmp://live.twitch.tv/live
Facebook Live rtmps://live-api-s.facebook.com:443/rtmp
Custom Any rtmp:// endpoint

RTMP ingest. Port 1935 (TCP); the RTMP server is disabled by default and must be enabled in Restreamer's System Settings. Push to rtmp://<instance-host>:1935/<app>/<stream-name>, where <app> is the application name you configure (for example live). An optional ?token=<your-token> can be appended. RTMPS is on port 1936 (TCP).

ffmpeg -re -i input.mp4 \
  -c:v libx264 -preset veryfast -b:v 3000k \
  -c:a aac -b:a 128k \
  -f flv rtmp://<instance-host>:1935/live/mystream

SRT ingest. Port 6000 (UDP), configured in System Settings; the server accepts listener-mode streams and an optional passphrase. OSC exposes UDP 6000 automatically. Push URL: srt://<instance-host>:6000; for a token append ?streamid=<value> as configured in Restreamer's SRT settings (datarhei SRT documentation).

SRT-to-RTMP bridge from an SRT Stream Generator or other SRT source, without re-encoding:

ffmpeg \
  -i "srt://<srt-source-host>:9000?mode=caller" \
  -c:v copy -c:a copy \
  -f flv "rtmp://<restreamer-host>:1935/live/mystream"
Port Protocol Purpose
8080 TCP Web UI (HTTP)
8181 TCP Web UI (HTTPS)
1935 TCP RTMP ingest (enable in settings)
1936 TCP RTMPS ingest (enable in settings)
6000 UDP SRT ingest

Example with the OSC CLI:

osc create datarhei-restreamer mystream -o name="mystream"

Limitations

  • Storage is limited to 10 GiB per instance.
  • RTMP/RTMPS and SRT servers must be enabled in System Settings before ingest works (RTMP is disabled by default).

Resources

⚠️ **GitHub.com Fallback** ⚠️