Getting Started with Ubuntu

To get started with OvenMediaEngine Enterprise on Ubuntu, check the Prerequisites below and then follow the Installation methods.

Prerequisites

OS requirements

To install OvenMediaEngine Enterprise, you need one of the following Ubuntu versions:

• Ubuntu 24.04 LTS

• Ubuntu 22.04 LTS

• Ubuntu 20.04 LTS

Location

By default, OvenMediaEngine Enterprise is installed in the following locations:

• Binary&Config: /usr/share/ovenmediaengine

• Log: /var/log/ovenmediaengine

Installation methods

Install using the apt repository

Before you install OvenMediaEngine Enterprise for the first time on a new server, you need to set up OvenMediaEngine apt repository. Afterward, you can install and update OvenMediaEngine from the repository.

Set up OvenMediaEngine's apt repository

To set up the repository, a valid License Key is required.

# You may need to install curl and/or gpg first, if you're on a very minimal host
sudo apt update
sudo apt install curl gpg -y

VALID_LICENSE_KEY="Your.License.Key"

# Install the registry signing key
curl -fsSL "https://buildkite:$[e-mail]/ovenmediaengine/ubuntu/gpgkey" | sudo gpg --dearmor -o /etc/apt/keyrings/ovenmediaengine_ubuntu-archive-keyring.gpg

# Stash the private registry credentials into apt auth.conf
echo "machine https://packages.buildkite.com/ovenmediaengine/ubuntu/ login buildkite password $VALID_LICENSE_KEY" | sudo tee /etc/apt/auth.conf.d/ovenmediaengine_ubuntu.conf
sudo chmod 600 /etc/apt/auth.conf.d/ovenmediaengine_ubuntu.conf

# Configure the source
echo -e "deb [signed-by=/etc/apt/keyrings/ovenmediaengine_ubuntu-archive-keyring.gpg] https://packages.buildkite.com/ovenmediaengine/ubuntu/any/ any main\ndeb-src [signed-by=/etc/apt/keyrings/ovenmediaengine_ubuntu-archive-keyring.gpg] https://packages.buildkite.com/ovenmediaengine/ubuntu/any/ any main" | sudo tee /etc/apt/sources.list.d/buildkite-ovenmediaengine-ubuntu.list

Install the OvenMediaEngine Enterprise packages.

Latest

To install the latest version, run:

sudo apt update
sudo apt install ovenmediaengine

Specific version

To install a specific version of OvenMediaEngine Enterprise, start by listing the available versions in the repository:

# List the available versions
apt-cache madison ovenmediaengine | awk '{ print $3 }'

0.17.2.4-1
...

Select the desired version and install:

VERSION=0.17.2.4-1
sudo apt update
sudo apt install ovenmediaengine=$VERSION

After the installation is completed, follow the Post-installation steps.

Uninstall OvenMediaEngine Enterprise

To uninstall, use the following command:

sudo apt purge ovenmediaengine

Install from a package

Download

OvenMediaEngine Enterprise is available as a deb package. If you have received a link to download the DEB file from the OME Enterprise team, please download the file and follow the guide below to install and run it.

Install from a package

Move to the directory where the package was downloaded, and then install OvenMediaEngine Enterprise:

sudo dpkg -i <ovenmediaengine-enterprise-package>.deb
Selecting previously unselected package ovenmediaengine.
(Reading database ... 72282 files and directories currently installed.)
Preparing to unpack <ovenmediaengine-enterprise-package>.deb ...
Unpacking ovenmediaengine (<version>) ...
Setting up ovenmediaengine (<version>) ...

# If you are upgrading, please run "systemctl daemon-reload"
sudo systemctl daemon-reload

If OvenMediaEngine is already installed in the /usr/share/ovenmediaengine directory, it will be automatically upgraded, retaining the existing configuration files.

After the installation is completed, follow the Post-installation steps.

Uninstall OvenMediaEngine Enterprise

To uninstall, use the following command:

dpkg -r ovenmediaengine

# Include deletion of configuration files.
dpkg -P ovenmediaengine

You have to delete any edited configuration files manually.

Post-installation steps

License Registration

Before running OvenMediaEngine, you must register a valid License Key:

echo 'Your.License.Key' | sudo tee /usr/share/ovenmediaengine/conf/License

Host IP Configuration

To use the Web Console (OvenStudio) smoothly, you need to configure the host IP of the server.

Please check here for detailed configuration instructions.

echo -e '\nOME_HOST_IP=Your.HOST.IP.Address' | sudo tee -a /usr/share/ovenmediaengine/ovenstudio/system.env

Start OvenMediaEngine Enterprise

Start the services with the following commands:

# Start OvenMediaEngine
sudo systemctl start ovenmediaengine
# Start Web Console (OvenStudio)
sudo systemctl start ovenstudio
# Start OvenMediaEngine Delivery Module
sudo systemctl start ovenmediaengine-delivery

# If you want to auto-start on boot
sudo systemctl enable ovenmediaengine
sudo systemctl enable ovenstudio
sudo systemctl enable ovenmediaengine-delivery

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 open firewall ports as in the following example:

sudo ufw allow from any to any port 3333 proto tcp
sudo ufw allow from any to any port 3334 proto tcp
sudo ufw allow from any to any port 1935 proto tcp
sudo ufw allow from any to any port 9999 proto udp
sudo ufw allow from any to any port 4000 proto udp
sudo ufw allow from any to any port 3478 proto tcp
sudo ufw allow from any to any port 9000 proto tcp
sudo ufw allow from any to any port 10000:10009 proto udp
sudo ufw allow from any to any port 8080 proto tcp