Karl/homepage
1
0
Fork 0
mirror of https://github.com/karl0ss/homepage.git synced 2025-05-05 06:53:39 +01:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: add info re pfSense API token auth (#3145)

Browse Source
This commit is contained in:
zmweske 2024-03-20 15:21:56 -05:00 committed by GitHub
parent 556450c8de
commit 7627f9c5a7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -9,9 +9,9 @@ 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.
Currently the only supported authentication mode is 'Local Database'.
There are two currently supported authentication modes: 'Local Database' and 'API Token'. For 'Local Database', use `username` and `password` with the credentials of an admin user. For 'API Token', utilize the `headers` parameter with `client_token` and `client_id` obtained from pfSense as shown below. Do not use both headers and username / password.
WAN interface to monitor can be defined by updating the `wan` param.
The interface to monitor is defined by updating the `wan` parameter. It should be referenced as it is shown under Interfaces > Assignments in pfSense.
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.
@ -21,7 +21,10 @@ Allowed fields: `["load", "memory", "temp", "wanStatus", "wanIP", "disk"]` (maxi
widget:
type: pfsense
url: http://pfsense.host.or.ip:port
username: user
password: pass
username: user # optional, or API token
password: pass # optional, or API token
headers: # optional, or username/password
Authorization: client_id client_token
wan: igb0
fields: ["load", "memory", "temp", "wanStatus"] # optional
```