OpenSource/homepage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update pfsense.md

Browse Source 
Gave API key usage explanation and example
This commit is contained in:
zmweske 2024-03-19 20:06:23 -05:00 committed by GitHub
parent edc38c93e2
commit e915d81310
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/widgets/services/pfsense.md
View File

@ -9,7 +9,7 @@ This widget requires the installation of the [pfsense-api](https://github.com/ja
Once pfSense API is installed, you can set the API to be read-only in System > API > Settings. 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'. 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. WAN interface to monitor can be defined by updating the `wan` param.
@ -21,7 +21,9 @@ Allowed fields: `["load", "memory", "temp", "wanStatus", "wanIP", "disk"]` (maxi
widget: widget:
type: pfsense type: pfsense
url: http://pfsense.host.or.ip:port url: http://pfsense.host.or.ip:port
username: user username: user # only if not utilizing headers
password: pass password: pass # only if not utilizing headers
headers: # use this instead of username and password
Authorization: client_id client_token
wan: igb0 wan: igb0
``` ```