Skip to main content

Getting Started with Linux

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

Prerequisites​

OS requirements​

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

  • Ubuntu 24.04 LTS
  • Ubuntu 22.04 LTS
  • RHEL 9
  • RHEL 8

Disk space​

Installing takes about 3.2GB of free space: roughly 1.6GB under /usr, 750MB under /opt, and 800MB for the downloaded package, which the package manager caches under /var. On most systems these share one filesystem, so plan for the total.

Upgrades need the same amount. The new files are unpacked before the old ones are removed, so the peak is close to a fresh install even though little is added.

Set aside additional space for the metrics history collected by the bundled Prometheus — up to 5GB by default, and adjustable.

The installation script checks all of this before it starts and stops with a clear message if any filesystem is short.

Location​

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

  • Binary&Config: /usr/share/ovenmediaengine
  • Dependencies: /opt/ovenmediaengine
  • Log: /var/log/ovenmediaengine
  • Metrics data: /usr/share/ovenmediaengine/prometheus/data

Installation​

Automatic download and installation​

OvenMediaEngine Enterprise can be easily installed with a single command using the installation script.

Download the installation script​

curl -fsSL https://packages.ovenmediaengine.cloud/scripts/install-ovenmediaengine-enterprise.sh -o install-ovenmediaengine-enterprise.sh && chmod +x install-ovenmediaengine-enterprise.sh

Install or upgrade OvenMediaEngine Enterprise​

[Install]​

For the initial installation, run the installation script with a valid license key provided as a parameter.

sudo ./install-ovenmediaengine-enterprise.sh -k 'Your.License.Key'

[Upgrade]​

To upgrade to the latest version, simply run the installation script without providing a license key.

sudo ./install-ovenmediaengine-enterprise.sh

Uninstall OvenMediaEngine Enterprise​

To uninstall, use the following command:

sudo ./install-ovenmediaengine-enterprise.sh --uninstall

Install from a package​

Package Download​

OvenMediaEngine Enterprise is also provided as packages in .deb and .rpm formats. If you have received a download link for the package files from the OME Enterprise team, please download the files and follow the instructions below to install and run them.

Download the installation script​

curl -fsSL https://packages.ovenmediaengine.cloud/scripts/install-ovenmediaengine-enterprise.sh -o install-ovenmediaengine-enterprise.sh && chmod +x install-ovenmediaengine-enterprise.sh

Install from a package​

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

sudo ./install-ovenmediaengine-enterprise.sh -k 'Your.License.Key' -f <ovenmediaengine-enterprise-package-file>

Uninstall OvenMediaEngine Enterprise​

To uninstall, use the following command:

sudo ./install-ovenmediaengine-enterprise.sh --uninstall

Start/Stop OvenMediaEngine Enterprise​

You can start or stop the services by running the following command:

# Start OvenMediaEngine
sudo systemctl stop ovenmediaengine
sudo systemctl start ovenmediaengine

# Start Web Console (OvenStudio)
sudo systemctl stop ovenstudio
sudo systemctl start ovenstudio

# Start OvenMediaEngine Delivery Module
sudo systemctl stop ovenmediaengine-delivery
sudo systemctl start ovenmediaengine-delivery

# Start the metrics collector (Prometheus)
sudo systemctl stop ovenmediaengine-prometheus
sudo systemctl start ovenmediaengine-prometheus

Post-installation Configuration​

Changing the License Key​

If the license key was entered incorrectly or needs to be changed, you can update it using the command below.

sudo ./install-ovenmediaengine-enterprise.sh -c -k 'Your.License.Key'

Changing the Host Address​

The host address can be changed if you need to update the value automatically configured during installation, or if a domain configuration is required to enable TLS.

sudo ./install-ovenmediaengine-enterprise.sh -c -H 'Your.Host.Address'
info

In private network or VPN environments, setting the Host Address explicitly ensures that the Web Console displays accurate ingest and playback URLs.

Metrics History​

The Web Console charts how your server has behaved over time using the bundled Prometheus, which starts with the other services and needs no setup — it reads the API port and access token from your Server.xml.

Two defaults are worth reviewing: it keeps 30 days of history and stops at 5GB of disk, whichever comes first. On a busy server the size limit is reached first, which shortens the window you can chart. Adjust both in /usr/share/ovenmediaengine/prometheus/system.env:

OME_PROMETHEUS_RETENTION_TIME=30d
OME_PROMETHEUS_RETENTION_SIZE=20GB

These are start-up flags, so restart the service to apply them:

sudo systemctl restart ovenmediaengine-prometheus

See Bundled Prometheus for disk sizing per server size and the full list of settings.

Ports used by default​

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

OvenMediaEngine​

PortPurpose
1935/TCPRTMP Input
9999/UDPSRT Input
4000/UDPMPEG-2 TS Input
9000/TCPOrigin Server (OVT)

80/TCP

443/TLS

Low Latency HLS (LLHLS) Streaming

* Streaming over non-TLS is not allowed with modern browsers.

80/TCP

443/TLS

WebRTC Signaling (both ingest and streaming)
3478/TCPWebRTC TCP relay (TURN Server, both ingest and streaming)

10000/UDP

10000/TCP

WebRTC Ice candidate (both ingest and streaming)

80/TCP

443/TLS

Thumbnail Extraction

Web Console (OvenStudio)​

PortPurpose
8080/TCPWeb Console (HTTP)
8443/TCPWeb Console (HTTPS)

Next Steps​

OvenMediaEngine Enterprise is now running. Here are the suggested next steps: