Start on Nimbra Edge Documentation

1. Deploy Nimbra Edge

Mon, 01 Jan 0001 00:00:00 +0000

1. Deploy Nimbra Edge #

Deploy the server that will run Nimbra Edge and its Network Manager web interface.

Launch the stack #

OCI uses a stack to create and manage the resources for your installation as a group, including the server, storage, and networking.

Open Nimbra Edge Core in OCI Marketplace and click Launch Stack.
Select the compartment and software version, accept the terms, and click Launch Stack. A compartment is a folder-like grouping of resources in your OCI account; this one holds the stack itself. Choose the one you use for this installation.

1. Prepare your cloud network

Mon, 01 Jan 0001 00:00:00 +0000

1. Prepare your cloud network #

Choose your AWS region. Use a VPC with a public subnet and an internet gateway. If you already have one, continue to Deploy Nimbra Edge .

Otherwise, open the VPC console , click Create VPC, and choose VPC and more. Create a VPC with a public subnet in your chosen region. Keep the VPC and subnet IDs for the next step.

Sign in to Nimbra Console

Mon, 01 Jan 0001 00:00:00 +0000

Get an account #

You cannot sign up for Nimbra Console yourself. You get access in one of two ways:

Net Insight creates your account. You receive an email titled “Your Nimbra Console account is ready”. Select Set your password, choose a password of at least 8 characters, and select Set password.
An administrator in your organization invites you. You receive an email titled “Invitation to organization in Nimbra Console”. Select Accept invitation, choose a password, and select Create account and accept.

2. Deploy Nimbra Edge

Mon, 01 Jan 0001 00:00:00 +0000

2. Deploy Nimbra Edge #

Deploy the server that will run Nimbra Edge and its Network Manager web interface.

Launch the stack #

A CloudFormation stack creates and manages the resources for your installation as a group, including the server and its security group.

Launch Nimbra Edge R4.2.1 in your AWS region:

Open the link for your region. The Nimbra Edge Core template is preselected.
Give the stack a name, for example nimbra-edge-core.
Keep the preselected EC2 Instance Type, and choose your VPC ID and Subnet ID.
Continue through the remaining pages, review the settings, and create the stack.
Wait for its status to become CREATE_COMPLETE.

2. Install Nimbra Edge

Mon, 01 Jan 0001 00:00:00 +0000

2. Install Nimbra Edge #

The server is ready. Now configure your installation and sign in to Network Manager.

Configure DNS #

Choose the hostname you want to use for Network Manager. You will connect it to your new server through DNS, then enter your license and create the administrator account. Automatic TLS gives your hostname a trusted HTTPS certificate.

Create a DNS A record for your hostname, such as my.nimbra.edge, pointing to Nimbra Edge Endpoint IP from the stack’s Application Information tab. This is a different IP from the appliance setup interface. Wait until public DNS resolves to it. Keep TCP ports 80 and 443 reachable from the internet for automatic TLS. The automatically created network allows both.

Manage Nimbra Console users

Mon, 01 Jan 0001 00:00:00 +0000

How to manage Nimbra Console users #

You need the Administrator role to invite and remove users. See Nimbra Console roles .

Select Users in the menu to see everyone in your organization and their role.

Invite a user #

On the Users page, select Invite user.
Enter the person’s email address.
Choose a Role: Basic to view information and retrieve license keys and files, or Administrator to also allocate licenses and manage users.
Select Send invitation.

3. Deploy a Core appliance

Mon, 01 Jan 0001 00:00:00 +0000

3. Deploy a Core appliance #

Use the Nimbra Edge Connect image for the Core appliance. During setup, you will choose its Core video role so it provides video capacity for your region.

Open Nimbra Edge Connect in OCI Marketplace and click Launch Stack.
Select the compartment and software version, accept the terms, and continue.
Name this second stack, for example nimbra-edge-video. Select the same deployment region as Nimbra Edge. Keep the prefilled compartment, which is where the server and networking are created. Keep the default CPU and memory settings. Leave Existing Subnet OCID empty to create networking automatically.
Review the settings, leave Run apply checked, and click Create. Wait for the apply job to show Succeeded.
Open the stack’s Application Information tab, follow Web Interface URL, and sign in as admin using Initial Password. Change this appliance password after first login.

3. Install Nimbra Edge

Mon, 01 Jan 0001 00:00:00 +0000

3. Install Nimbra Edge #

The server is ready. Now configure your installation and sign in to Network Manager.

Configure DNS #

Create a DNS A record for your hostname, for example my.nimbra.edge, pointing to PublicIP from the stack outputs. Wait until public DNS resolves to it. Keep TCP ports 80 and 443 reachable from the internet for automatic TLS; the template’s security group allows both.

Configure Nimbra Edge #

In the appliance setup interface:

Allocate appliance licenses

Mon, 01 Jan 0001 00:00:00 +0000

How to allocate licenses to an appliance #

You need the Administrator role in Nimbra Console, and the appliance’s serial number. You find the serial number in the appliance’s web interface under Management > License, and on the label on the appliance.

Allocate from the appliance page #

Use this when the appliance already has at least one license.

4. Connect a Core appliance

Mon, 01 Jan 0001 00:00:00 +0000

4. Connect a Core appliance #

Your Core appliance is deployed. Next, create its region in Network Manager and connect the appliance to your Nimbra Edge installation.

Create the region #

A video region groups the appliances that handle your video traffic. Create one in Network Manager before connecting your new appliance.

Open Create New… → Region.
Enter a name, for example Stockholm, and click Save.

4. Deploy a Core appliance

Mon, 01 Jan 0001 00:00:00 +0000

4. Deploy a Core appliance #

Use the Nimbra Edge Connect image for the Core appliance. During setup, you will choose its Core video role so it provides video capacity for your region.

Launch Nimbra Edge Connect R4.2.1 in your AWS region:

Open the link for the same AWS region you used for Nimbra Edge.
Give this second stack a name, for example nimbra-edge-video. Keep the preselected instance type and choose the same VPC and public subnet as before.
Review and create the stack. Wait for CREATE_COMPLETE.
Open Outputs, follow WebUI, and sign in as admin using Password. Change this appliance password after first login.

Install an appliance license offline

Mon, 01 Jan 0001 00:00:00 +0000

How to install an appliance license offline #

Use this when the appliance cannot reach the internet. You download the license file from Nimbra Console on a computer that has internet access, and install it in the appliance’s web interface.

Download the license file #

In Nimbra Console, select Appliances in the menu, and then select the appliance’s serial number.
In Current Licenses, select Download license. You get a file named like nimbra-license-N5D4R9-v3.txt, where the last number is the version of the license file.

5. Connect a Core appliance

Mon, 01 Jan 0001 00:00:00 +0000

5. Connect a Core appliance #

Your Core appliance is deployed. Next, create its region in Network Manager and connect the appliance to your Nimbra Edge installation.

Create the region #

A video region groups the appliances that handle your video traffic. Create one in Network Manager before connecting your new appliance.

Open Create New… → Region.
Enter a name, for example Stockholm, and click Save.

5. Connect an Edge appliance

Mon, 01 Jan 0001 00:00:00 +0000

5. Connect an Edge appliance #

Your Nimbra Edge installation now has a video region. Next, let’s connect a video appliance at your site to the video region. For this tutorial we will configure the appliance to generate a test stream, so you do not need a camera or other video source.

We are gonna use a Nimbra appliance, for example a Nimbra 520, configured as the Edge role. If you do not have an appliance, you can run Edge Connect on a Linux host instead .

Enable standalone mode

Mon, 01 Jan 0001 00:00:00 +0000

How to enable standalone mode #

In standalone mode, an Edge Connect appliance runs without Nimbra Edge. You set up inputs and outputs in the appliance’s own web interface.

Before you start #

You need:

A Standalone license for the appliance, and the Administrator role in Nimbra Console
Administrator access to the appliance’s web interface
Internet access from the appliance for the activation. After that, the appliance works without internet access.
An appliance that is not connected to Nimbra Edge. If it is, disconnect it on the Edge page first.

1. Get the activation key #

In Nimbra Console, allocate the Standalone license to the appliance. See Allocate appliance licenses .
Nimbra Console shows the activation key. Select Copy key.

License your first appliance

Mon, 01 Jan 0001 00:00:00 +0000

License your first appliance #

In this tutorial you allocate licenses to a new Nimbra 520 in Nimbra Console, and then check that the appliance has received them. It takes about ten minutes.

The examples use the serial number N5E3W8. Use your own appliance’s serial number instead.

Before you start #

You need:

A Nimbra Console administrator account. If you need one, ask an administrator in your organization.
An Edge OS - Nimbra 520 license and a HEVC + MP4 HD/UHD Encode/Decode - 8x HD/2x UHD codecs license that your organization has bought and not yet allocated.
A Nimbra 520 running Edge OS that can reach the internet.
The appliance’s serial number. You find it in the appliance’s web interface under Management > License, and on the label on the appliance.

1. Find your licenses #

Sign in at console.nimbra.io and select Licenses in the menu. The list shows each license your organization has bought, how many have been allocated, and how many are still available.

6. Connect an Edge appliance

Mon, 01 Jan 0001 00:00:00 +0000

6. Connect an Edge appliance #

We are gonna use a Nimbra appliance, for example a Nimbra 520, configured as the Edge role. If you do not have an appliance, you can run Edge Connect on a Linux host instead .

6. Send your first stream

Mon, 01 Jan 0001 00:00:00 +0000

6. Send your first stream #

You now have all the components needed to send video through Nimbra Edge. You will create a test signal on Edge Connect and an SRT output on your cloud Core appliance, then watch the stream on your computer.

The video will follow this path:

Edge Connect → cloud Core appliance → VLC on your computer

Create a test input #

In Network Manager, open Inputs and click Create Input.
Name the input Generator input.
Under Input appliance #1, select your Edge Connect, for example studio-1.
Choose generator as the mode. Keep the default test signal settings.
Click Save and wait for the input status to turn green.

A generator produces a test signal on the appliance itself, without an external video source.

7. Send your first stream

Mon, 01 Jan 0001 00:00:00 +0000

7. Send your first stream #

The video will follow this path:

Edge Connect → cloud Core appliance → VLC on your computer

Create a test input #

In Network Manager, open Inputs and click Create Input.
Name the input Generator input.
Under Input appliance #1, select your Edge Connect, for example studio-1.
Choose generator as the mode. Keep the default test signal settings.
Click Save and wait for the input status to turn green.

A generator produces a test signal on the appliance itself, without an external video source.

Switch a standalone appliance back to Nimbra Edge

Mon, 01 Jan 0001 00:00:00 +0000

How to switch a standalone appliance back to Nimbra Edge #

An appliance cannot be in standalone mode and connected to Nimbra Edge at the same time. To manage it from Nimbra Edge again, you first turn off standalone mode and then connect the appliance.

To export the configuration, see Back up a standalone appliance .

Apply a Nimbra Edge license key

Mon, 01 Jan 0001 00:00:00 +0000

How to apply a Nimbra Edge license key #

A Nimbra Edge license key lets you install and run Nimbra Edge. One key is used for one installation.

Get the license key #

In Nimbra Console, select Licenses in the menu.
Select a license of type Software. The page shows the installations that already use it.
Select Retrieve key, and then select Copy key.

Allocate RTUs to a cluster

Mon, 01 Jan 0001 00:00:00 +0000

How to allocate RTUs to a cluster #

The RTUs your organization buys are shared between your Nimbra Edge installations, which Nimbra Console lists under Clusters. You need the Administrator role to allocate them.

Add RTUs to a cluster #

Select Clusters in the menu, and then select the cluster.
In the RTUs section, check that enough RTUs of the type you need are available.

Releases

Mon, 01 Jan 0001 00:00:00 +0000

Releases #

Development builds #

Show

R4.2.2-rc2

Requirements

Mon, 01 Jan 0001 00:00:00 +0000

Requirements for Docker-based Nimbra Edge #

This document contains information about everything needed to be able to run Docker-based Nimbra Edge, both in terms of hardware requirements but also overall requirements on the system.

Upgrade

Mon, 01 Jan 0001 00:00:00 +0000

Upgrade Docker-based Nimbra Edge #

Upgrading Docker-based Nimbra Edge is done in the following steps.

Deploy on an internal network

Mon, 01 Jan 0001 00:00:00 +0000

Deploying Docker-based Nimbra Edge on an internal network #

By default the system requires port 80 (HTTP) to be exposed to the internet for the automated TLS certificate process to work (ACME HTTP-01 challenges are used). If this is not possible or desired, alternative approaches are explained here.

Migrate from Docker-based Nimbra Edge

Mon, 01 Jan 0001 00:00:00 +0000

Migrate from Docker-based Nimbra Edge #

This guide moves an existing Docker-based Nimbra Edge installation to a new Nimbra Edge control plane on Edge OS or Kubernetes. The configuration is moved with a config backup. The appliances that carry video keep running during the migration and reconnect to the new control plane.

0. Machine setup

Mon, 01 Jan 0001 00:00:00 +0000

0. Machine setup #

If you already have a machine to use for this tutorial simply verify it fulfills the hardware requirements . Specifically ensure that the CPU supports SSE4.2 instructions and that there is 16GB memory available.

