Settings

If this node is in a cluster, then the settings with the Sync flag will be synchronized.

↻ = Requires reload config

General

The general settings

General

Name	Description	Default Value	↻	Sync
Node Name	Name of this node	SLG Broadcast Suite
Node Location	Location of this node

Technical

Name	Description	Default Value	↻	Sync
Supervisor Node		False
Staging Node		False
Default Node State	The default node state when this node is not in a cluster or the node state is not set by a cluster	Primary	✔️

System

Core

The core settings

General

Name	Description	Default Value	↻	Sync
Core IP-Address or Hostname	Address on which the Core API should be available	127.0.0.1	✔️
Core API Listen Port	Port on which the Core API should be available	8085	✔️
Core gRPC Listen Port	Required for distributed triggers, communication with web panels and communication with the agent	8086	✔️
Core gRPC Wasm Listen Port	Required for communication with web panels running on a WebAssembly (Wasm) client.	8088	✔️

Startup & Shutdown

Name	Description	Default Value	↻	Sync
Startup Actions	List of actions which will be executed during startup. The actions are not executed when "Apply Config" or "Reload Config" is performed. Comma-separated Actions UUID's		✔️	✔️
Shutdown Actions	List of actions which will be executed during shutdown. The actions are not executed when "Apply Config" or "Reload Config" is performed. Comma-separated Actions UUID's		✔️	✔️

Paths

Name	Description	Default Value	↻	Sync
Shell Path		/bin/bash	✔️	✔️

Technical

Name	Description	Default Value	↻	Sync
Default Pulse Duration	Length of a pulse. Is used when pulse is enabled and its duration is not set or 0 (affects actions and triggers). In milliseconds	250		✔️

GUI

The Gui settings

General

Name	Description	Default Value	↻	Sync
External URL		http://127.0.0.1:5000		✔️
Header Color

Login

Name	Description	Default Value	↻	Sync
Show Login Message	If enabled, the login message is shown	False		✔️
Login Message	Message which is shown on the login screen Supports HTML			✔️

Dashboard

Name	Description	Default Value	↻	Sync
Dashboard Refresh Interval	In seconds (Use 0 to disable)	30		✔️

Announcement Banner

Name	Description	Default Value	↻	Sync
Enabled		False		✔️
Announcement Text	Supports HTML			✔️

WebAssembly (Wasm)

info

WebAssembly (Wasm) enables a panel to run directly in the browser, which reduces the load on the server.

Name	Description	Default Value	↻	Sync
WebAssembly Enabled	Enable WebAssembly (Wasm) Requires a full restart of all projects (API, Core, and GUI) to take effect	False	✔️	✔️
Wasm Log Level	The log level for Wasm clients	Info		✔️

Technical

Name	Description	Default Value	↻	Sync
Store Index Search Value	If enabled, the search value on the index pages will persist even if the page is reloaded.	True		✔️

Database

The Database settings

Backup

Name	Description	Default Value	↻	Sync
Backup Path
PostgreSQL Binary Folder	Database backups require pg_dump Path to bin folder
Create Daily Backups		False	✔️	✔️
Backup Type	Check the documentation for more information	Full		✔️
Backup Time		01:10:00	✔️	✔️

Maintenance

Name	Description	Default Value	↻	Sync
Maintenance Time	Daily database maintenance job	01:40:00	✔️	✔️
Maintenance Timeout	Daily database maintenance job timeout In minutes	30	✔️	✔️

Data Retention

Here you can set how long data should be kept and at what time they should be deleted.

General

Name	Description	Default Value	↻	Sync
Deleted Models Retention Days	Affected entries: Deleted Actions, Devices, Events, Triggers, Panels	30	✔️	✔️
Deleted Models Purge Time	Time when the entries will be purged	02:10:00	✔️	✔️
User Token Retention Days	Affected entries: User Token	30	✔️	✔️
User Tokens Purge Time	Time when the entries will be purged	02:15:00	✔️	✔️
Backups Retention Days	Affected entries: Backup Files	30	✔️	✔️
Backups Purge Time	Time when the entries will be purged	01:10:00	✔️	✔️
Audit Trail Retention Days	Affected entries: Audit Trail	365	✔️	✔️
Audit Trail Purge Time	Time when the entries will be purged	02:20:00	✔️	✔️
List Filter Purge Time	Time when the entries will be purged	02:40:00	✔️	✔️
Audio Recordings Retention Days	Affected entries: Audio Recordings	7	✔️	✔️
Audio Recordings Purge Time	Time when the entries will be purged	01:40:00	✔️	✔️
System Alerts Retention Days	Affected entries: System Alerts	90	✔️	✔️
System Alerts Purge Time	Time when the entries will be purged	02:45:00	✔️	✔️

History

