arrow-left

All pages
gitbookPowered by GitBook
1 of 3

Loading...

Loading...

Loading...

Terminal

Install and run datarhei Restreamer on Mac with Intel or Silicon chip in an Docker container.

circle-check

After installation, control the restreamer in any browser using the IP and port of the device with the path /ui.

hashtag
Requirements

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

hashtag
Preparation

hashtag
Step 1: Install Docker

Download, install and run . Follow the installation instructions. If you are already using Docker, skip this step.

hashtag
Installation Windows PowerShell

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

hashtag
Step 2: Start the Restreamer

Without hardware support

Start with hardware support for Nvidia CUDA

Start with hardware support for Intel VAAPI

circle-exclamation

For security reasons, start the Restreamer only with --privileged if you need hardware support.

hashtag
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

hashtag
Step 4. First login

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

hashtag
Important: The Environments

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

hashtag
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.

hashtag
List with all available environment variables

hashtag
Learn more

Docker Desktoparrow-up-right
Loginchevron-right
How do I install Docker?chevron-right
How does port forwarding work for the Restreamer?chevron-right
How can I use HTTPS with Let's Encrypt?chevron-right
What are environment variables?chevron-right
Environment Variableschevron-right
📚Knowledge Basechevron-right
👨‍💻Developerchevron-right
⭐Premium Supportchevron-right
Fig 1. Docker command in Windows PowerShell

Windows

Install and run Restreamer on Microsoft Windows with Docker Desktop.

circle-check

After installation, control the Restreamer in any browser using the IP and port of the device with the path /ui.

hashtag
Preparation

hashtag
Step 1: Install Docker Desktop

Download, install and run . Follow the installation instructions. If you are already using Docker Desktop and installed WSL 2, skip to Step 4.

hashtag
Step 2: WSL 2 installation

To make the Restreamer container compatible with Windows, installing the Linux kernel update is necessary. The instructions are available on and websites. We recommend using the Debian or Ubuntu package. Follow the instructions, and there will be no problems.

hashtag
Step 3: Docker Desktop settings

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

triangle-exclamation

After the steps, we recommend rebooting the computer.

hashtag
Start Restreamer container in Docker Desktop

hashtag
Step 4: Pull the container with the Restreamer

Open the command-line PowerShell for Windows and load the cotainer from Docker Hub. Use the command:

hashtag
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.

hashtag
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

hashtag
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

hashtag
Step 8. First login

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

hashtag
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!

hashtag
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.

hashtag
List with all available environment variables

hashtag
Learn more

Docker Desktop

Install and run Restreamer on Microsoft Windows with Docker Desktop.

circle-check

After installation, control the Restreamer in any browser using the IP and port of the device with the path /ui.

hashtag
Preparation

docker run --detach --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
docker run --detach --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
docker run --detach --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
and
/core/data
.
Docker Desktoparrow-up-right
Microsoftarrow-up-right
Dockerarrow-up-right
latest Restreamerarrow-up-right
Loginchevron-right
How do I install Docker?chevron-right
How does port forwarding work for the Restreamer?chevron-right
How can I use HTTPS with Let's Encrypt?chevron-right
What are environment variables?chevron-right
📚Knowledge Basechevron-right
👨‍💻Developerchevron-right
⭐Premium Supportchevron-right
Fig 1. WSL 2 notice in Docker Desktop
Fig 2. Debian Image in Windows-App-Store
Fig 3. Docker Desktop settings with Debian
Fig 4. Docker pull command in PowerShell
Fig 6. Docker Desktop with Restreamer Image
Fig 7. Restreamer Desktop settings with ports and path on volume
Fig 8. Active Restreamer container in Docker Desktop.
hashtag
Step 1: Install Docker Desktop

Download, install and run Docker Desktoparrow-up-right. Follow the installation instructions. If you are already using Docker Desktop and installed WSL 2, skip to Step 4.

hashtag
Step 2: WSL 2 installation

To make the Restreamer container compatible with Windows, installing the Linux kernel update is necessary. The instructions are available on Microsoftarrow-up-right and Dockerarrow-up-right websites. We recommend using the Debian or Ubuntu package. Follow the instructions, and there will be no problems.

Fig 1. WSL 2 notice in Docker Desktop
Fig 2. Debian Image in Windows-App-Store
Fig 3. Docker Desktop settings with Debian

hashtag
Step 3: Docker Desktop settings

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

triangle-exclamation

After the steps, we recommend rebooting the computer.

hashtag
Start Restreamer container in Docker Desktop

hashtag
Step 4: Pull the container with the Restreamer

Open the command-line PowerShell for Windows and load the latest Restreamerarrow-up-right cotainer from Docker Hub. Use the command:

Fig 4. Docker pull command in PowerShell

hashtag
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.

Fig 6. Docker Desktop with Restreamer Image

hashtag
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.

Fig 7. Restreamer Desktop settings with ports and path on volume

hashtag
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

Fig 8. Active Restreamer container in Docker Desktop.

hashtag
Step 8. First login

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

hashtag
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!

hashtag
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.

hashtag
List with all available environment variables

hashtag
Learn more

Loginchevron-right
How do I install Docker?chevron-right
How does port forwarding work for the Restreamer?chevron-right
How can I use HTTPS with Let's Encrypt?chevron-right
What are environment variables?chevron-right
📚Knowledge Basechevron-right
👨‍💻Developerchevron-right
⭐Premium Supportchevron-right
docker pull datarhei/restreamer:latest
docker pull datarhei/restreamer:latest
GitHub - datarhei/core: datarhei Core is management for FFmpeg processes without development effort. Whether your streaming has one viewer or a million, we have the tools to help you develop, deploy and manage any video project at any stage. We've solved the challenging problems so you can focus on your application, not your infrastructure.GitHubchevron-right
External URL: All Environment variables on GitHub.
GitHub - datarhei/core: datarhei Core is management for FFmpeg processes without development effort. Whether your streaming has one viewer or a million, we have the tools to help you develop, deploy and manage any video project at any stage. We've solved the challenging problems so you can focus on your application, not your infrastructure.GitHubchevron-right
External URL: All Environment variables on GitHub.
GitHub - datarhei/core: datarhei Core is management for FFmpeg processes without development effort. Whether your streaming has one viewer or a million, we have the tools to help you develop, deploy and manage any video project at any stage. We've solved the challenging problems so you can focus on your application, not your infrastructure.GitHubchevron-right
External URL: All Environment variables on GitHub.
Logo
Logo
Logo