vh/homepage
1
0
Fork 0
mirror of https://github.com/gethomepage/homepage.git synced 2025-12-07 09:35:54 -08:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity
Files
ed1dafadde973bbaa3b83e03d9c59c8e5d7db7d9
homepage/docs/widgets/services/opnsense.md
shamoon ba5e6dec07
Some checks failed
Docs / Linting Checks (push) Has been cancelled
Details
Docs / Test Build (push) Has been cancelled
Details
Docs / Build & Deploy (push) Has been cancelled
Details
Documentation: Add missing wan option for opnsense widget
2024-11-22 13:23:07 -08:00

881 B
Raw Blame History

title, description
title description
OPNSense OPNSense Widget Configuration

Learn more about OPNSense.

The API key & secret can be generated via the webui by creating a new user at System/Access/Users. Ensure "Generate a scrambled password to prevent local database logins for this user" is checked and then edit the effective privileges selecting only:

  • Diagnostics: System Activity
  • Status: Traffic Graph / Reporting: Traffic (OPNSENSE 24.7.x)

Finally, create a new API key which will download an apikey.txt file with your key and secret in it. Use the values as the username and password fields, respectively, in your homepage config.

Allowed fields: ["cpu", "memory", "wanUpload", "wanDownload"].

widget:
  type: opnsense
  url: http://opnsense.host.or.ip
  username: key
  password: secret
  wan: opt1 # optional, defaults to wan