1. Install the CLI and dependencies

Mon, 01 Jan 0001 00:00:00 +0000

1. Installing the connectit CLI #

The connectit CLI is used to manage the Docker-based Nimbra Edge installation. Its primary purpose is to install the core system and the video appliances. It has some secondary usages as well that we will touch on towards the end of this section.

2. Install core

Mon, 01 Jan 0001 00:00:00 +0000

2. Installing core #

Core is the control-plane of Docker-based Nimbra Edge and is the first component you will need to install. This section will help you install core and start you with navigating the Network Manager, the Nimbra Edge web interface.

3. Create a region

Mon, 01 Jan 0001 00:00:00 +0000

3. Creating a region #

Regions help you organize your Nimbra Edge deployment geographically or logically - for example, by data center or broadcast location. All appliances need to belong to a region. Edge appliances, for example Edge Connect or Nimbra 400, can also be assigned a secondary region for redundancy scenarios.

4. Install a video appliance

Mon, 01 Jan 0001 00:00:00 +0000

4. Installing a video appliance #

A video appliance is used to route video traffic between appliances. It is the central component for the Nimbra Edge data plane through which all video streams are sent.

5. Install an Edge Connect

Mon, 01 Jan 0001 00:00:00 +0000

5. Installing an Edge Connect #

Edge Connect is a video appliance that is used for ingesting and exporting video streams. In Nimbra Edge one ingests data with an Input and exports data with an Output.

6. Streaming video

Mon, 01 Jan 0001 00:00:00 +0000

6. Streaming video through Nimbra Edge #

We now have all the components in place to be able to stream video through Nimbra Edge.

Address mappings

Mon, 01 Jan 0001 00:00:00 +0000

Address mappings #

Address mappings specify how different Nimbra Edge core appliances connect to each other.

Address mappings are configured under ⚙ Settings → Address mappings

Region and Private address #

An address mapping belongs to a region and a private address. This means that if the region of an appliance changes or if the address of an interface changes, a new address mapping will need to be created. The old one will still exist for the old private address but will not have any effect, and it will be displayed in the list without an appliance or interface.

Appliance licenses

Mon, 01 Jan 0001 00:00:00 +0000

Appliance licenses #

These are the licenses you can allocate to an Edge OS appliance in Nimbra Console. All appliance licenses are permanent and belong to one appliance serial number.

Edge OS #

Each appliance needs the Edge OS license for its model.

Product code	Name	Appliance
NPM0099-0410_A1	Edge OS - Nimbra 410	Nimbra 410B
NPM0099-0414_A1	Edge OS - Nimbra 414	Nimbra 414B
NPM0099-0520_A1	Edge OS - Nimbra 520	Nimbra 520

Encode and decode #

Encode and decode licenses set how many video channels the appliance can encode or decode. Encoding and decoding share the same capacity. One UHD channel uses the capacity of four HD channels.

Audio Reshuffling

Mon, 01 Jan 0001 00:00:00 +0000

Audio Reshuffling #

The Audio Reshuffling transformation allows the content of audio channels to be mixed and matched in a variety of ways. This transformation is useful when you need to create various output versions of the same content, but with certain audio channels removed or rearranged.

Limitations #

Audio Reshuffling only supports transforming common video and audio streams. PIDs other than video and audio may be passed through but the behavior is undefined and may lead to unexpected results such as crashes and corrupted output data.

Back up a standalone appliance

Mon, 01 Jan 0001 00:00:00 +0000

How to back up a standalone appliance #

A standalone appliance keeps its inputs and outputs on the appliance itself. You can export them to a file, or restore them from a snapshot on the appliance.

Open the appliance’s web interface, sign in as an administrator, and go to Management > Standalone.

Export the configuration to a file #

Select Export configuration. The file contains stream passwords, such as SRT passphrases, so store it safely.

Configure WireGuard VPN

Mon, 01 Jan 0001 00:00:00 +0000

How to configure WireGuard VPN between two appliances #

This how-to walks through setting up an encrypted WireGuard VPN tunnel between two EdgeOS appliances so that traffic can flow securely between their networks.

1. Configure the appliances #

1.1 Open the VPN settings page #

In the appliance UI navigate to Network → VPN.

1.2 Enable WireGuard and configure the interface #

Toggle Enable WireGuard VPN on, then fill in:

Create a region

Mon, 01 Jan 0001 00:00:00 +0000

How to create an external region #

