1. Install and start

Load the Docker container and start with the default user credentials. The default ports for HTTP are 80 and for HTTPS 443.

docker run -d --restart=always --rm --name restreamer \
-v /opt/restreamer/config:/core/config \
-v /opt/restreamer/data:/core/data \
-p 8080:8080 -p 8181:8181 \
-p 1935:1935 -p 1936:1936 \
-p 6000:6000/udp \
datarhei/restreamer:latest

2. Add video source

The wizard helps to activate a video source.

Audio

Optionally, the use of sound is possible via the configurator.

4. Integrate video player on the website

Becoming a live streaming superhero with the Restreamer is a pretty simple process:

5. Optional: Customize video player

The video player is ready to use. It is straightforward to customize the color, logo, and link.

6. Optional: Customize video page

The video page is active immediately and is provided via localhost.

7. Optional: Select publication service

Many great things are possible once the datarhei Restreamer is "on-air". Why not start a publication service with a live broadcast on YouTube?

Learn more

Requirements

• Raspberry Pi 3 or Pi 4

• ARM CPU with arm32v7 or arm64v8 architecture.

Verified Raspberry Pi models

• Raspberry Pi 3 Mod. A+

• Raspberry Pi 3 Model B+

• Raspberry Pi 4 Mod. B

Preparation

Step 1: Install Docker

If you are already using Docker, skip this step.

Installation

Step 2: Start the Restreamer

Start with hardware support for arm32v7

docker run --detach --rm --name core --privileged --volume /opt/core/config:/core/config --volume /opt/core/data:/core/data --publish 8080:8080 --publish 8181:8181 --publish 1935:1935 --publish 1936:1936 --publish 6000:6000/udp datarhei/restreamer:rpi-latest

Start without hardware support for arm32v7 and arm64v8

docker run --detach --rm --name core --privileged --volume /opt/core/config:/core/config --volume /opt/core/data:/core/data --publish 8080:8080 --publish 8181:8181 --publish 1935:1935 --publish 1936:1936 --publish 6000:6000/udp datarhei/restreamer:latest

Step 3: Open the Restreamer

Open a browser and enter the device's IP address with the Restreamer installed. In the example: http://device-ip:8080/ui

Raspberry Pi Camera

Important: The Environments

Environments are global settings for the Restreamer. We recommend considering some environments at the startup.

Description of the most important commands for the use of environments

-d Deletes the container. This means that the container is executed in the background. You can run it interactively in the foreground with -it instead of -d. To stop the restreamer in detached mode, type docker stop restreamer. In interactive mode, simply press Ctrl-C to stop the restreamer.

--name restreamer Set the container the name restreamer. This name can be used in other Docker commands to control the container. For example, to stop the Restreamer, type docker stop restreamer. While the Restreamer is running, you can log into the container with docker exec -it restreamer /bin/bash.

--restart=always If the Restreamer crashes or the device reboots, Docker restarts the Restreamer automatically.

--publish 8080:8080 Binds the computer's port 8080 to the Restreamer's port 8080. It allows you to connect to the Restreamer GUI over HTTP with your browser. If you want to use a different port, change it to -p 31000:8080, for example.

--publish 8081:8181 Binds the computer's port 8181 to the Restreamer's port 8181. It allows you to connect to the Restreamer GUI over HTTPS with your browser. If you want to use a different port, change it to -p 31000:8181, for example.

--publish 1935:1935 Binds port 1935 of the computer to port 1935 of the Restreamer. It allows you to receive streams from the RTMP server or send streams to the RTMP server. If you want to use a different port, change it to -p 31000:1935, for example.

--publish 1936:1936 Binds port 1936 of the computer to port 1936 of the Restreamer. It allows you to receive streams from the RTMPS server or send streams to the RTMPS server. If you want to use a different port, change it to -p 31000:1936, for example.

--publish 6000/udp Binds port 6000/udp of the restreamer. It allows you to receive streams from the SRT server or send streams to the SRT server. If you want to use a different port, change it to -p 31000:6000/udp, for example.

--volume ${HOME}/restreamer/config:/core/config The Restreamer stores the current state in the /core/config directory inside the container. This command maps the ${HOME}/restreamer/config directory of your computer into the container. This can be used to preserve the state if the restreamer needs to be restarted. If you want to store the state in a different directory on your device, change it to, e.g. -v /tmp/restreamer/config:/core/config

--volume ${HOME}/restreamer/data:/core/data The Restreamer stores the internal file system persistently in this directory.

datarhei/restreamer:latest It is the Docker image of the latest datarhei Restreamer on Docker Hub. Docker checks if the image is available locally and downloads it if it is not or if a newer image is available.

List with all available environment variables

Learn more

Introduction

To obtain official support from our team, we have a minimum set of requirements. These requirements are necessary for us to access essential system information, provide an SLA, answer questions, or give a solution to the problem.

Only installations matching these minimum requirements can be covered by our SLAs and our paid Support Policy; some conditions may vary depending on the installation size, as described below.

Docker container

We strongly recommend using our official Docker images to eliminate environment issues of missing, outdated, or mismatching dependencies, specific operating system issues, or issues during manual installations.

Learn more

The Main screen

After successful login, the main screen is a central point in the system and the starting point for all other settings.

Learn more

Restreamer via Docker

Docker Engine is free and available on various Linux platforms, macOS, and Windows via Docker Desktop and as a static binary installation.

Restreamer via Podman

Podman is a free and recommended alternative for Docker.

Web Browsers

Unsupported browsers and operating systems