Name	Description	Default Value	↻	Sync
System History Retention Days	Affected entries: Runtime, Statistic	30	✔️	✔️
System History Purge Time	Time when the entries will be purged	02:50:00	✔️	✔️
Item History Retention Days	Affected entries: Action, Device, Event, Trigger	30	✔️	✔️
Item History Purge Time	Time when the entries will be purged	02:55:00	✔️	✔️
RMON History Retention Days	Affected entries: RMON	30	✔️	✔️
RMON History Purge Time	Time when the entries will be purged	03:10:00	✔️	✔️
SFlow History Retention Days	Affected entries: SFlow	30	✔️	✔️
SFlow History Purge Time	Time when the entries will be purged	03:20:00	✔️	✔️
Syslog History Retention Days	Affected entries: Syslog	30	✔️	✔️
Syslog History Purge Time	Time when the entries will be purged	03:40:00	✔️	✔️
Sync Log Retention Days	Affected entries: Sync Log	30	✔️	✔️
Sync Log Purge Time	Time when the entries will be purged	03:50:00	✔️	✔️
Log File Retention Days	Affected entries: Core, API, GUI	30	✔️	✔️

Proxy

The Proxy settings

Name	Description	Default Value	↻	Sync
Use Proxy Server		False	✔️	✔️
Bypass Proxy for Local Addresses		False	✔️	✔️
Address	Proxy server address IP or hostname, must start with http:// or https://		✔️	✔️
Port		80	✔️	✔️
Username	If a username is set, proxy authentication is being used		✔️	✔️
Password	Password for proxy authentication		✔️	✔️

Trigger

The trigger settings

General

Name	Description	Default Value	↻	Sync
Default Switch-on Time	In seconds	0		✔️
Default Switch-Off Time	In seconds	0		✔️

File Reader

Name	Description	Default Value	↻	Sync
File Reader Trigger Max File Size	Max file size for read mode "All Lines" In kilobytes	8		✔️

Action

Settings for actions

Name	Description	Default Value	↻	Sync
Execute as Primary Only Default Value	This value is used as default for new actions	False		✔️
Force Execute as Primary Only	If this value is set to true, all actions are executed only if they run on a primary node. The value on the actions itself is ignored.	False		✔️

Audit Trail

The audit trail settings

Core

Name	Description	Default Value	↻	Sync
Enable Audit Trail for Core		True		✔️
Log Create Events		True		✔️
Log Edit Events		True		✔️
Log Delete Events		True		✔️

GUI

Name	Description	Default Value	↻	Sync
Enable Audit Trail for GUI		True		✔️
Log Create Events		True		✔️
Log Edit Events		True		✔️
Log Delete Events		True		✔️

API

Name	Description	Default Value	↻	Sync
Enable Audit Trail for API		True		✔️
Log Create Events		True		✔️
Log Edit Events		True		✔️
Log Delete Events		True		✔️

API Keys

These settings are used to define various API keys.

Infomaniak

Name	Description	Default Value	↻	Sync
Infomaniak Product ID	Infomaniak AI Product ID Required for WhatsApp media transcription		✔️	✔️
Infomaniak API Token	Required for WhatsApp media transcription		✔️	✔️

Telegram

Name	Description	Default Value	↻	Sync
Telegram API Key	Required for the Telegram Notification Action		✔️	✔️

Twilio

Name	Description	Default Value	↻	Sync
Twilio API Key SID	Twilio API Key SID. Will be used as username. Can be found under: Account/Keys & Credentials/API keys & tokens Required for the SMS Action		✔️	✔️
Twilio API Key SID Secret	Twilio API Key SID KeySecret. Will be used as password. Can be found under: Account/Keys & Credentials/API keys & tokens Required for the SMS Action		✔️	✔️
Twilio Account SID	Twilio Account SID. Can be found under: Account/Keys & Credentials/API keys & tokens Required for the SMS Action		✔️	✔️
Twilio Messaging Service SID	Twilio Messaging Services SID. Can be found under: Develop/Messaging/Services Required for the SMS Action		✔️	✔️

Auphonic

Name	Description	Default Value	↻	Sync
Auphonic API Key	Auphonic API Key Can be found under: Account/API Keys on auphonic.com Required for the Audio Processing Action		✔️	✔️

Security

Authorization

The Authorization settings