An external region lets you add video processing capacity outside your main Nimbra Edge cluster, for example at another site. First create the region in Network Manager, then install a Core Video Appliance on a Linux host at that site.

Before you start #

You need a superuser account in Network Manager and a Linux host that meets the video appliance requirements . Install Docker Engine on the host, and make sure you can run commands with sudo. The host must be able to reach your Nimbra Edge installation and exchange video traffic with the other appliances it will use.

Create an overlay

Mon, 01 Jan 0001 00:00:00 +0000

How to create a simple overlay #

This how-to guide will show you how to create a simple overlay in Nimbra Edge.

Background #

Overlays are added as part of a transformation pipeline in Nimbra Edge. This means the stream has to be decoded, transformed, and encoded again. It is only recommended to run transformations on video nodes with attached accelerators.

Create an overlay #

Navigate to ⚙ Settings → Production tools and click CREATE OVERLAY.

Delete a region

Mon, 01 Jan 0001 00:00:00 +0000

How to delete an external region #

Remove the video appliances before deleting their region. These steps apply to an external region with video appliances installed using the CLI tool. You need a superuser account in Network Manager and sudo access to each video host.

1. Move or stop the affected streams #

Check which inputs and outputs use the region. Move them to another region or stop them before continuing. Uninstalling an appliance interrupts any streams still using it.

Drain appliance

Mon, 01 Jan 0001 00:00:00 +0000

Drain appliance #

Drain appliance is the standard way to take a core appliance out of service for maintenance or decommissioning. It:

Reroutes every upstream input currently running through the appliance to another core appliance.
Marks the appliance as cordoned, so no new services can be scheduled on it.

Rerouting is best-effort and may briefly affect the video streams being moved. Drain applies to core appliances only.

Mon, 01 Jan 0001 00:00:00 +0000

How to enable managed HTTPS certificates in an existing cluster #

A managed certificate ensures you can securely access your Nimbra Edge installation without manually managing certificates.

This how-to assumes you have an existing cluster and would like to enable managed certificates. It applies to Kubernetes installations made with the Nimbra Edge installer; on Edge Core, enable managed certificates in the appliance’s web interface instead.

Otherwise, if you do not have a cluster, simply use the --managed-cert and --cert-email flags when running the installer.

Mon, 01 Jan 0001 00:00:00 +0000

How to enable Single Sign-On (SSO) in an existing cluster #

Single Sign-On (SSO) allows users to log in to Nimbra Edge using their existing identity provider. Nimbra Edge automatically onboards users and assigns their group and role based on their IdP group memberships, making it easy to manage access to the platform.

This how-to assumes you have an existing cluster and would like to enable SSO.

Prerequisites #

Nimbra Edge supports two SSO mechanisms: SAML and OIDC. This means your Identity Provider (IdP) must support one of these.

Fix public ip mapping alarm

Mon, 01 Jan 0001 00:00:00 +0000

How to fix public ip mapping alarm #

Address mappings are used to allow Nimbra Edge to connect to video and thumb appliances on a separate network, such as behind a NAT. See the address mapping explanation for more information.

This often happens when adding a new video or thumb appliance.

Adding an Address Mapping #

An address mapping is used by Nimbra Edge to determine how to reach the appliance. In the case of the thumb node Connect iT needs to know the public IP in order to fetch the thumbnails the thumb appliance has generated.

Frame-rate Conversion

Mon, 01 Jan 0001 00:00:00 +0000

Frame-rate Conversion #

The Frame-rate conversion transformation changes the frame rate of a video stream using motion-compensated interpolation (InSync FrameFormer). Unlike the frame-rate option of the Transcoding transformation, which drops or duplicates frames, motion compensation synthesizes intermediate frames so that motion stays smooth, for example when converting 50 fps content for a 59.94 fps distribution chain.

Video flow #

The derived input decodes the video, converts it to the target frame rate and re-encodes it. Audio and other PIDs pass through unchanged.

Mon, 01 Jan 0001 00:00:00 +0000

Nimbra 410 and 520 quickstart guide #

Overview #

This document is a quick start guide for Nimbra 410 and Nimbra 520

Intended Reader #

The guide is intended for service personnel performing hardware installation and maintenance, including initial software configuration.

Support and assistance #

If you have questions about how to use your equipment or software, and if you do not find the solution to your problem in this manual, please contact your local equipment and support supplier. For remaining questions, use https://netinsight.net/contact-us/

Install the Nimbra Edge NVIDIA prerequisites

Mon, 01 Jan 0001 00:00:00 +0000

How to install the Nimbra Edge NVIDIA prerequisites #

If you plan to run transcoding workloads on Nimbra Edge appliances using NVIDIA GPUs for acceleration, you will need to prepare the node with the necessary software prerequisites.

Intel GPU device plugin setup

Mon, 01 Jan 0001 00:00:00 +0000

Intel GPU device plugin setup #

Nimbra Edge uses the Intel GPU device plugin for Kubernetes to expose Intel GPU render devices to video pods. This is required when using --transcode-accelerator quicksync on Kubernetes deployments.

Prerequisites #

Kubernetes cluster with Intel GPU-equipped nodes
Intel GPU kernel driver (i915) loaded on the nodes

Installation #

Deploy the Intel GPU device plugin DaemonSet:

kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/nfd/overlays/node-feature-discovery
kubectl apply -k https://github.com/intel/intel-device-plugins-for-kubernetes/deployments/gpu_plugin/overlays/nfd_labeled_nodes

Alternatively, install via Helm:

Licenses and Nimbra Console

Mon, 01 Jan 0001 00:00:00 +0000

Licenses and Nimbra Console #

Nimbra Console at console.nimbra.io is where you manage your Net Insight licenses. You use it to allocate licenses to appliances and clusters, and to give your colleagues access.

What you can license #

There are three kinds of licenses:

Appliance licenses unlock features on a single Edge OS appliance, such as the operating system itself, video encoding and decoding, and ASI ports. See Appliance licenses for the full list.
Nimbra Edge licenses let you install and run Nimbra Edge. Each license has a license key that you enter when you install the software.
RTUs (rights to use) set how much a Nimbra Edge installation can use a service, such as outputs or transcoding. You buy RTUs for your organization and then divide them between your clusters.

How appliance licenses work #

Each appliance license belongs to one appliance, identified by its serial number. When you allocate a license to a serial number, Nimbra Console adds it to that appliance’s license file. The license file lists the features the appliance is licensed for. Each change gives the file a higher version number.

Migrate from NimOS to Edge OS

Mon, 01 Jan 0001 00:00:00 +0000

How to migrate from NimOS to Edge OS #

This document will guide you through the process of migrating a Net Insight Nimbra appliance that has previously been running NimOS to Edge OS.

Prerequisites #

A compatible appliance (Nimbra 414 revision B)
The appliance is already connected to Nimbra Edge and visible in the Appliances list
A release build of Nimbra Edge, R4.2.0 or later
A Super user, or an Admin user who owns the group the appliance belongs to
Internet connectivity for the appliance to download the migration tool from artifacts.nimbra.io

Limitations #

The migration tool is “best effort” meaning it might fail and leave the appliance in a broken state. If that happens, you may need physical access to reinstall Edge OS using a USB installer.
The migration is one-way meaning there is no supported path back to NimOS.
The migration tool will not preserve any existing configuration from NimOS other than what is listed below.

What gets migrated #

The migration copies over only the settings needed for the appliance to come back on the network and reconnect to Nimbra Edge:

MPTS Demux

Mon, 01 Jan 0001 00:00:00 +0000

MPTS Demux #

The MPTS Demux transformation enables demultiplexing a Multi-Program Transport Stream (MPTS) into its individual programs. This transformation is useful when you need to extract specific programs from a larger stream for further processing or distribution. It also enables basic modifications of PIDs in the stream.

Service filter #

The service filter allows you to select specific services (programs) from the MPTS for demultiplexing. Only specified services will be included in the output stream. All other services will be removed.

Nimbra Console roles

Mon, 01 Jan 0001 00:00:00 +0000

Nimbra Console roles #

Each Nimbra Console user has one of two roles in an organization. If you belong to several organizations, you can have a different role in each.

Task	Basic	Administrator
View appliances, clusters and licenses	Yes	Yes
Retrieve a Nimbra Edge license key	Yes	Yes
Copy or download an appliance license file	Yes	Yes
View standalone activation keys	Yes	Yes
View the users in the organization	Yes	Yes
Manage your own password and passkeys	Yes	Yes
Allocate appliance licenses	No	Yes
Allocate RTUs to a cluster	No	Yes
Invite users	No	Yes
Send a password reset to another user	No	Yes
Remove a user from the organization	No	Yes
View the audit log	No	Yes

Net Insight creates the first administrator account for your organization. After that, your administrators invite everyone else.

Nimbra Edge Connect

Mon, 01 Jan 0001 00:00:00 +0000

