Getting Started with Docker

Download and Installation

OvenMediaEngine Enterprise is available as a Docker image to support various user environments. If you have received the Archived Docker Image File (.TGZ) of OvenMediaEngine Enterprise from the OME Enterprise Team, download it, and use the Docker Load Command to load it.

docker load -i <path_to_your_tgz_file>

Applying the License Key

If you have received a License Key from the OME Enterprise Team, you can apply it using one of the two methods described below.

Note that the environment variable will take precedence if both methods are used.

Use the Environment Variable

docker run -e OME_LICENSE_KEY=<your_license_key>

Directly Enter the License Key

To input the license key provided by the OME Enterprise Team, directly enter it into the conf/License file.

1. Open the conf/License file.

2. Enter the License Key.

3. Save the file and restart the service if necessary.

By following these steps, you can ensure that your license is correctly applied, enabling all the features and support provided by OvenMediaEngine Enterprise.

Detailed User Guide: https://airensoft.gitbook.io/ovenmediaengine/getting-started/getting-started-with-docker

Ports used by default

The default configuration uses the following ports, so you need to open it in your firewall settings:

OvenMediaEngine

Port	Purpose
1935/TCP	RTMP Input
9999/UDP	SRT Input
4000/UDP	MPEG-2 TS Input
9000/TCP	Origin Server (OVT)
3333/TCP 3334/TLS	Low Latency HLS (LLHLS) Streaming * Streaming over non-TLS is not allowed with modern browsers.
3333/TCP 3334/TLS	WebRTC Signaling (both ingest and streaming)
3478/TCP	WebRTC TCP relay (TURN Server, both ingest and streaming)
10000 - 10009/UDP	WebRTC Ice candidate (both ingest and streaming)
20080/TCP 20081/TLS	Thumbnail Extraction

Web Console (OvenStudio)

Port	Purpose
8080/TCP	Running Web Console

Example Firewall Commands

You can specify the protocol (TCP or UDP) if needed, but if you don't specify, Docker will default to TCP. To explicitly define the protocol, you can use. It's often a good practice to specify the protocol to avoid ambiguity. You can open firewall ports as in the following example:

docker run -p 3333:3333/tcp -p 3334:3334/tcp -p 1935:1935/tcp -p 9999:9999/udp -p 4000:4000/udp -p 3478:3478/tcp -p 9000:9000/tcp -p 10000-10009:10000-10009/udp -p 8080:8080/tcp ...