BUG

Broadcast Universal Gateway

BUG Deploy Documentation

BUG is a web-based system for controlling and monitoring broadcast and media equipment from a single interface.

Run BUG on a server within your network and access it through a browser. From one web page, you can add panels to control and observe a wide range of devices and services — including network switches, video and audio codecs, video matrices, and more.

BUG Home Screenshot

Getting started

  • Installation — Install BUG on any supported operating system
  • Modules — See which devices and services can be controlled, and what functionality is available

Component Library

View the BUG component library (React components, panels, and UI elements) in Storybook.

API Documentation

We use Swagger to document our core API, allowing control and visibility of every aspect of your BUG system. This can be viewed on any BUG installation at http://yourlocalip/api/documentation

Development

BUG is designed to be extended. We welcome development of additional modules that add new control or monitoring capabilities.

A module typically represents a specific piece of hardware or service. For example:

  • a module for controlling Blackmagic Videohub matrices
  • a module for monitoring a NewTek NDI discovery service

Each module can be instantiated one or more times as panels within the BUG interface, allowing multiple devices of the same type to be controlled simultaneously.

To learn more about developing your own modules, see:

Changelogs

  • The BUG application changelog is stored in the GitHub repo.
  • Module changelogs are stored inside their module folder in the repo, and built into the documentation.

Open source

BUG is one of many open source projects developed at the BBC.
Explore the full catalogue at https://www.bbc.co.uk/opensource/.