Install Nimbra Edge Connect on Linux #

Nimbra Edge Connect connects your local video sources and destinations to a Nimbra Edge installation. This guide is for administrators installing the software on their own Linux host. The CLI tool starts and configures its Docker containers for you.

Before you start #

You need:

A Linux host that meets the video appliance requirements , with Docker Engine installed.
Administrator access to the host (sudo).
A Network Manager admin account in the intended group, or a superuser account.
Docker Hub credentials supplied for your Nimbra Edge installation, if required to download its container images.

Use a dedicated host where possible. The CLI tool adjusts network buffers and CPU settings, and offers to configure Docker logging if it is not already configured. Applying the logging configuration can restart Docker and other containers on that host. Read the prompts before continuing.

Nimbra Edge RESTful API

Mon, 01 Jan 0001 00:00:00 +0000

Nimbra Edge RESTful API #

Overview #

Nimbra Edge allows for programmatic access via a RESTful API.

This document describes how to get started with the API and provides a few command line examples.

Getting Started #

Open API Specification #

Each Nimbra Edge release includes a bundled OAS (Open API Specification) JSON document called edge-open-api-specification.json.

This document is a good starting point to get familiar with the Nimbra Edge HTTP API as it describes all the available endpoints, which endpoints require authentication, the details of the parameters required to invoke each endpoint, such as the HTTP method, HTTP headers, path, query and body parameters, etc.

Overlay options

Mon, 01 Jan 0001 00:00:00 +0000

Overlay options #

This article lists the recommended usage of overlays and supported options in Nimbra Edge.

Usage #

Overlays are added as part of a Transcoding transformation with Video Transcoding enabled. The overlay is applied during the encoding stage of the transcoding process.

Overlay components #

Overlays are comprised of image and text components.

PID Remapping

Mon, 01 Jan 0001 00:00:00 +0000

PID Remapping #

The PID Remapping transformation enables manipulation of PIDs (Packet Identifiers) within a transport stream. This transformation allows you to remap PIDs to different values, drop unwanted PIDs, or filter out entire programs from the stream.

PID Remapping is an optional feature. To use it, select PID Remapping under Optional features in Settings → Global settings.

Program filter #

The program filter allows you to select specific programs to keep in the output stream. All other programs will be removed.

Reinstall Edge OS using USB

Mon, 01 Jan 0001 00:00:00 +0000

How to reinstall Edge OS using USB #

Purpose #

This guide describes how to reinstall Edge OS on a supported device using a USB installer drive.

If the appliance currently runs NimOS, use the migration workflow in Network Manager instead. This USB procedure is for reinstalling an appliance that already runs Edge OS or recovering from a failed migration.

Prerequisites #

A USB drive
A computer for writing the USB image
An Edge OS supported device (Nimbra 410, 414, 520)

Download the installer image #

Download the USB installer image from the artifact registry:

Requirements

Mon, 01 Jan 0001 00:00:00 +0000

Video appliance requirements #

Use these requirements when preparing a Linux machine to run a video appliance with the CLI tool. The machine can be a physical server or a virtual machine. For control-plane installation, follow the requirements in your deployment guide.

Operating system and Docker #

Use an AMD64 (x86-64) Linux host with Docker Engine. Docker Desktop is not supported for this deployment. Docker-hosted appliances still need Docker even when the Nimbra Edge control plane runs on Kubernetes.

Switch Edge OS between Edge Connect and Edge Core

Mon, 01 Jan 0001 00:00:00 +0000

How to switch an Edge OS appliance between Edge Connect and Edge Core #

Edge OS ships in two variants: Edge Connect (edge-connect, the streaming appliance that connects to a Nimbra Edge core) and Edge Core (edge-core, which runs the Nimbra Edge control plane on an embedded k3s). They are separate OS images with different disk layouts, so switching from one to the other is a reinstall, not a normal software update.

Transcoding

Mon, 01 Jan 0001 00:00:00 +0000

Transcoding #

The Transcode transformation enables changing format and properties of video and audio streams by decoding and re-encoding them. This enables standard conversions such as changing codec, resolution, bitrate and framerate, as well as adding overlays.

Limitations #

Transcoding only supports transforming common video and audio streams. PIDs other than video and audio may be passed through but the behavior is undefined and may lead to unexpected results such as crashes and corrupted output data.

Transcoding accelerators

Mon, 01 Jan 0001 00:00:00 +0000

Transcoding accelerators #

Supported accelerators #

