Getting Started with Docker

Getting Started with default settings

OvenMediaEngine provides the Docker image from OvenMedia Labs Docker Hub (ovenmedialabs/ovenmediaengine) repository. After installing Docker, you can simply run the following command:

docker run --name ome -d -e OME_HOST_IP=Your.HOST.IP.Address \
-p 1935:1935 -p 9999:9999/udp -p 9000:9000 -p 3333:3333 -p 3478:3478 -p 10000:10000/udp -p 10000:10000/tcp \
ovenmedialabs/ovenmediaengine:latest

Choosing an image tag

The ovenmedialabs/ovenmediaengine repository provides the following tags:

Tag	Description
latest	The most recent stable release. Convenient, but the version it points to changes as new releases ship.
dev	The latest development build from the master branch.
v0.20.5	A specific stable release — recommended for production, so deployments stay on a fixed version. Browse the available tags or the releases page and pin the version you want.

For example, to run a specific release:

docker run --name ome -d -e OME_HOST_IP=Your.HOST.IP.Address \
-p 1935:1935 -p 9999:9999/udp -p 9000:9000 -p 3333:3333 -p 3478:3478 -p 10000:10000/udp -p 10000:10000/tcp \
ovenmedialabs/ovenmediaengine:v0.20.5

warning

If a certificate is not installed in OvenMediaEngine, some functions (WebRTC Ingest, LLHLS playback) may not work due to the browser's security policy. Please refer to Complex Configuration section to install the certificate.

You can set the following environment variables.

Environment Variables

Env	Default Value
OME_HOST_IP	*
OME_ORIGIN_PORT	9000
OME_RTMP_PROV_PORT	1935
OME_SRT_PROV_PORT	9999/udp
OME_MPEGTS_PROV_PORT	4000/udp
OME_LLHLS_STREAM_PORT	3333
OME_LLHLS_STREAM_TLS_PORT	3334
OME_WEBRTC_SIGNALLING_PORT	3333
OME_WEBRTC_SIGNALLING_TLS_PORT	3334
OME_WEBRTC_TCP_RELAY_PORT	3478
OME_WEBRTC_CANDIDATE_PORT	10000/udp
OME_WEBRTC_TCP_ICE_PORT	10000/tcp

Getting Started with Complex Configuration

When you need to install a certificate in OME or apply a complex configuration, you can do it by following the procedure below to modify Server.xml inside Docker.

OvenMediaEngine docker container loads configuration files from the following path.

Type	Path / Description
Server.xml	/opt/ovenmediaengine/bin/origin_conf/Server.xml
Logger.xml	/opt/ovenmediaengine/bin/origin_conf/Logger.xml
Server Certificate	/opt/ovenmediaengine/bin/origin_conf/cert.crt Server certificate file in PEM format. The intermediate certificate must not be included.
Private Key	/opt/ovenmediaengine/bin/origin_conf/cert.key This is the private key file of the certificate.
CA Bundle	/opt/ovenmediaengine/bin/origin_conf/cert.ca-bundle A file containing root and intermediate certificates.

There are many ways to change files inside a Docker container, but this document describes how to change them using Docker's bind mounts.

Setup

Create the directories

export OME_DOCKER_HOME=/opt/ovenmediaengine
sudo mkdir -p $OME_DOCKER_HOME/conf
sudo mkdir -p $OME_DOCKER_HOME/logs

# Set permissions for the created directory if necessary.
sudo chgrp -R docker $OME_DOCKER_HOME 
sudo chmod -R 775 $OME_DOCKER_HOME

# If you want to use OME_HOME permanently, add the following line to the ~/.profile file for bash, for other shells, you can do it accordingly.
echo "export OME_DOCKER_HOME=/opt/ovenmediaengine" >> ~/.profile

Copy the default configurations from Docker container

docker run -d --name tmp-ome ovenmedialabs/ovenmediaengine:latest
docker cp tmp-ome:/opt/ovenmediaengine/bin/origin_conf/Server.xml $OME_DOCKER_HOME/conf
docker cp tmp-ome:/opt/ovenmediaengine/bin/origin_conf/Logger.xml $OME_DOCKER_HOME/conf
docker rm -f tmp-ome

Copy the certificate files to the directory

Copy your PEM certificate files to the path below if you need to enable TLS. The destination file names must match if using the default configuration. If you want to change the file name, you can do so by editing the Server.xml configuration file. See TLS Encryption for details.

cp /your/server_certificate_file.crt $OME_DOCKER_HOME/conf/cert.crt
cp /your/certificate_key_file.key $OME_DOCKER_HOME/conf/cert.key
cp /your/ca_bundle_file.ca-bundle $OME_DOCKER_HOME/conf/cert.ca-bundle

Modify Server.xml if necessary

vi $OME_DOCKER_HOME/conf/Server.xml

Running

Run Docker Container

The command below will make your OvenMediaEngine docker container run with $OME_DOCKER_HOME/conf/Server.xml and $OME_DOCKER_HOME/conf/Logger.xml files on your host. It will also create $OME_DOCKER_HOME/logs/ovenmediaengine.log file.

docker run -d -it --name ome -e OME_HOST_IP=Your.HOST.IP.Address \
-v $OME_DOCKER_HOME/conf:/opt/ovenmediaengine/bin/origin_conf \
-v $OME_DOCKER_HOME/logs:/var/log/ovenmediaengine \
-p 1935:1935 -p 9999:9999/udp -p 9000:9000 -p 3333:3333 -p 3478:3478 \
-p 10000:10000/udp -p 10000:10000/tcp \
ovenmedialabs/ovenmediaengine:latest

Check the log file

tail -f $OME_DOCKER_HOME/logs/ovenmediaengine.log

Restart Docker Container

docker restart ome

Stop and Remove Container

docker stop ome
docker rm ome