Documentation Index

Fetch the complete documentation index at: https://docs.swxtch.io/llms.txt

Use this file to discover all available pages before exploring further.

Using groundSwXtch User Interface

  • Updated on Jul 24, 2026
  • Published on Jul 24, 2026
  • 2 minute(s) read
Prev Next

What is groundSwXtch User Interface? 

The groundSwXtch User Interface is a web-based monitoring and configuration tool for groundSwXtch. It presents users with a high-level view of their groundSwXtch environment with an interactive graph detailing connections to different endpoints showing multicast data between groundSwXtches.  

How to Access groundSwXtch User Interface

To access the groundSwXtch UI, users will need to enter the following URL into a web browser that has network visibility to the control interface of their groundSwXtch.  While the user interface is automatically added with each groundSwXtch, it is important to just use one for all groundSwXtches that you intend to work together.

http://<groundSwXtch-address>:8080

NOTE

groundSwXtch traffic can work outside the groundSwXtch network given the proper network configuration/tools. For example, users can use tunneling, VPNs, etc. so they can access the UI from any browser connected to the internet.  

The groundSwXtch will be broken into several sub-areas:

How to Navigate the groundSwXtch User Interface

The user interface will start out with the groundSwXtch belonging to the address entered into the URL.  Below is the user interface with some groundSwXtches already added with sources and destinations.  The map displays the multicast groups from one gS to another and by hovering over the group the multicast group details display.

Top Ribbon:

The top ribbon data area displays:  

  • Sites: A site is one groundSwXtch instance.  Each site row carries a bundle of bounded, aggregate-only data: reachability, license status, time-sync status, rx/tx Mbps totals, live socket/stream counts, multicast route count, and a derived health.   Sites below show the number of all groundSwXtch Instances.  

  • Nodes: A node and a site may not match, a site may have multiple reachable addresses, e.g. LAN + public IP, this is rolled up into one Site.  

  • Multicast Groups: This is the distinct multicast groups active fleet-wide.

  • Inter-site flows: This is the sum of the group count for flows that cross site boundaries. Note: it's specifically flows crossing sites.

  • Wire load: The dominant (larger) of  total received mbps and total transmitted mbps.

  • Degraded:  The count of sites which are down.  

The buttons in the top ribbon buttons:

  • All Streams: Shows in the stream tab all the streams currently active.  See also How to use the side panel/Streams.

  • Connectivity: shows the fleet connectivity panel.

  • Alerts:  Shows the alerts panel.  They can be filtered using the buttons at the top.

  • Licensed:  Shows configure tab with the license data expanded.  See also How to license the groundSwXtch.

The buttons to the far left allow the user to add groundSwXtches, Sources and Destinations.  

Right Side Panel:

Configuration for Streams, Configure and Advanced tabs can be opened using the icons to the far right.    Depending on the one chosen the tab will be opened to that selection.  See How to use the side panel.

Map Tool:

The map tools allow the user to change to Schematic view from Map view, Zoom in and out, Fit to Window and Lock the map area.  

Right click in the map area allows the user to tilt and move the map.  Left click allows the user to move the map area.

Right click on a groundSwXtch brings up details about the groundSwXtch details pane.  For more information on this pane refer to groundSwXtch Details Pane.

PLEASE NOTE

Configuration files are stored in /var/lib/groundswxtch/