Nimbra Edge supports various hardware accelerators for accelerating video transcoding. The available accelerators depend on the type of appliance.

Kubernetes video appliances #

Supported accelerators:

NVIDIA GPUs with driver version 570 or above
Intel QuickSync

Appliances installed with the `connectit` installer #

Supported accelerators:

NVIDIA GPUs with driver version 570 or above
NETINT Quadra T1U, T1A, T2A
Intel QuickSync

Encoding Capabilities #

The table below shows the encoding capabilities of the supported accelerators and CPU software encoding.

Transcoding options

Mon, 01 Jan 0001 00:00:00 +0000

Transcoding options #

This article lists the supported transcoding options in Nimbra Edge.

Limitations #

Transcoding only supports transforming common video and audio streams. PIDs other than video and audio may be passed through but the behavior is undefined and may lead to unexpected results such as crashes and corrupted output data.
Transcoding MPTS streams is not supported.
MPEG-TS PIDs will be reassigned during transcoding.

Video Transcoding #

Video Transcoding is ideally performed on an appliance with an attached accelerator. If no accelerator is available, or if the desired settings are incompatible with the available accelerator, transcoding will run on the CPU. Details on supported accelerators can be found on the Transcoding accelerators page.

Transformation profiles

Mon, 01 Jan 0001 00:00:00 +0000

Transformation profiles #

Transformation profiles allow saving a set of transformation parameters for use in multiple places. This enables setting a consistent format across many streams, and makes it easier to update the format in the future.

A transformation may either use a profile, or have its own custom parameters. Transformations using their own parameters can be easily exported into a profile.

graph TB P["Transformation Profile
'1080p H.265 Transcode'
Codec: H.265
Resolution: 1920x1080
Bitrate: 8 Mbps"] P --> S1["Stream 1
Synchronized"] P --> S2["Stream 2
Synchronized"] P --> S3["Stream 3
Not Synchronized
(Using previous parameters)"] P -.->|Can create| S4["New Stream"] style P fill:#e1f5ff style S1 fill:#d4edda style S2 fill:#d4edda style S3 fill:#fff3cd style S4 fill:#f0f0f0

Start on Nimbra Edge Documentation

1. Deploy Nimbra Edge

1. Deploy Nimbra Edge #

Launch the stack #

1. Prepare your cloud network

1. Prepare your cloud network #

Sign in to Nimbra Console

How to sign in to Nimbra Console #

Get an account #

2. Deploy Nimbra Edge

2. Deploy Nimbra Edge #

Launch the stack #

2. Install Nimbra Edge

2. Install Nimbra Edge #

Configure DNS #

Manage Nimbra Console users

How to manage Nimbra Console users #

Invite a user #

3. Deploy a Core appliance

3. Deploy a Core appliance #

3. Install Nimbra Edge

3. Install Nimbra Edge #

Configure DNS #

Configure Nimbra Edge #

Allocate appliance licenses

How to allocate licenses to an appliance #

Allocate from the appliance page #

4. Connect a Core appliance

4. Connect a Core appliance #

Create the region #

4. Deploy a Core appliance

4. Deploy a Core appliance #

Install an appliance license offline

How to install an appliance license offline #

Download the license file #

5. Connect a Core appliance

5. Connect a Core appliance #

Create the region #

5. Connect an Edge appliance

5. Connect an Edge appliance #

Enable standalone mode

How to enable standalone mode #

Before you start #

1. Get the activation key #

License your first appliance

License your first appliance #

Before you start #

1. Find your licenses #

6. Connect an Edge appliance

6. Connect an Edge appliance #

6. Send your first stream

6. Send your first stream #

Create a test input #

7. Send your first stream

7. Send your first stream #

Create a test input #

Switch a standalone appliance back to Nimbra Edge

How to switch a standalone appliance back to Nimbra Edge #

Apply a Nimbra Edge license key

How to apply a Nimbra Edge license key #

Get the license key #

Allocate RTUs to a cluster

How to allocate RTUs to a cluster #

Add RTUs to a cluster #

Releases

Releases #

Development builds #

Requirements

Requirements for Docker-based Nimbra Edge #

Upgrade

Upgrade Docker-based Nimbra Edge #

Deploy on an internal network

Deploying Docker-based Nimbra Edge on an internal network #

Migrate from Docker-based Nimbra Edge

Migrate from Docker-based Nimbra Edge #

0. Machine setup

0. Machine setup #

1. Install the CLI and dependencies

1. Installing the connectit CLI #

2. Install core