mirror of
https://github.com/karl0ss/homepage.git
synced 2025-04-29 12:03:41 +01:00
26 lines
850 B
Markdown
26 lines
850 B
Markdown
---
|
|
title: pfSense
|
|
description: pfSense Widget Configuration
|
|
---
|
|
|
|
This widget requires the installation of the [pfsense-api](https://github.com/jaredhendrickson13/pfsense-api) which is a 3rd party package for pfSense routers.
|
|
|
|
Once pfSense API is installed, you can set the API to be read-only in System > API > Settings.
|
|
|
|
Currently the only supported authentication mode is 'Local Database'.
|
|
|
|
WAN interface to monitor can be defined by updating the `wan` param.
|
|
|
|
Load is returned instead of cpu utilization. This is a limitation in the pfSense API due to the complexity of this calculation. This may become available in future versions.
|
|
|
|
Allowed fields: `["load", "memory", "temp", "wanStatus", "wanIP", "disk"]` (maximum of 4)
|
|
|
|
```yaml
|
|
widget:
|
|
type: pfsense
|
|
url: http://pfsense.host.or.ip:port
|
|
username: user
|
|
password: pass
|
|
wan: igb0
|
|
```
|