From 13181e6677b13987912898073a7b38b659c544d9 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Wed, 20 Mar 2024 13:21:00 -0700 Subject: [PATCH] Update pfsense.md --- docs/widgets/services/pfsense.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/widgets/services/pfsense.md b/docs/widgets/services/pfsense.md index 3e34b0207..8f32a718d 100644 --- a/docs/widgets/services/pfsense.md +++ b/docs/widgets/services/pfsense.md @@ -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. -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 as shown below. When generating a new key, the client_token will be shown once in an alert box at the top of the page and the client_id will be at the bottom of the page. Do not use both `headers` and `username`/`password`. +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. -The interface to monitor is defined by updating the `wan` parameter. It should be referenced as it is shown under Interfaces > Assignments in the 'Network port' column next to the MAC address. +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,8 +21,8 @@ Allowed fields: `["load", "memory", "temp", "wanStatus", "wanIP", "disk"]` (maxi widget: type: pfsense url: http://pfsense.host.or.ip:port - username: user # optional, or API key - password: pass # optional, or API key + username: user # optional, or API token + password: pass # optional, or API token headers: # optional, or username/password Authorization: client_id client_token wan: igb0