Name	Description	Default Value	↻	Sync
Password Required Length	The minimum length a password must be	4		✔️
Password Required Unique Chars	The minimum number of unique characters which a password must contain	1		✔️
Password Require Non Alphanumeric	Passwords must contain a non-alphanumeric character	False		✔️
Password Require Digit	Passwords must contain a digit	False		✔️
Password Require Lowercase	Passwords must contain a lower case ASCII character	False		✔️
Password Require Uppercase	Passwords must contain a upper case ASCII character	False		✔️
Use Password History	Prevent the user to reuse an old password	False		✔️
Password History Count	Count of old passwords	5		✔️
Use Password Expiration	Force users to change the password	False		✔️
Password Expiration Days	Number of days until the password must be changed. Only for authentication type System	90		✔️
User Lockout on Failure	Lock the user account if sign in fails multiple times	False		✔️
Lockout Time	Time a user is locked out for when a lockout occurs In minutes | 0 = forever	5		✔️
Max Failed Access Attempts	The number of failed access attempts allowed before a user is locked out	5		✔️

Authentication

The Authentication settings

Name	Description	Default Value	↻	Sync
Enable LDAP for Authentication	Enable this to allow the users to login with LDAP	False		✔️
LDAP Server	The LDAP server hostname			✔️
LDAP Port	The LDAP server port	389		✔️

HTTPS

The TLS certificate settings

info

The TLS certificate is used for Core, API and GUI. If you distribute those modules on different servers or use a containerized environment, please use a reverse proxy for TLS.

Name	Description	Default Value	↻	Sync
Enable TLS	If enabled, the communication between Core, API and GUI is encrypted	False	✔️
TLS Certificate Path	Local path to the .pfx certificate	broadcastsuite.pfx	✔️
TLS Certificate Password			✔️

Protocols

E-Mail

These settings are used by the E-Mail action to send e-mails via SMTP.

SMTP Server

Name	Description	Default Value	↻	Sync
From Address	Address to be used as sender for the e-mail		✔️	✔️
From Name	Name to be used as sender for the e-mail		✔️	✔️
Username	Username to authenticate to the SMTP server		✔️	✔️
Password	Password to authenticate to the SMTP server		✔️	✔️
SMTP Server	Server address		✔️	✔️
SMTP Port	Server port	25	✔️	✔️
Use SSL		False	✔️	✔️
Allow Untrusted Certificates	If enabled, untrusted / self-signed certificates are accepted	False	✔️	✔️
Timeout	In seconds	30	✔️	✔️

E-Mail Template

Name	Description	Default Value	↻	Sync
Header Template	Header template for HTML e-mails			✔️
Footer Template	Footer template for HTML e-mails			✔️

Ember+

The EmberPlus settings

Name	Description	Default Value	↻	Sync
Enable Ember+ Provider	If disabled, the Ember+ Provider will never be initialized	True	✔️	✔️
Provider Listen Port	Listen port of Ember+ provider	9000	✔️	✔️
Use Categories in Ember+ Tree	If enabled, the items are grouped by to category	True	✔️	✔️
Sort by Sequence Number	If enabled, the items are sorted by sequence number rather than alphabetically	False	✔️	✔️
GetDirectory Retries		5	✔️	✔️
Send Timeout	Use -1 to disable the send timeout In milliseconds	30000	✔️	✔️
Maximum Age for Queued Messages	Entries in the send queue older than this are discarded In milliseconds	30000	✔️	✔️

SNMP

The Snmp settings

Name	Description	Default Value	↻	Sync
Get Community	Default SNMP Read Community	public		✔️
Set Community	Default SNMP Write Community	public		✔️

Syslog

The Syslog settings

Name	Description	Default Value	↻	Sync
Initialize Always	If enabled, the Syslog collector will always be initialized	False	✔️	✔️
Forward Address	Separate multiple addresses by comma		✔️	✔️
Forward Only	Do not store Syslog messages in database	False	✔️	✔️

Add-Ons

Agent

Agent settings.

Download

Name	Description	Default Value	↻	Sync
Public Download Page	If activated, the agent download page can be accessed without a login	False		✔️

Registration

Name	Description	Default Value	↻	Sync
Register Without Token	If activated, new agents can register with Broadcast Suite without a token. This is useful for setting up all agents initially. We recommend deactivating this setting again as soon as all agents have been set up.	False		✔️
Global Register Token	A globally valid register token can be stored here. This token can be used, for example, if Register Without Token is deactivated.			✔️
Agent Discovery Server	If activated, the Broadcast Suite Core starts a UDP server, which waits for requests from agents. This server enables the agent to be installed on a client without any configuration (if Register Without Token is activated). This means that the Broadcast Suite Core host name does not have to be configured in agent appsettings.json file. The agent sends a UDP broadcast when it starts. If the Broadcast Suite Core and agent are in the same subnet, the core sends back all the required information.	False	✔️	✔️
Agent Discovery Server UDP Port	The UDP port for the Agent Discovery Server. If the default port is changed, the agent appsettings.json file on the agent must be adapted.	8087	✔️	✔️

Technical