To provide the best possible Restreamer experience, we keep our list of supported browsers and operating systems short. We do not fix bugs or issues with unsupported browsers.

Learn more

Requirements

• 64Bit Intel or AMD CPU

• A current Linux distribution such as Ubuntu, Debian, Fedora, RedHat, or Suse Linux.

Preparation

Step 1: Install Docker

Installation

Step 2: Start the Restreamer

Without hardware support

docker run --detach --rm --name core --privileged --volume /opt/core/config:/core/config --volume /opt/core/data:/core/data --publish 8080:8080 --publish 8181:8181 --publish 1935:1935 --publish 1936:1936 --publish 6000:6000/udp datarhei/restreamer:latest

Start with hardware support for Nvidia CUDA

docker run --detach --runtime=nvidia --rm --name core --privileged --volume /opt/core/config:/core/config --volume /opt/core/data:/core/data --publish 8080:8080 --publish 8181:8181 --publish 1935:1935 --publish 1936:1936 --publish 6000:6000/udp datarhei/restreamer:cuda-latest

Start with hardware support for Intel VAAPI

docker run --detach --rm --name core --privileged --volume /opt/core/config:/core/config --volume /opt/core/data:/core/data --publish 8080:8080 --publish 8181:8181 --publish 1935:1935 --publish 1936:1936 --publish 6000:6000/udp datarhei/restreamer:vaapi-latest

Step 3: Open the Restreamer

Open a browser and enter the device's IP address with the Restreamer installed. In the example: http://device-ip:8080/ui

Important: The Environments

Environments are global settings for the Restreamer. We recommend considering some environments at the startup.

Description of the most important commands for the use of environments

-d Deletes the container. This means that the container is executed in the background. You can run it interactively in the foreground with -it instead of -d. To stop the restreamer in detached mode, type docker stop restreamer. In interactive mode, simply press Ctrl-C to stop the restreamer.

--name restreamer Set the container the name restreamer. This name can be used in other Docker commands to control the container. For example, to stop the Restreamer, type docker stop restreamer. While the Restreamer is running, you can log into the container with docker exec -it restreamer /bin/bash.

--restart=always If the Restreamer crashes or the device reboots, Docker restarts the Restreamer automatically.

--publish 8080:8080 Binds the computer's port 8080 to the Restreamer's port 8080. It allows you to connect to the Restreamer GUI over HTTP with your browser. If you want to use a different port, change it to -p 31000:8080, for example.

--publish 8081:8181 Binds the computer's port 8181 to the Restreamer's port 8181. It allows you to connect to the Restreamer GUI over HTTPS with your browser. If you want to use a different port, change it to -p 31000:8181, for example.

--publish 1935:1935 Binds port 1935 of the computer to port 1935 of the Restreamer. It allows you to receive streams from the RTMP server or send streams to the RTMP server. If you want to use a different port, change it to -p 31000:1935, for example.

--publish 1936:1936 Binds port 1936 of the computer to port 1936 of the Restreamer. It allows you to receive streams from the RTMPS server or send streams to the RTMPS server. If you want to use a different port, change it to -p 31000:1936, for example.

--publish 6000/udp Binds port 6000/udp of the restreamer. It allows you to receive streams from the SRT server or send streams to the SRT server. If you want to use a different port, change it to -p 31000:6000/udp, for example.

--volume ${HOME}/restreamer/config:/core/config The Restreamer stores the current state in the /core/config directory inside the container. This command maps the ${HOME}/restreamer/config directory of your computer into the container. This can be used to preserve the state if the restreamer needs to be restarted. If you want to store the state in a different directory on your device, change it to, e.g. -v /tmp/restreamer/config:/core/config

--volume ${HOME}/restreamer/data:/core/data The Restreamer stores the internal file system persistently in this directory.

datarhei/restreamer:latest It is the Docker image of the latest datarhei Restreamer on Docker Hub. Docker checks if the image is available locally and downloads it if it is not or if a newer image is available.

List with all available environment variables

Learn more

Preparation

Step 1: Install Docker Desktop

Step 2: Pull the container with the Restreamer

docker pull datarhei/restreamer:latest

Step 3: Run Restreamer Container

Start Docker Desktop and go to Images. The Restreamer is in the list. A click on RUN takes you to the next step.

Step 4: Configurate your Restreamer container and start

The next step is to set the container's name, the ports for access in the browser, and the video data. Finally, place the volume settings so that the login data and the restreamer are permanently saved! Otherwise, the settings and login data will be gone with the next update. Click Run to start the Restreamer for the first time.

• Name A logical name helps to find the container again.

• Ports Transfer the numbers from the Container Ports field to the empty areas on the left.

• Volumes Choose a folder on the windows machine where you want to store the settings and configuration of the restreamer permanently. The Destination path is /core/config and /core/data.

Step 5: Open Browser to login

Click on the 8080:8080 opens the default browser with the Restreamer front door. You can otherwise also open a browser and enter the device's IP address with the Restreamer installed. In the example: http://device-ip:8080/ui

Step 8. First login

When you log in for the first time in your Restreamer, you have to enter your credentials.

Additional information: The Environments

Environments are global settings for the Restreamer. We recommend considering some environments at the startup. They are admittedly not so essential for Docker Desktop, but it does not hurt if you know them!

Description of the most important commands for the use of environments

-p 8080:8080 Binds the computer's port 8080 to the Restreamer's port 8080. It allows you to connect to the Restreamer GUI over HTTP with your browser. If you want to use a different port, change it to -p 31000:8080, for example.

