BrightSign Registry Keys

volume

Defaults to “logarithmic”, but can be set to “linear” to make the audio volume curve act the same as Series 4 and earlier players.

Either linear or logarithmic



splash

Controls whether the splash screen is shown.

If set to "0", the splash screen is not displayed, otherwise it is shown.

OS

debug

Enables/disables BrightScript debugging (you can also enable this at the Brightsign> prompt by typing "script debug on")

"1" turns on BrightScript debugging.

OS

obfuscation_key

Allows you to use an alternative obfuscation key.



OS

disable-http-cache

Some customers with web apps that make many XHR requests find that due to Chromium's caching design many small files are created in the Chromium cache directory, even when a storage quota is set. This key will prevent that at the cost of a small performance reduction. Available from BOS 8.5.62, 9.0.190, and 9.1.15.

"1" disables http caching in Chromium.

OS

disable-hw-accelerated-video-decode

Disable support for hardware accelerated decode. Only Series 5 and later players support hardware accelerated decode.

"1" disables support for hw accelerated video decode in Chromium when "use-brightsign-media-player = 0".

OS

disable-web-security

With BOS 8.2 and later (Chromium69 and later), several new CORS checks have been added. This lets you disable checks.

"1" disables checks. This flag will take effect on all roHtmlWidget instances.

OS

enable-virtual-keyboard

Enables the OS built-in virtual keyboard, which is an alternative to html virtual keyboard for simpler applications. The OS built-in virtual keyboard has no customization options but it doesn’t require any script changes or plugins.

"1" enables the virtual keyboard



enable_web_inspector

Allows the roHtmlWidget web Inspector to be enabled. On BOS 8.5.31 and newer, you must enable the inspector via this key and the roHtmlWidget config.

Possible values are "1" or "0"

Written by the supervisor or customer, read by the OS

insecure_private_network_access

Disables the security checks when a public website tries to access resources on the local network (PNA, PrivateNetworkAccess). Available in BOS 9.1.116 +

Possible values are "1" or "0"

This is only valid for Chromium 120 (i.e. 9.1) and it is used to disable all PNA enforcement stages. This setting was not carried over to 10.0 for Chromium 148 as newer Chromium no longer blocks PAN.



js-trace-gc



Pass --trace-gc in --js-flags

OS

js-trace-fragmentation



Pass --trace-fragmentation in --js-flags

OS

js-trace-gc-ignore-scavenger



Pass --trace-gc-ignore-scavenfer in --js-flags

OS

js-trace-gc-verbose



Pass --trace-gc-verbose in --js-flags

OS

mse-support

Enables MSE support on Series 3 players

"1" turns on MSE support on Series 3 players. Series 4 players enable it by default when running BOS 8.3+. It is ignored on Series 5 players if the built-in player is enabled.

OS

mpm

Enable or disable the Memory Pressure Monitor

"1" enables MPM

OS

overlay-scrollbar

Set scrollbar style

"1" sets to touch-friendly mode, otherwise as desktop

OS

process-per-tab

Set --process-per-tab rather than --process-per-site-instance which is the default

“1” sets --process-per-tab rather than --process-per-site-instance (the default)

OS

tracecategories

Chromium trace control



OS

traceduration

Chromium trace capture time in seconds



OS

tracemaxsnapshots

Chromium trace maximum snapshots



OS

tracememorymaps

Enable memory bench marking

"1" enables bench marking

OS

tracemonitorinterval

Chromium trace monitor interval in seconds.

Must be > 30, or zero/missing to disable.

OS

use-brightsign-media-player

Disables MPV. The Chromium media player will be used instead and players will have hardware accelerated video decode inside HTML. Only Series 5 and later players support hardware accelerated decode.

"use-brightsign-media-player = 0" disables mpv

OS

web_inspector_address

When a player has multiple network interfaces (e.g., USB ethernet, ethernet port, or Wi-Fi), you can enable the inspector on one interface by specifying its IP address. This allows safe inspector activation using a “control” port. Available in BOS 9.1.121 and later.





web_inspector_port

Allows the web inspector port to be changed from the default value of 2999





webaudio-support

Report web audio as enabled by default. Web audio support is incomplete; this option allows an appropriate report to be made depending on the application.

When present, this parameter must be "1" for web audio to be reported as enabled.

OS

webgl_antialiasing_enabled

Enables WebGL anti-aliasing

"1" enables WebGL anti-aliasing

OS

widget_type

Changes the browser engine used for roHtmlWidget. Currently only valid for Series 5.

