Agent Installation

Quick Start

• Enable Register Without Token in the Broadcast Suite settings
• Download the agent from the About page.
• Run the installer
• Click Install
• Disable Register Without Token in the Broadcast Suite settings when you are done

Installation

The Broadcast Suite Agent can be installed on a Windows PC.

Download

The newest version of the agent can be downloaded from the About page or from here (under Assets on the right side).

Agent Installer

The agent installer installs the agent on the PC.

Same Subnet

When the agent and the core operate within the same subnet, the agent will automatically discover the core. When Register Without Token is enabled, no further configuration is required.

Different Subnet

If the agent and the core are not in the same subnet, the core connection data must be configured.
This can be done by providing the necessary information during installation. When downloading the installer over the About page, the AgentConfig.txt file contains the necessary information.

Alternatively, if no data is entere during installation, it must be added later by modifying the appsettings.system.json file.

Installer Config File

The installer supports automated configuration using an optional AgentConfig.txt file. If this file is present during installation, the installer will read and apply the core connection settings from it. After the installation, the AgentConfig.txt is no longer used and can be safely deleted.

This makes it easy to set up the agent on multiple machines without any manual input during installation.
The AgentConfig.txt file is automatically downloaded along with the agent when downloading from the About page. You can then reuse the same file on other systems to ensure a consistent configuration.

Installer Startup Arguments

The agent installer is built with Inno Setup, so all standard Inno Setup command-line arguments are supported. This allows for silent installation, custom configuration, and automation.

Start the Agent

After the installation, the agent automatically performs the following steps to discover the core and register itself to it.

Discovery Process

If the agent was installed using the AgentConfig.txt file, the discovery section can be skipped.

Same Subnet

When the agent and the core operate within the same subnet, the installation process is simple and requires no manual configuration if the correct agent settings are in place.
Required agent settings:

• Register Without Token
• Agent Discovery Server
• Agent Discovery Server UDP Port

When Agent Discovery Server is activated, the core becomes capable of receiving a UDP broadcast from the agent. Subsequently, upon receipt of the broadcast, the core responds by providing its host name and the Core gRPC Listen Port to the agent.

The agent then stores this information into the appsettings.system.json file.

Different Subnet

If the agent and the core are not in the same subnet, the core connection data must be configured manually in the appsettings.system.json file.

Register Process

Without Register Token

When Register Without Token is enabled, the agent can effortlessly register itself with the core via gRPC.

With Register Token

When Register Without Token is disabled, the Global Register Token must be provided during installation or set manually in the appsettings.system.json file.

Upon successful registration, the core creates a new agent device which is immediately accessible within the devices index.

When You Are Done

As soon as all agents are registered, we recommend disabling the following agent settings.

• Register Without Token
• Agent Discovery Server