open-source-mirrors
/
homepage
mirror of https://github.com/benphelps/homepage
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '19c25713c4'
${ noResults }
homepage/docs/widgets/services/pfsense.md

26 lines
850 B
Raw Normal View History Unescape

add mkdocs
8 months ago
---
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:
Run pre-commit hooks over existing codebase Co-Authored-By: Ben Phelps <ben@phelps.io>
7 months ago
type: pfsense
url: http://pfsense.host.or.ip:port
username: user
password: pass
wan: igb0
add mkdocs
8 months ago
```