dominik/homepage-plus
1
0
Fork 0
mirror of https://github.com/DI0IK/homepage-plus.git synced 2025-07-16 09:49:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

add mkdocs

Browse source
This commit is contained in:
Ben Phelps 2023-09-29 21:01:11 +03:00
parent b215843b26
commit 47765ee05e
144 changed files with 4219 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/widgets/services/pfsense.md Normal file
View file

@ -0,0 +1,25 @@
---
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
```