OPNsense Support

[sthgi]

Really love this project and its potential! Wondering if you would consider adding support for OPNsense in Beszel? Like Unraid they have Community Plugins. It opens the door to networking metrics.

Thanks for creating this!

[henrygd]

Can you provide more details on what's required for a plugin? I think it's FreeBSD, right? Someone on reddit also mentioned this and wanted to test the FreeBSD binaries, so I'm going to send it to them in a bit for testing.

Edit: Also, I'm converting this to a discussion.

[sthgi]

Yes it is based off of FreeBSD 13 and 14 with their newest release. Testing other products is what got me here maybe some of this can cut down on the time it takes you to implement something like this. OPNsense is a offshoot of pfsense so that could be included as well.

This guy wrote a python script for OPNsense to work with Checkmk: https://github.com/bashclub/checkmk-opnsense-agent.

He was supporting:
CPU Usage
DHCP Pool
File System
Firmware Version
Gateway
Interfaces
Memory
Unbound
Uptime
WireGuard Clients

His Python script is available here:
https://github.com/bashclub/checkmk-opnsense-agent/blob/main/opnsense_checkmk_agent.py

Here is another guy using json for Zabbix:
https://grumpy.systems/2024/opnsense-monitoring-with-zabbix/

Hope this helps and obviously only promoting this for the metrics that make sense for your solution. Hopefully others chime in as well.

Thanks again.

[sthgi]

Not finding anything to add plugins to OPNsense official repo but you can add other repos. Here is one example:
https://www.routerperformance.net/opnsense-repo/

simple command in opnsense shell:
fetch -o /usr/local/etc/pkg/repos/mimugmail.conf https://www.routerperformance.net/mimugmail.conf

Here is the conf:
https://www.routerperformance.net/mimugmail.conf

At least with your own repo your not having to rely on anyone else. Originally I was just thinking about an agent with this request but we could host beszel server on opnsense as well.

[utlilb]

I'm also willing to test the FreeBSD binaries. Will be on PFSense though.

[henrygd]

Here are FreeBSD amd64 binaries for testing. You can also build yourself by following the instructions in the readme.

GOOS=freebsd GOARCH=amd64 CGO_ENABLED=0 go build -ldflags "-w -s" .

beszel-agent_freebsd_amd64.tar.gz
beszel_freebsd_amd64.tar.gz

[sthgi]

how are you guys going about auto starting the service in opnsense?

[sthgi]

For anyone else wanting to autostart bezel-agent...

90-beszel-agent -> /usr/local/etc/rc.syshook.d/start/90-beszel-agent

#!/bin/sh

echo -n "Starting Beszel Agent "
configctl beszel-agent restart

---

actions_beszel-agent.conf -> /usr/local/opnsense/service/conf/actions.d/

[start]
command:sh /usr/local/etc/rc.beszel-agent &
parameters:
type:script
message:Starting beszel-agent
description:Starting beszel-agent service

[restart]
command:sh /usr/local/etc/rc.beszel-agent &
parameters:
type:script
message:Restarting beszel-agent

[stop]
command:ps -ef | pgrep -f "beszel-agent" | xargs kill -9
parameters:
type:script
message:Stopping beszel-agent

---

beszel-agent -> /usr/local/sbin
chmod +x /usr/local/sbin/beszel-agent

---

rc.beszel-agent -> /usr/local/etc/rc.beszel-agent

#!/bin/sh

KEY="PASTE_YOUR_KEY_HERE" /usr/local/sbin/beszel-agent

---

service configd restart
configctl beszel-agent start|stop|restart
/usr/local/etc/rc.syshook.d/start/90-beszel-agent will start on reboot
actions_beszel-agent.conf will add to opnsense webui cron if it has a description under start|stop|restart

[henrygd]

Thanks for this!

Sounds like it's functional in opnsense then?

[sthgi]

Yes it is, its pulling the standard metrics perfectly. I am not seeing any fluctuation with disk/io but that just could be opnsense not doing much. I also just got it working so might just need more time monitoring to see something. All that is left is the advanced opnsense metrics when there is time.