-p 8081:8181 Binds the computer's port 8181 to the Restreamer's port 8181. It allows you to connect to the Restreamer GUI over HTTPS with your browser. If you want to use a different port, change it to -p 31000:8181, for example.

-p 1935:1935 Binds port 1935 of the computer to port 1935 of the Restreamer. It allows you to receive streams from the RTMP server or send streams to the RTMP server. If you want to use a different port, change it to -p 31000:1935, for example.

-p 1936:1936 Binds port 1936 of the computer to port 1936 of the Restreamer. It allows you to receive streams from the RTMPS server or send streams to the RTMPS server. If you want to use a different port, change it to -p 31000:1936, for example.

-p 6000/udp Binds port 6000/udp of the restreamer. It allows you to receive streams from the SRT server or send streams to the SRT server. If you want to use a different port, change it to -p 31000:6000/udp, for example.

-v ${HOME}/restreamer/config:/core/config The Restreamer stores the current state in the /core/config directory inside the container. This command maps the ${HOME}/restreamer/config directory of your computer into the container. This can be used to preserve the state if the restreamer needs to be restarted. If you want to store the state in a different directory on your device, change it to, e.g. -v /tmp/restreamer/config:/core/config

-v ${HOME}/restreamer/data:/core/data The restreamer stores the internal file system persistently in this directory.

datarhei/restreamer:latest It is the Docker image of the latest datarhei Restreamer on Docker Hub. Docker checks if the image is available locally and downloads it if it is not or if a newer image is available.

List with all available environment variables

Learn more

Preparation

Step 1: Install Docker Desktop

Step 2: Pull the container with the Restreamer

docker pull datarhei/restreamer:latest

Step 3: Run Restreamer Container

Start Docker Desktop and go to Images. The Restreamer is in the list. A click on RUN takes you to the next step.

Step 4: Configurate your Restreamer container and start

The next step is to set the container's name, the ports for access in the browser, and the video data. Finally, place the volume settings so that the login data and the restreamer are permanently saved! Otherwise, the settings and login data will be gone with the next update. Click Run to start the Restreamer for the first time.

• Name A logical name helps to find the container again.

• Ports Transfer the numbers from the Container Ports field to the empty areas on the left.

• Volumes Choose a folder on the windows machine where you want to store the settings and configuration of the restreamer permanently. The Destination path is /core/config and /core/data.

Step 5: Open Browser to login

Click on the 8080:8080 opens the default browser with the Restreamer front door. You can otherwise also open a browser and enter the device's IP address with the Restreamer installed. In the example: http://device-ip:8080/ui

Step 8. First login

When you log in for the first time in your Restreamer, you have to enter your credentials.

Additional information: The Environments

Environments are global settings for the Restreamer. We recommend considering some environments at the startup. They are admittedly not so essential for Docker Desktop, but it does not hurt if you know them!

Description of the most important commands for the use of environments

-p 8080:8080 Binds the computer's port 8080 to the Restreamer's port 8080. It allows you to connect to the Restreamer GUI over HTTP with your browser. If you want to use a different port, change it to -p 31000:8080, for example.

-p 8081:8181 Binds the computer's port 8181 to the Restreamer's port 8181. It allows you to connect to the Restreamer GUI over HTTPS with your browser. If you want to use a different port, change it to -p 31000:8181, for example.

-p 1935:1935 Binds port 1935 of the computer to port 1935 of the Restreamer. It allows you to receive streams from the RTMP server or send streams to the RTMP server. If you want to use a different port, change it to -p 31000:1935, for example.

-p 1936:1936 Binds port 1936 of the computer to port 1936 of the Restreamer. It allows you to receive streams from the RTMPS server or send streams to the RTMPS server. If you want to use a different port, change it to -p 31000:1936, for example.

-p 6000/udp Binds port 6000/udp of the restreamer. It allows you to receive streams from the SRT server or send streams to the SRT server. If you want to use a different port, change it to -p 31000:6000/udp, for example.

-v ${HOME}/restreamer/config:/core/config The Restreamer stores the current state in the /core/config directory inside the container. This command maps the ${HOME}/restreamer/config directory of your computer into the container. This can be used to preserve the state if the restreamer needs to be restarted. If you want to store the state in a different directory on your device, change it to, e.g. -v /tmp/restreamer/config:/core/config

-v ${HOME}/restreamer/data:/core/data The restreamer stores the internal file system persistently in this directory.

datarhei/restreamer:latest It is the Docker image of the latest datarhei Restreamer on Docker Hub. Docker checks if the image is available locally and downloads it if it is not or if a newer image is available.

List with all available environment variables

Learn more

datarhei Restreamer is a modern video streaming platform where teams can live stream and restream everything from webcams to broadcasting. We want to help teams to stream more efficiently by creating a simple yet powerful service for them to live stream video. Our mission is to make a user-friendly and powerful product for everyone to stream video.

What does the datarhei Restreamer offer?

• Live streaming on websites without additional service providers, video hosting providers. Instantly available, free of charge, and without advertising.

• Share live videos publicly or privately with anyone, or use a secret link to give your audience access to private content.

• The fully documented API helps with software development. datarhei Restreamer is very easy to adapt to any project.

Learn more

Preparation

Step 1: Install Docker Desktop

Step 2: WSL 2 installation

Step 3: Docker Desktop settings

Go to the Docker Desktop settings to enable the Linux distro integration.

Start Restreamer container in Docker Desktop

Step 4: Pull the container with the Restreamer

Step 5: Run Restreamer Container

Start Docker Desktop and go to Images. The Restreamer is in the list. A click on RUN takes you to the next step.

Step 6: Configurate your Restreamer container and start

The next step is to set the container's name, the ports for access in the browser, and the video data. Finally, place the volume settings so that the login data and the restreamer are permanently saved! Otherwise, the settings and login data will be gone with the next update. Click Run to start the Restreamer for the first time.

• Name A logical name helps to find the container again.

• Ports Transfer the numbers from the Container Ports field to the empty areas on the left.

• Volumes Choose a folder on the windows machine where you want to store the settings and configuration of the restreamer permanently. The Destination path is /core/config and /core/data.

Step 7: Open Browser to login

Click on the 8080:8080 opens the default browser with the Restreamer front door. You can otherwise also open a browser and enter the device's IP address with the Restreamer installed. In the example: http://device-ip:8080/ui

Step 8. First login

When you log in for the first time in your Restreamer, you have to enter your credentials.

Additional information: The Environments

Environments are global settings for the Restreamer. We recommend considering some environments at the startup. They are admittedly not so essential for Docker Desktop, but it does not hurt if you know them!

Description of the most important commands for the use of environments

-p 8080:8080 Binds the computer's port 8080 to the Restreamer's port 8080. It allows you to connect to the Restreamer GUI over HTTP with your browser. If you want to use a different port, change it to -p 31000:8080, for example.

-p 8081:8181 Binds the computer's port 8181 to the Restreamer's port 8181. It allows you to connect to the Restreamer GUI over HTTPS with your browser. If you want to use a different port, change it to -p 31000:8181, for example.

-p 1935:1935 Binds port 1935 of the computer to port 1935 of the Restreamer. It allows you to receive streams from the RTMP server or send streams to the RTMP server. If you want to use a different port, change it to -p 31000:1935, for example.

-p 1936:1936 Binds port 1936 of the computer to port 1936 of the Restreamer. It allows you to receive streams from the RTMPS server or send streams to the RTMPS server. If you want to use a different port, change it to -p 31000:1936, for example.

-p 6000/udp Binds port 6000/udp of the restreamer. It allows you to receive streams from the SRT server or send streams to the SRT server. If you want to use a different port, change it to -p 31000:6000/udp, for example.

-v ${HOME}/restreamer/config:/core/config The Restreamer stores the current state in the /core/config directory inside the container. This command maps the ${HOME}/restreamer/config directory of your computer into the container. This can be used to preserve the state if the restreamer needs to be restarted. If you want to store the state in a different directory on your device, change it to, e.g. -v /tmp/restreamer/config:/core/config

-v ${HOME}/restreamer/data:/core/data The restreamer stores the internal file system persistently in this directory.

datarhei/restreamer:latest It is the Docker image of the latest datarhei Restreamer on Docker Hub. Docker checks if the image is available locally and downloads it if it is not or if a newer image is available.

List with all available environment variables

Learn more

Requirements

• A current Linux distribution such as Ubuntu, Debian, Fedora, RedHat, or Suse Linux.

Preparation

Step 1: Install Docker

Installation

Step 2: Start the Restreamer

Without hardware support

Start with hardware support for Nvidia CUDA

Start with hardware support for Intel VAAPI

Step 3: Open the Restreamer

Open a browser and enter the device's IP address with the Restreamer installed. In the example: http://device-ip:8080/ui

Step 4. First login

When you log in for the first time in your Restreamer, you have to enter your credentials.

Important: The Environments

Environments are global settings for the Restreamer. We recommend considering some environments at the startup.

Description of the most important commands for the use of environments

-d Deletes the container. This means that the container is executed in the background. You can run it interactively in the foreground with -it instead of -d. To stop the restreamer in detached mode, type docker stop restreamer. In interactive mode, simply press Ctrl-C to stop the restreamer.

--name restreamer Set the container the name restreamer. This name can be used in other Docker commands to control the container. For example, to stop the Restreamer, type docker stop restreamer. While the Restreamer is running, you can log into the container with docker exec -it restreamer /bin/bash.

--restart=always If the Restreamer crashes or the device reboots, Docker restarts the Restreamer automatically.

--publish 8080:8080 Binds the computer's port 8080 to the Restreamer's port 8080. It allows you to connect to the Restreamer GUI over HTTP with your browser. If you want to use a different port, change it to -p 31000:8080, for example.

--publish 8081:8181 Binds the computer's port 8181 to the Restreamer's port 8181. It allows you to connect to the Restreamer GUI over HTTPS with your browser. If you want to use a different port, change it to -p 31000:8181, for example.

--publish 1935:1935 Binds port 1935 of the computer to port 1935 of the Restreamer. It allows you to receive streams from the RTMP server or send streams to the RTMP server. If you want to use a different port, change it to -p 31000:1935, for example.

--publish 1936:1936 Binds port 1936 of the computer to port 1936 of the Restreamer. It allows you to receive streams from the RTMPS server or send streams to the RTMPS server. If you want to use a different port, change it to -p 31000:1936, for example.

--publish 6000/udp Binds port 6000/udp of the restreamer. It allows you to receive streams from the SRT server or send streams to the SRT server. If you want to use a different port, change it to -p 31000:6000/udp, for example.

--volume ${HOME}/restreamer/config:/core/config The Restreamer stores the current state in the /core/config directory inside the container. This command maps the ${HOME}/restreamer/config directory of your computer into the container. This can be used to preserve the state if the restreamer needs to be restarted. If you want to store the state in a different directory on your device, change it to, e.g. -v /tmp/restreamer/config:/core/config

--volume ${HOME}/restreamer/data:/core/data The Restreamer stores the internal file system persistently in this directory.

datarhei/restreamer:latest It is the Docker image of the latest datarhei Restreamer on Docker Hub. Docker checks if the image is available locally and downloads it if it is not or if a newer image is available.

List with all available environment variables

Learn more

Preparation

Step 1: Install Docker Desktop

Step 2: WSL 2 installation

Step 3: Docker Desktop settings

Go to the Docker Desktop settings to enable the Linux distro integration.

Start Restreamer container in Docker Desktop

Step 4: Pull the container with the Restreamer

Step 5: Run Restreamer Container

Start Docker Desktop and go to Images. The Restreamer is in the list. A click on RUN takes you to the next step.

Step 6: Configurate your Restreamer container and start

The next step is to set the container's name, the ports for access in the browser, and the video data. Finally, place the volume settings so that the login data and the restreamer are permanently saved! Otherwise, the settings and login data will be gone with the next update. Click Run to start the Restreamer for the first time.

• Name A logical name helps to find the container again.

• Ports Transfer the numbers from the Container Ports field to the empty areas on the left.

• Volumes Choose a folder on the windows machine where you want to store the settings and configuration of the restreamer permanently. The Destination path is /core/config and /core/data.

Step 7: Open Browser to login

Click on the 8080:8080 opens the default browser with the Restreamer front door. You can otherwise also open a browser and enter the device's IP address with the Restreamer installed. In the example: http://device-ip:8080/ui

Step 8. First login

When you log in for the first time in your Restreamer, you have to enter your credentials.

Additional information: The Environments

Environments are global settings for the Restreamer. We recommend considering some environments at the startup. They are admittedly not so essential for Docker Desktop, but it does not hurt if you know them!

Description of the most important commands for the use of environments

--publish 8080:8080 Binds the computer's port 8080 to the Restreamer's port 8080. It allows you to connect to the Restreamer GUI over HTTP with your browser. If you want to use a different port, change it to -p 31000:8080, for example.

--publish 8081:8181 Binds the computer's port 8181 to the Restreamer's port 8181. It allows you to connect to the Restreamer GUI over HTTPS with your browser. If you want to use a different port, change it to -p 31000:8181, for example.

--publish 1935:1935 Binds port 1935 of the computer to port 1935 of the Restreamer. It allows you to receive streams from the RTMP server or send streams to the RTMP server. If you want to use a different port, change it to -p 31000:1935, for example.

--publish 1936:1936 Binds port 1936 of the computer to port 1936 of the Restreamer. It allows you to receive streams from the RTMPS server or send streams to the RTMPS server. If you want to use a different port, change it to -p 31000:1936, for example.

--publish 6000/udp Binds port 6000/udp of the restreamer. It allows you to receive streams from the SRT server or send streams to the SRT server. If you want to use a different port, change it to -p 31000:6000/udp, for example.

--volume ${HOME}/restreamer/config:/core/config The Restreamer stores the current state in the /core/config directory inside the container. This command maps the ${HOME}/restreamer/config directory of your computer into the container. This can be used to preserve the state if the restreamer needs to be restarted. If you want to store the state in a different directory on your device, change it to, e.g. -v /tmp/restreamer/config:/core/config

--volume ${HOME}/restreamer/data:/core/data The Restreamer stores the internal file system persistently in this directory.

datarhei/restreamer:latest It is the Docker image of the latest datarhei Restreamer on Docker Hub. Docker checks if the image is available locally and downloads it if it is not or if a newer image is available.

List with all available environment variables

Learn more

Requirements

• A current Linux distribution such as Ubuntu, Debian, Fedora, RedHat, or Suse Linux.

Preparation

Step 1: Install Docker

Installation Windows PowerShell

In the PowerShell, a single command is required to download and start the Restreamer.

Step 2: Start the Restreamer

Without hardware support

Start with hardware support for Nvidia CUDA

Start with hardware support for Intel VAAPI

Step 3: Open the Restreamer

Open a browser and enter the device's IP address with the Restreamer installed. In the example: http://device-ip:8080/ui

Step 4. First login

When you log in for the first time in your Restreamer, you have to enter your credentials.

Important: The Environments

Environments are global settings for the Restreamer. We recommend considering some environments at the startup.

Description of the most important commands for the use of environments

-d Deletes the container. This means that the container is executed in the background. You can run it interactively in the foreground with -it instead of -d. To stop the restreamer in detached mode, type docker stop restreamer. In interactive mode, simply press Ctrl-C to stop the restreamer.

--name restreamer Set the container the name restreamer. This name can be used in other Docker commands to control the container. For example, to stop the Restreamer, type docker stop restreamer. While the Restreamer is running, you can log into the container with docker exec -it restreamer /bin/bash.

--restart=always If the Restreamer crashes or the device reboots, Docker restarts the Restreamer automatically.

--publish 8080:8080 Binds the computer's port 8080 to the Restreamer's port 8080. It allows you to connect to the Restreamer GUI over HTTP with your browser. If you want to use a different port, change it to -p 31000:8080, for example.

--publish 8081:8181 Binds the computer's port 8181 to the Restreamer's port 8181. It allows you to connect to the Restreamer GUI over HTTPS with your browser. If you want to use a different port, change it to -p 31000:8181, for example.

--publish 1935:1935 Binds port 1935 of the computer to port 1935 of the Restreamer. It allows you to receive streams from the RTMP server or send streams to the RTMP server. If you want to use a different port, change it to -p 31000:1935, for example.

--publish 1936:1936 Binds port 1936 of the computer to port 1936 of the Restreamer. It allows you to receive streams from the RTMPS server or send streams to the RTMPS server. If you want to use a different port, change it to -p 31000:1936, for example.

