30 lines
1.4 KiB
Markdown
30 lines
1.4 KiB
Markdown
---
|
|
title: pfSense
|
|
description: pfSense Widget Configuration
|
|
---
|
|
|
|
Learn more about [pfSense](https://github.com/pfsense/pfsense).
|
|
|
|
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.
|
|
|
|
There are two currently supported authentication modes: 'Local Database' and 'API Token'. To for 'Local Database', use the `username` and `password` fields with the credentials of a pfSense admin user. For 'API Token', utilize the `headers` parameter as shown below. When generating a new key, the client_token will be shown once at the top of the page in an alert box and the client_id will be shown at the bottom of the page.
|
|
|
|
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 # only if not utilizing headers
|
|
password: pass # only if not utilizing headers
|
|
headers: # use this instead of username and password
|
|
Authorization: client_id client_token
|
|
wan: igb0
|
|
```
|