WHAT TO EXPECT
In this article, users will learn how to use the side panel. In this panel users can configure streams, groundSwXtches, PTP, and have other functions for troubleshooting purposes.
This page is organized into three sections:
Streams
The streams tab list all the configured streams, the very top indicates the number of configured streams. To find a particular stream(s) use the filter by area. Once the stream is identified then right click on the stream and it will open the groundSwXtch detail pane and show the stream information as shown below.
Configure
The configure tab list is used to configure the groundSwXtch. The very top is a drop-down selector to pick the groundSwXtch to configure.
The configuration tab is broken out into three section note that each section will bring the user to the appropriate section of the configure tab, but the user can also just scroll down in this area to see the appropriate section:
Network
The network tab allows setup of the Local and Wide Area networks, when installing the groundSwXtch the system will attempt to pick the best NIC for the selections below as well as the WAN Gateway, or the user can enter them via arguements refer to Installing groundSwXtch for these options. Should the wrong NIC be selected during the installation process the user and change the values here. The local network allows the user to select whether or not to use the internal virtul device. Besides configuring the LAN and WAN the user can configure the gateway and MTU size here as well. This area also shows the Address CIDR range for the groundSwXtch.
License
Please refer to How to license the groundSwXtch for more information on this tab.
Sockets
Under construction
Troubleshooting and Advanced Options
This is a hidden tab and should only be used for advanced users. It is broken up into six sections:
Instance
The instance area of the Advanced tab allows the user to configure things like:
Instance port, log level and format configurations.
Metrics bind address for output of metrics of the groundswXtch.
SRT functions such as listen port and protocol,
groundSwXtch engine configuration for memory ring size WAN Number of core and LAN number of core.
Time Sync - PTP
The fields are explained below:
Option | Description |
|---|---|
Time Sync Enabled | True/false with a default of false. Set to true if timing is required. |
Steering algorithm | Clock steering algorithm, default sigma. Use |
License | Obtained from Timebeat, this field is used to paste in the Timebeat License. |
NTP enabled | Default is disabled. Select if no PTP source is available to enable NTP as the time source. |
NTP Server | Leave to default unless there is a specific NTP Server desired. NTP server hostname or IP. |
Use NTP as Primary Clock | If not using PTP this should be set to true. |
NTP Pull Interval | Default is 4 seconds. |
Monitor Only (don’t steer) | Default is false. Monitor NTP offset without steering the clock. |
PTP Sync Enabled | Enable PTP-Squared peer-to-peer mesh. Set to |
PTP Interface | NIC for PTP grandmaster sync (typically |
PTP Domain | Leave as default, the system will set this. PTP domain number must match the grandmaster. To set |
PTP2 enabled | Enable PTP-Squared peer-to-peer mesh. Set to |
PTP2 Offer Time to peers | PTP2 seats offered to peers. |
PTP2 Receive time from peers | PTP2 seats receive from peers. |
PTP2 Domain | Comma-separated PTP2 domain numbers (e.g. |
Advanced PTP - Seats to Offer (not pictured) | Defaults to 10. PTP2 seats offered to peers. Boundary typically |
Advanced PTP - Seats to fill (not pictured) | Default to 5. PTP2 seats to fill from upstream. Leaf typically |
Advanced PTP - Concurrent (not pictured) | Default is |
Advanced PTP - Peer Port (not pictured) | Default |
Advanced PTP - Peer Fingerprint (not pictured) | Boundary clock libp2p fingerprint for DHT seeding. Get via |
Nat Traversal - PTP Mesh - Peer private IP | Peer's private/container IP (egress match target for tc pedit). NOT this server IP. |
Nat Traversal - PTP Mesh - Peer public IP | Peer's public IP (egress rewrite target). |
Inter-Site Connections
The Inter-Site Connections shows what other groundSwXtches this groundSwXtch is connected to with the status and Mbps totals between them. New connections can be added here.
New connections can be added here to test connectivity using the “+ New Connection” button. Example below:
Below shows the connection is added.
Multicast Routes
The Multicast Routes section shows the configured routes and whether or not they are joined.
Network Advanced
Enable IGMP querier on this LAN. What it does: IGMP (Internet Group Management Protocol) is used by devices to join/leave multicast groups (e.g., IPTV, some streaming/casting protocols like Chromecast/AirPlay-style discovery, multicast video). If you have IGMP snooping enabled on a switch/VLAN, the switch needs something acting as an IGMP querier — a device that periodically sends queries asking "who's still listening to this multicast group?" so it can build/maintain its snooping table correctly.
If your actual router/gateway upstream already sends IGMP queries, you generally don't need to enable this — leave it off to avoid conflicts (having two queriers on the same LAN can cause issues, though most implementations elect one via lowest IP).
If you have IGMP snooping enabled on this LAN/VLAN but no other device is querying (e.g., an isolated VLAN, or your ISP router doesn't do it), multicast traffic can silently break (streaming stutters, discovery devices not finding each other) — in that case, enabling the querier here fixes it.
Rule of thumb: Enable it only if multicast (IPTV, some smart-home discovery/casting protocols) is misbehaving on this specific LAN/VLAN and no other querier exists on that segment. Otherwise leave it disabled.
Connection Detail
When the Connection Detail pane is open the user can double click on a connection point in the graph and see more details about the connection.