--publish 6000/udp Binds port 6000/udp of the restreamer. It allows you to receive streams from the SRT server or send streams to the SRT server. If you want to use a different port, change it to -p 31000:6000/udp, for example.

--volume ${HOME}/restreamer/config:/core/config The Restreamer stores the current state in the /core/config directory inside the container. This command maps the ${HOME}/restreamer/config directory of your computer into the container. This can be used to preserve the state if the restreamer needs to be restarted. If you want to store the state in a different directory on your device, change it to, e.g. -v /tmp/restreamer/config:/core/config

--volume ${HOME}/restreamer/data:/core/data The Restreamer stores the internal file system persistently in this directory.

datarhei/restreamer:latest It is the Docker image of the latest datarhei Restreamer on Docker Hub. Docker checks if the image is available locally and downloads it if it is not or if a newer image is available.

List with all available environment variables

Learn more

Activate the checkmark at Update!

System settings >> System >> ☑️ Check for update

Migration from v0.x to v2.x

From Restreamer version 0.6.8 onwards, the configuration settings will be migrated when updating to version 2.x.

Update v2 to > v2.x

The current version of the datarhei Restreamer is executed via the same command as during the new installation.

Old Version v0.6.8

Learn more

List of Docker services for deploying a Docker image

Alternatively, you can use any cloud/hosting service where you have access to the server. There you install Docker or Podman to run the restreamer.

Learn more

For access, you need the login name and the password, which you have assigned at the 1st login after the installation.

Learn more

General system settings with real-time data

On the main screen, you can see the current video stream. Under the video player, you can find the runtime, the bitrate, and the frame rate. In addition, you find the number of viewers and the current bitrate in real-time for the publications.

The menu items in detail

The navigation points take you to the settings of the various submenus.

1. System menu

   1. datarhei Service

   4. Issue alert

   5. Language

   6. Logout

2. 1. All

   2. Plattform

   3. Software

   4. Protocol

3. 1. Add source

   2. Switch channel

5. 1. Embed

   2. Color

   3. Logo

   4. Statistics

   5. Playback

8. Process details

9. Stop Stream

10. Copy HLS, RTMP, SRT, or Snapshot address

Learn more

v2.4+ to v2.3.x (downgrade)

Restreamer version >= 2.4.0 switches to FFmpeg 5.1.2, which is incompatible with earlier versions.

However, if problems arise due to the update, there is a backup to downgrade to =< 2.3.x.

The required steps:

v0.6.x to v2.x

This guide assumes that your current docker command line looks like

Your actual command line might have more enviroment variables or different paths to the mounted directories.

2. Start Restreamer v0.6.8 and start streaming from the video source.

3. Stop Restreamer v0.6.8 by stopping the Docker container, e.g. docker kill restreamer and then docker rm restreamer.

4. Pull the latest Restreamer image, e.g. docker pull datarhei/restreamer:latest.

5. Adjust the mounted volumes by replacing -v /mnt/restreamer/db:/restreamer/db with -v /mnt/restreamer/db:/core/config -v /opt/restreamer/data:/core/data in your docker command line.

6. Start Restreamer. Now the settings from v0.6.8 are imported to v2.x

7. Done.

Your docker command should now look like

After the old settings have been successfully imported, the old settings database (v1.json) stored in /mnt/restreamer/db will not be used anymore. A new settings database (db.json) and a config file (config.json) have been created in that directory.

Review your Docker command line

As in the example command line above, there are two environment variables RS_USERNAME and RS_PASSWORD. You can remove those because during the first start of Restreamer v2.x their values were transferred into the config.json.

Your docker command should now look like

Your actual command line might have different paths to the mounted directories. Please adjust the example above accordingly in case you want to copy/paste it.

Overview real-time monitoring

1 Video stream

A video stream for viewing.

2 Audience count

The number of the current audience.

3 Audience bit rate

in Mbit/s

4 Uptime

Operating time is the duration of time the active livestream is used in hours, minutes, and seconds.

5 Video stream bitrate

Bitrate of the active live stream

6 Frame rate

Frames per second — short FPS.

7. System data

Learn more

Follow us on Twitter or YouTube and sign up for our newsletter, so you don't miss the launch of the datarhei service.

Overview

System settings in 3 steps

How to navigate to the system settings menu in 2 clicks and activate the expert mode.

Quick start video guide

Learn more

1 General system settings

2 General

Node-ID

The node ID can be used to uniquely identify the running datarhei core.

Name

The name makes it easier for people to identify the core. In addition, it is generated automatically or can be customized.

3 Update

Enable automatic check for updates.

4 Expert mode

In the expert mode, you have access to all functions of datarhei Restreamer, including the export of databases or the encryption of external files. Due to the significantly extended range of functions compared to the beginner mode, the expert mode is primarily intended for users who already know the program and want its full range of functions.

5 Restart

Restarting the Core.

6 Save

Do not forget to save the settings.

7 Abort

Unsaved settings will be lost by aborting.

8 Close window

Closes the active window without saving.

Learn more

Video Setup

After entering the datarhei Restreamer graphical user interface for the first time, you can use the wizard to set up a video source. The wizard will help you to configure the single steps conveniently.

Step 1: Video Setup

Select whether to retrieve the video source from a network source (such as a network camera) or from the internal RTMP server (such as OBS Streams or Wowza).

Step 2: Video setup

Select one of the available video profiles of the video source.

Step 3: Audio setup

This step sets the audio from the live stream.

Step 4: Metadata

Metadata is essential for the search engine optimization of a video. Therefore, a short description of the video for the audience is optimal.