Name	Description	Default Value	↻	Sync
Action Execution Timeout	When the core executes an action on an agent, the core waits for the timeout set here until it sets the status of the action to Execution failed if no response is received from the agent. In seconds	10		✔️
Agent Ping Interval	The interval at which the agent should ping the Broadcast Suite Core. The ping acts as a keep alive between the agent and the core. The core requires this ping to be able to display the device status of the agent device. The agent requires the response of the ping in order to be informed about changed settings. For example, if this interval or Agent Log File Retention Days has changed. In seconds	15		✔️
Agent Log File Retention Days	The maximum amount of days how long the log files should be kept. In days	30		✔️

info

Requires the Agent add-on.

Audio

Audio settings.

General

Name	Description	Default Value	↻	Sync
FFmpeg Path	Path the FFmpeg binary	ffmpeg	✔️	✔️
Audio Recording Path	Path for audio recordings. Will be purged regularly according to the purge settings.	C:\ProgramData\SLG Broadcast Suite\Audio		✔️
Audio Recording Length	Create a new file after the configured amount of minutes. In minutes	30		✔️

WebRTC

info

WebRTC requires HTTPS. The TLS certificate can be configured in the HTTPS settings section.

Name	Description	Default Value	↻	Sync
Enable WebRTC	Enable WebRTC for audio inputs	True	✔️	✔️
Listen Port		30001	✔️	✔️
Public IP-Address or Hostname			✔️	✔️
Public Port		30001	✔️	✔️
STUN Server		stun.broadcastsuite.cloud	✔️	✔️
Custom Libopus Path	Custom path to libopus		✔️	✔️

Talkback

Name	Description	Default Value	↻	Sync
Mute Delay	Delay before talkback turns off after releasing the button. 0 disables the delay. In milliseconds	60		✔️

info

Requires the Audio Input add-on.

Scheduler

The Scheduler settings.

Name	Description	Default Value	↻	Sync
Task Refresh Interval	Defines how often the scheduler refreshes the upcoming and cached tasks In seconds	60	✔️	✔️
Task Cache Limit	Maximum number of cached tasks	100		✔️
Task Cache Prefetch	The number of hours the tasks are scheduled in advance In hours	1		✔️

info

Requires the Scheduler add-on.

Select-a-Line

The Select-a-Line settings

Name	Description	Default Value	↻	Sync
Enable Hard Reload		True		✔️
Hard Reload Time		04:18:00		✔️

Technical

The technical settings.

Technical

Name	Description	Default Value	↻	Sync
Technical Mode	Enables the technical mode	False		✔️
Panel Throttle Value	In milliseconds	50		✔️
TCP Buffer Size	In bytes	8192	✔️	✔️
DMS Receive Buffer Size	In bytes	1048576	✔️	✔️
Default Timeout for Web Requests	In seconds	5	✔️	✔️
Statistics Interval	Interval at which the statistics should be collected In seconds (Use 0 to disable)	60	✔️	✔️
Max Placeholder Replacement Cycles	Maximum number for placeholder replacement. Required to prevent a loop	500	✔️	✔️
System Alert Interval	The interval at which the system alerts for the system alert triggers should be checked. In seconds	60	✔️	✔️
GUI WebSocket Keep Alive	The frequency at which to send Ping/Pong keep-alive control frames. In minutes	1	✔️	✔️
File Maintenance Time	Time when managed files are synchronised with the file system.	03:55:00	✔️	✔️
Temporary Folder Purge Time	Time when unused temporary files and empty folders will be purged	01:50:00	✔️	✔️

gRPC

Name	Description	Default Value	↻	Sync
gRPC Request Timeout	In seconds	30	✔️	✔️
gRPC Stream Limit	Maximum number of simultaneous gRPC streams (server side)	100	✔️	✔️
gRPC Keep Alive Ping Interval	Interval for the gRPC keep alive ping In seconds	60	✔️	✔️

Telemetry

Name	Description	Default Value	↻	Sync
Send Telemetry	Send telemetry to SLG Broadcast AG	True		✔️
Telemetry URL	URL with HTTP and Core API port Comma-separated list of URLs			✔️
Telemetry Interval	In hours	6	✔️	✔️
Telemetry Purge Time	Time when the entries will be purged	04:10:00	✔️	✔️

OpenTelemetry

Name	Description	Default Value	↻	Sync
Enable OpenTelemetry	If enabled, OpenTelemetry metrics will be sent to the configurable endpoint.	False	✔️	✔️
OpenTelemetry Endpoint URL	URL with protocol and port		✔️	✔️
OpenTelemetry Username	Username for basic authentication		✔️	✔️
OpenTelemetry Password	Password for basic authentication		✔️	✔️
OpenTelemetry Push Interval	In seconds	30	✔️	✔️

Analytics

Name	Description	Default Value	↻	Sync
Analytics Script	Custom analytics or tracking script Will be included in the document header			✔️