mirror of
https://github.com/DI0IK/homepage-plus.git
synced 2025-07-19 02:59:50 +00:00
add mkdocs
This commit is contained in:
parent
b215843b26
commit
47765ee05e
144 changed files with 4219 additions and 3 deletions
21
docs/widgets/services/opnsense.md
Normal file
21
docs/widgets/services/opnsense.md
Normal file
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
title: OPNSense
|
||||
description: OPNSense Widget Configuration
|
||||
---
|
||||
|
||||
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
|
||||
|
||||
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"]`.
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: opnsense
|
||||
url: http://opnsense.host.or.ip
|
||||
username: key
|
||||
password: secret
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue