desktop widgets / opnsense api / read only

Your firewall,
one keystroke away.

See who just joined your network, how busy the WAN is, and which firewall rules are doing the work, without opening the OPNsense web UI. Three widgets for the Windows 11 Widget Board, KDE Plasma 6 and the GNOME top bar.

Get it from Microsoft Store Source on GitHub

Free / MIT licensed / no account, no telemetry

W

opens the Widget Board

live demo

The real widgets, running in your browser.

These are the same pages the app ships, fed with sample data instead of your router. Switch sizes and themes like you would in the Widget Board.

three widgets, three sizes each

What you get.

DHCP Leases

The devices on your network, newest first, so the one that just connected is on top. Cards show hostname, IP, vendor and how long ago it joined, color coded as new, active, reserved or stale. Works with ISC DHCP and Kea, detected automatically.

S: device count, new devices, one card per page
M: new and active counts, 24h activity line, 6 cards per page
L: reserved count, 10 cards per page, MAC addresses

Traffic

Live download and upload speed, sampled every second from the interface byte counters. The WAN is found by name, and the large size charts every interface, so LAN, VLANs and VPN tunnels each get their own line.

S: WAN speed with a small chart
M: WAN and LAN charts
L: every interface, current WAN speed, total bytes in and out

Firewall

Which rules are matching the most traffic right now, as a live donut. Labels come from the rule descriptions you set in OPNsense, and raw pf rules are turned into readable names like "NAT · LAN → WAN".

S: donut and the top 3 rules
M: top 5 rules with a legend, total evaluations
L: top 10 rules, evaluations and packets

same widgets, three desktops

Runs where you work.

Windows 11 Widget Board

A native widget provider packaged as an MSIX for x64 and ARM64. Press Win+W, add DHCP Leases, Traffic or Firewall, and pick a size from the widget's menu.

KDE Plasma 6

The same pages as desktop widgets, fed by a small user service on 127.0.0.1. Put them on the desktop, or in a panel where they open from an icon.

GNOME Shell 46+

GNOME has no desktop widgets, so they become a top bar button with the device count, a menu with devices, traffic and rules, and a notification when a new device joins.

your desktop Widgets for OPNsense

HTTPS / REST API / your API key

your network OPNsense firewall

~~cloudtelemetryaccount~~

privacy

It only talks to your firewall.

The app reads leases, interface counters and rule statistics from the address you enter, and makes no other connections. The API key stays in Windows Credential Manager, or your desktop keyring on Linux. Self-signed certificates work, since most home firewalls use one.

Read the privacy policy →

setup

Up and running in a few minutes.

Create a read-only API user

In OPNsense, make a group under System › Access › Groups, give it only the privileges the widgets need, add a user to it and create an API key. Don't use root.

Widget	Privilege
DHCP Leases (Kea)	Services: DHCP: Kea(v4)
DHCP Leases (ISC)	Status: DHCP Leases
Traffic	Diagnostics: Netstat
Firewall	Firewall: Rules, Diagnostics: Firewall statistics, Diagnostics: Netstat

Privilege names move around between OPNsense versions. The README lists the exact API endpoints.

Install

Windows: get it from the Microsoft Store, or build and deploy the MSIX from source with Visual Studio.

Linux: build the service and run the installer. It sets up the Plasma widgets or the GNOME extension, whichever desktop you have.
```
dotnet publish src/OPNsenseWidgets.Linux -c Release -r linux-x64 -o linux/dist
./linux/install.sh linux/dist/opnsense-widgetsd
```
Connect

Add a widget and open its settings. Enter the firewall address, then either type the key and secret or click Import Key to read the *_apikey.txt file OPNsense just downloaded. Test, Save, done. All widgets share the one connection.

Your firewall,one keystroke away.