Skip to main content

Supra Server Management

Box provides a dedicated Supra tab on compatible devices that lets you install, monitor, and control the Supra Server without leaving the device detail page. In addition, a per-applet toggle in the Applets table allows you to enable or disable Supra rendering for individual timings.

Prerequisites

The Supra management UI is available only when all of the following conditions are met:

ConditionDetail
Feature entitlementThe organization must have the Supra On-Premise feature entitlement enabled.
Linux Ubuntu 24The device must be a Linux device running Ubuntu 24.x.
Custom Scripts capabilityThe device must report CUSTOM_SCRIPTS in its management capabilities.

If any condition is not met, the Supra tab will not appear on the device detail page.

Supra Tab

Navigate to Device Detail → Supra to access the management interface. The tab is split into several sections described below.

Info Box

An informational banner at the top of the tab provides a brief description of Supra and a link to the full documentation.

Status

Displays the current installation status of the Supra Server on the device:

  • Installed — the supra-server-daemon package is detected in the device's installed-packages telemetry.
  • Not Installed — the package has not been detected yet.

Location

Shows the Location assigned to the device, including:

  • Location name
  • Custom ID (if set)
  • Address (if geocoded)

If no Location is assigned, a warning is displayed. All client devices connected to the same Location will automatically use this Supra Server for remote rendering.

Actions

Four action buttons are available. Each action executes a Custom Script on the device:

ActionCustom ScriptAvailable When
Install Suprasupra-server-install-serverSupra is not installed
Uninstall Suprasupra-server-uninstall-serverSupra is installed
Restart Serversupra-server-restart-serverSupra is installed
Restart Screenssupra-server-restart-screensSupra is installed

The scripts are resolved from the organization's Custom Scripts matching the device platform. The latest available version of each script is executed automatically.

info

The Custom Scripts used for Supra management are provisioned automatically when the Supra On-Premise feature entitlement is enabled for the organization.

Connected Clients

When the Supra Server is installed and a Location is assigned, a Clients table lists every device in the same Location (excluding the Supra Server itself). For each client device the table shows:

ColumnDescription
PlatformDevice platform icon (Tizen, Android, Linux, etc.)
NameDevice name with a link to the device detail page
AppletName of the applet in the client's active timing
Applet VersionVersion of the active applet
StatusWhether Supra mode is active (supra: enabled in timing configuration)
ActionA Refresh button that sends an APPLET_REFRESH power action to the client device

Client Count

A summary card next to the Status and Location cards shows the number of clients in the Location that currently have Supra mode enabled versus the total number of client devices.

Monitoring

A placeholder section for built-in monitoring. The Supra Server monitoring (Grafana-based) can be installed using the supra-server-install-monitoring Custom Script and accessed at http://<supra-server-ip>:3000.

Supra Status Toggle (Applets Table)

When the Supra On-Premise feature entitlement is active for the organization, an additional Supra column appears in the Applets table on the device detail page.

Each timing row shows a toggle switch:

  • On — sets supra: enabled in the timing configuration, which activates Supra rendering for that applet.
  • Off — removes the supra key from the timing configuration, returning the applet to normal local rendering.
warning

After toggling Supra mode, the affected client devices may need to restart their applet for the change to take effect.