BOS 9.0.126 to 9.0.145.1 allow electron or qtwebengine values. In 9.0.145.1+, electron is deprecated and replaced with chromium110, which sets the Chromium version to Chromium120.



cdr

A boolean value as to whether the content downloads should be restricted.



setup script and presentation autorun

cdrl

The length of time for the content download (this key and cdrs, below, create a window of time)



setup script and presentation autorun

cdrs

The start time for the content download (this key and cdrl, above, create a window of time)



setup script and presentation autorun

curl_debug

Turns on debug output whenever the OS uses curl. It can be very verbose and fill up logs quickly.

“1” turns on debug output whenever the OS uses curl.

OS

dwse

Enables/disables the local DWS

“yes” enables, “no” disables the local DWS

Supervisor, setup script

ele

A boolean value denoting if event logging should be enabled



Supervisor, setup script, presentation autorun

enable_http_redirect

If set to false, external requests to HTTP will be processed normally instead of redirected





enableremotesnapshot

A boolean value denoting if remote snapshot is enabled



setup script, presentation autorun

force_igmp_version

Allows customization of the player response to the IGMP network environment. See IGMP BehaviorIGMP Behavior





http_server

Lets you run the DWS on the standard port. See here.



OS and supervisor

isc

Set the color for the splash screen



Setup script, presentation autorun

ldws_certs_path

Available in BOS 8.5.64 and higher, this key can be used to provide the folder path to certs, which can be in any storage folder location

Example values are /storage/ssd, /storage/usb, /storage/flash



ple

A boolean value denoting if playback logging should be enabled or not



Supervisor, setup script, presentation autorun

prometheus-node-exporter-port

By default, node_exporter binds to localhost:9100 only to enable metrics collection – this will happen if the key is unset or with any setting other than an explicit disable. This setting is available in BOS 9.0.144 and above.

"-" explicitly disables node_exporter. If the value is set to an integer usable as a port number (1025 to 65535, with 9100 being the conventional port) , node_exporter metrics will be available on all external interfaces on that port number. Port numbers < 1025 will prevent the binding of node_exporter to external adapters and an error message will be logged. However, the service will be bound to localhost:9100.

Supervisor, monitoring

ptp_domain

PTP clocks are turned off by default, this command lets you turn them on.

To turn on PTP clocks (substitute the domain-reserved PTP address number): registry write networking ptp_domain <# between 0 - 127> reboot

OS

rdwse

A boolean flag which tells you if rDWS is enabled or not.

A value of “true” means that the rDWS is enabled. This is the default value.

Supervisor

recurl

URL to which "/Recovery.ashx" is appended if the previous registry entry is not present.

If ''[networking]recover'' or ''[networking]ru'' keys exists then the recovery URL is the contents of that registry key. Otherwise if ''[networking]recurl'' exists, the recovery URL is the contents of that registry key with ''"/Recovery.ashx"'' appended.



remotesnapshotinterval

If remoteshapshot is enabled, use this to set the interval at which the remote snapshot should be taken



Setup script, presentation autorun

remotesnapshotjpegqualitylevel

If remoteshapshot is enabled, use this to set the quality level at which the remote snapshot should be taken.

The quality level is a number.

Setup script, presentation autorun

remotesnapshotmaximages

If remoteshapshot is enabled, use this to set the maximum number of images that should be taken. Older images will be deleted.



Setup script, presentation autorun

remotesnapshotorientation

If remoteshapshot is enabled, use this to set portrait or landscape orientation.



Setup script, presentation autorun

rollback_enabled

A boolean value indicating if the rollback feature should be enabled or not.

A value of “False” disables rollback (which is enabled by default)

Supervisor

rs

After the OS calls the recovery handler, one of recovery_reinstall_noreformat.bas and recovery_reinstall.bas will be returned. This is used in both files as a URL to download the recovery script.



Recovery BrightScript

rtl8821_disable_ht

Disables or enables HT on Realtek WiFi (WS103). This requires BOS 8.1.70 or higher.

Set this value to “1” to disable HT on Realtek WiFi (WS103); other values means enabled.

OS

rtl8821_disable_vht

Disables or enables VHT on Realtek WiFi (WS103). This requires BOS 8.1.70 or higher.

Set this value to “1” to disable VHT on Realtek WiFi (WS103); other values mean enabled.

OS

ru

A URL used by system software to download a script to be executed in the event of recovery. If this key exists, the recovery URL is the contents of the key.



OS

serial_with_telnet

