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 'e915d81310'
${ noResults }
homepage/docs/widgets/services/pfsense.md

1.4 KiB
Raw Blame History

title description
pfSense pfSense Widget Configuration

Learn more about pfSense.

This widget requires the installation of the 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)

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