Step 5: License

Think briefly about the terms under which the video will be published on the Internet. All Creative Commons licenses are supported. The Creative Commons page explains the details of the different licenses in detail.

Restart wizard

Learn more

1 Network settings

2 Public-Domain/s

The publicly accessible domain name of the host on which this Restreamer is running. Separate multiple domain names with commas. The default value is: demo-core.datarhei.com

3 HTTP Address

Address on which HTTP requests should listen. The default value is Port: 8080

4 HTTPS Address

Address on which HTTPS requests should listen. The default value is Port: 8181

HTTPS (SSL/TLS)

5 Certification with Let's Encrypt

Bandwidth control

6 Maximum sessions

Sets a limit for viewers in an HLS session. Once the limit is exceeded, HLS viewers receive the HTTP status code 509 (bandwidth limit exceeded).

The default value is unlimited: 0

7 Maximum bit rate

Sets a bandwidth limit in Mbit/s for outgoing HLS data transmission. All services and outgoing processes are included in the calculation. Once the bandwidth is exceeded, HLS viewers receive the HTTP status code 509 (bandwidth limit exceeded).

The default value is unlimited: 0

Learn more

1 Playback settings

Security

2 Allow all referer

Enable or disable Allow access from all referrers.

3 CORS security

The HTTP request header "Referrer" contains the page's absolute or partial address from which the request originates. The referrer header allows a server to identify a page from which it is visited. This data is used by datarhei Restreamer to bring essential protection to the live streams.

The access control takes effect when the hook is deactivated, and a domain is entered.

4 HLS statistics for /memfs.

The audience count is displayed when the hook is active.

5 Ignore IP ranges

To exclude viewers from the statistics, it may be necessary to ignore IP addresses so that the statistics are not distorted. For this purpose, a list of IP ranges in CIDR notation can be created in the text field, e.g., 127.0.0.1/32, which are not covered by the statistics.

6 Session timeout

Length of the time interval in seconds when the viewer's session is terminated to no longer be captured by the statistics.

7 Persist session history

Session data is stored on the hard disk of the core host system.

Learn more

1 Authorization settings

2 Enable login/JWT authorization

3 Username

Here you can store the name for the login.

4 Password

Password for authorization on the system.

Learn more

1 Storage settings

2 settings for /memfs

Basic authentication for PUT, POST and DELETE requests. It is strongly recommended to enable basic authentication to prevent unauthorized writes to /memfs.

3 Username

4 Password

5 Maximum file size

6 Remove old files

7 Hard disk

8 Hard disk cache

9 Maximum file size

10 Cache timeout

11 Maximum file size

12 Cache Type

Learn more

1 SRT settings

2 SRT server

The ✅ checkmark activates the SRT server.

3 Port

Port settings for the SRT server.

4 Token

SRT token for publishing and playback. It is a protection against unwanted inputs/outputs. The token is the value of the URL query parameter 'token'. This setting is optional.

5 Passphrase

This setting encrypts the stream and is optional.

Learn more

2 Copy

Copies the system log to the clipboard.

3 Logging level

Different levels of logging. There are five different levels.

• Silent

• Error

• Warn: Errors and warning messages

• Info: Errors, warnings, and information messages

• Errors, warnings, information messages, and debug information

4 Log lines

The number of log lines.

FFmpeg

5 Log lines

Number of most recent log lines to keep for each process.

6 Log history

Number of most recent log lines to keep for each process.+

Learn more

1 Notes

2 Imprint

The link to the imprint becomes active in the footer when a text is placed in the text field and saved.

3 Terms

The link to the terms of use becomes active in the footer when a text is in the text field and is saved.

4 Open publication website

Opens the publication website in a browser tab.

5 Save

Save to save the settings.

Learn more

1 RTMP settings

RTMP/S

2 RTMP server

The ✅ checkmark activates the RTMP server.

3 RTMPS server

The ✅ checkmark activates the RTMPS server.

4 Port RTMP

Port settings for the RTMP server.

5 Port RTMPS

Port settings for the RTMP/S server.

6 App

The RTMP application name is a path prefix for the stream name for publishing and playback. This is sometimes required by RTMP clients. It can be an arbitrary name (e.g. /foobar) and will be prefixed to the stream name (e.g. /foobar/live.stream).

7 Token

RTMP token for publishing and playback. The token is the value of the URL query parameter 'token'.

Learn more

Configuration menu

Edit the individual elements and extend them with HTML code elements.

With two clicks to the settings of the publication website

Learn more

2 Available templates

The current default template cannot be deleted. If new templates are uploaded, they appear in a dropdown.

3 Delete

Delete available templates.

4 Template name

Give the template a pretty name!

5 Upload

The button uploads the template.

6 Open publication website

Opens the publication website in a browsertab.

7 Save

Save the publication website settings.

Learn more

2 Text colors

Default

Color for general text.

Headline

For all headlines in title, channels, modal box.

Link

The link color in the texts.

Link Mouseover

Hover color when hovering the mouse cursor over it.

3 Background colors

Default

The background color of the web page.

Header

Color for the title bar

Selected

Color of the active tile in the channels. Only active for multiple live streams.

Unselected

Color of the inactive tile in the channels. Only active for multiple live streams.

Line color

Line color defines the color of the horizontal lines.

4 Background image

Upload background image as JPEG or PNG. Recommended resolution 1280x720 px. The address to the image will be displayed.

5 Open publication website

Opens the publication website in a browser tab.

6 Save

Save to save the settings.

Learn more

Add more video sources

Activate additional video sources via the interface in the browser in just a few steps.

1 Open video bar

The icon opens an additional layer at the bottom of the screen.

2 Add video source

The wizard starts to create the new video source. After successful creation and saving, the latest video source appears in the bar (video bar) at the bottom of the screen.

3 Active video sources

Active video signals appear in the video bar at the bottom of the screen.

4 Close

Collapses the video bar.

Delete video source

Each video source is deleted from the settings menu of the respective live stream.

Quick Start Guide

Learn more

1 General

Video settings

2 Launching the video wizard

🧙Start the video source wizard.

3 Video settings

Adjust the active video settings

Audio settings

4 Launch audio wizard

🧙Starts the wizard for the audio sources

5 Audio settings

Customize the active audio settings.

...

6 Abort

Unsaved settings are lost by canceling.

7 Delete video sources

The active video source is completely removed from the system.

8 Save

Do not forget to save settings.

9 Close

Closes the active window without saving.

Learn more

Specify in the Publication services where the stream should be pulled over.

HLS (memfs) & HLS (diskfs)

Default In this case we use the HLS stream of the channel and push it to the desired destination. Latency: What the user has set (min. 10-30 sec.)

RTMP

Take the stream from the RTMP server if the channel is enabled as shown in "2. Channel Edit > Processing & Control". Latency: 1-2 sec.

SRT

As for RTMP. Latency: <1 sec.

What is a Publication Service?

There are many Publication Services. Any number of new services can be created for different platforms. The procedure for using publication services is always very similar. The datarhei Restreamer is connected to the external service via a streaming key. Then the video stream is started on the service, in this example, YouTube.

Video tutorial

Platforms

If a platform for distributing your content is missing, don't hesitate to contact us. We will add the publication service immediately. Just submit a pull request via GitHub or write an email to support@datarhei.com.

Social Media

• YouTube

• Facebook

• Twitter

• Twitch

• Vime

• Instagram

• TikTok

• Amazon

• LinkedIn

• Telegram

• dlive

• Trovo

• PeerTube

CDN

• livespotting.com — The #1 webcam platform for webcams in Germany

• restream.io — Multi-Channel Platform

• be.live

• Brightcove — OTT

• Akamai - CDN

• DaCast - OTT

• CDN77 - CDN

• Azure Media Services - CDN

• Media Network

Software

• WOWZA

• Icecast

• Red5

• Ant Server

• NginX with nginx-rtmp-module

Protocol

• Image2

• RTSP

• RTMP

• HLS

• DASH

• SRT

• UDP

• MPEG-TS

• Framebuffer

Troubleshooting

If connection problems occur, error diagnostics can be performed via the error logs of the process details and the process report.

Learn more

2 Extend header

Insert code in the header style. Code at the end of the body, for example, to use external scripts.

<link rel="stylesheet" src="something"/>

3 Extend channel list

Insert code in the channel list.

<link rel="stylesheet" src="something"/>

4 Extend content

Insert code between the description of the live stream and the author's name. An example, for a comment widget or social media widget.

<link rel="stylesheet" src="something"/>

5 Extend footer

Insert code into the header style.

<link rel="stylesheet" src="something"/>

6 Open player site

Opens the publication website in a browser tab.

7 Save

Save to save the settings.

Learn more

Configuration menu live stream

Open the settings menu of the active video stream to see the configuration menu.

Open stream settings with one click

Learn more

Video tutorial

Learn more

1 Network as video source

Fetch or receive data? There are two different variants to choose from as a mode: Push or Pull. The respective setting influences the further menu navigation.

2 Pull or receive mode

3 Protocol

You can select between > SRT > RTMP or > HLS.

4 Send the stream to this address:

Enter this address in the sending device from the video signal.

5. CHECK

Pressing the button verifies the reception of the video signal.

2 Fetch in push mode

3 Network source address push

At this point, the address of the server can be customized. The address supports HTTP, HTTPS (HLS, DASH), RTP, RTSP, RTMP, and SRT.

4 Login credentials

If required, the access data of the video source can be entered here.

5 Advanced settings in push mode

HTTP and HTTPS

Read input at native speed

Force input frame rate

User-agent

General

Tread Queue Size

This option sets the maximum number of packets in the queue when read from the file or device. For low latency/high rate live streams, packages may be discarded if they are not read in time; setting this value may force FFmpeg to use a separate input thread and read packets as they arrive. The default value is 512.

> Flags

Default value is: genpts

1. discardcorrput -> Discard damaged frames

2. fastseek -> Enable fast but inaccurate searches for some formats.

3. genpts -> Generate the timestamp of the video

4. igndts -> Ignore decoding of the timestamp

5. ignidx -> Ignore index

6. nobuffer -> Reduce latency caused by optional buffering

7. nofillin -> Do not fill in missing values that can be calculated exactly

8. noparse -> Disable AVParsers, that needs filling too

9. sortdts -> Try to interleave the output packets by decoding the timestamp

6. CHECK

After starting the test process, the active video stream can be selected.

Encoding settings

Passthrough (copy) option takes the unedited video stream.

• Passthrough (copy) option takes the unedited video stream.

• H.264 (libx264) starts a video encoding with the free and open-source software library.

Learn more

1 Virtual video source

Various signals, such as “Game Of Live” are available as an option with S23/B3 rule for test operation. FPS and size can be adjusted depending on the signal.

2 Video source selection

• Test pattern

• Test pattern extended

• RGB test pattern

• YUV test pattern

• EBU PAL 75%

• EBU PAL 100%

• SMPTE EG 1-1990

• SMPTE RP 219-2002

• Game of Live