Enables serial over telnet. By default, enabling BrightSign-level telnet or ssh will disable the serial console. The first serial port can still be used by scripts for communication with other devices; it just stops being usable as a console but if kernel console output is enabled then that will still be visible on the first serial port.

A value of ''1'' enables serial console at the same time as telnet. Note that serial communication via roSerialPort in scripts will be highly unreliable. To set the password: ifconfig login-password my-top-secret-password

OS

sip

The static IP address for either the ethernet or WiFi interface



Supervisor, setup script, presentation autorun

sip2

The static IP address for either the ethernet or WiFi interface (sip2 denotes the interface with the lower priority)



Supervisor, setup script, presentation autorun

status_handler_duration

The interval to report status



Supervisor

ssh

Enables ssh access. A reboot is required for this to take effect but DO NOT DO THIS UNTIL YOU HAVE SET A PASSWORD!

To enable ssh access, set the key to the ssh port (the default ssh port is 22). For example: registry write networking ssh 22 To disable ssh access, delete the key (the player must reboot for this to take effect). For example:  registry delete networking ssh

OS

subnetmask_vlan_'+id

The subnet mask for the static configuration of the VLAN interface. Id suffix refers to VLAN id.



Supervisor

syslog

Configures remote logging. See roSystemLog.



OS

telnet

Enables or deletes telnet access.

To enable telnet access set this key to the port you wish to run telnet on (the default telnet port is 23).  Delete the key to disable telnet access.

OS

telnet_server

Enables Telnet access to the Linux shell prompt on players that have had secure boot disabled or are booting without verification. You can enable this feature along with BrightSign-level Telnet if they run on different ports.

Set this registry key to the port you wish to run telnet on. For example: registry write networking telnet_server 23

OS

twf

Tells you if text feeds data type is enabled over the WiFi interface

A boolean value



twr

Tells you if text feeds data type is enabled over the ethernet interface

A boolean value



tz

The device time zone





ub

A URL prefix which is applied to all URLs that follow if they do not contain a colon.

This value is the URL prefix to apply.



vu

Events are reported to this URL



OS

wifi

Indicates if WiFi is enabled on the player or not

A boolean value

Supervisor, setup script, presentation autorun

wired_debug

Enable verbose diagnostics on the ethernet interface



OS

usb_first

LS3 and LS4 players don't have a dedicated serial port, but have several ways to send and receive serial data depending on the cable in use. Two types of cable can be used: a "passive serial splitter" or a "genuine USB serial adapter", which can be set with this key.

“[usb]type_c_serial” or “[serial]usb_first”, with the right port number, set the cable value to either "passive serial splitter" or a "genuine USB serial adapter". A “usb_first” value only affects serial ports opened by BrightScript and JavaScript, not the console.

OS

hotplug_tty:106c:3718:1.0

Supports Pantech UML290 modems. Note that there is a generic "hotplug_tty" mechanism, this is just an example.

The appended numbers are modem keys reflecting product ID, vendor ID, and interface number. The settings numbers are visible in /sys/bus/usb/devices when the modem is plugged in.

OS

hotplug_tty:12d1:155e:1.0

Supports Huawei E3531 / E3372 modems

The appended numbers are modem keys reflecting product ID, vendor ID, and interface number. The settings numbers are visible in /sys/bus/usb/devices when the modem is plugged in.

OS

type_c_serial

LS3 and LS4 players don't have a dedicated serial port, but have several ways to send and receive serial data, depending on the cable in use. This registry setting is only required when using a passive serial cable (like the ones that BrightSign makes with a USB type A socket and a 3.5mm socket) and not when using a USB serial adapter.

The cable type: "passive serial splitter" or a "genuine USB serial adapter"

OS

auto_mode_vms_override

Overrides the “Auto” video mode and allows multi-output or other video modes to be configured for the player outside a CMS app. When a video mode is set to “Auto”, or not specified by a script, the player should see if a specific mode is set in the public registry. If it finds a valid video mode there, it should apply it instead of negotiating a mode using the EDID provided by the sync.

Example values would be:

auto_mode_vms_override -> "{"HDMI-1":{"mode":"1920x1080x60p","transform":"normal","x":0,"y":0}}"



gpu_sync

Available only in BOS versions 9.0.168 to 9.0.189, this alleviates artifacts and/or frame corruption when content goes through the GPU. It will affect HS5, LS5, MX5, HD5, and XD5 players, but is ignored on XT5, XC5, and Series 4 players. This setting comes with a performance hit.

Setting the value to 1 enables a workaround artifacts and/or frame corruption when content goes through the GPU