docs: Create new docs on using dashboards (#7688)

* docs: create new dashboards doc

* docs: added new dashboard doc

* docs: images for dashboard doc

* Update Dashboards.md

* docs: dashboard minor changes

spelling changes.
This commit is contained in:
Kevin Krumm
2017-11-09 06:00:49 -06:00
committed by Neil Lathwood
parent f453875c0f
commit d4dab47c75
5 changed files with 52 additions and 0 deletions

View File

@ -0,0 +1,51 @@
source: Extensions/Dashboards.md
# Dashboards
Create customised dashboards in LibreNMS per user. You can share dashboards with other users. You can also make a custom dashboard and
default it for all users in LibreNMS.
Example Dashboard
![Example Dashboard](/img/example-dashboard.png)
### Widgets
LibreNMS has a whole list of Widgets to select from.
![List Of Widgets](/img/list-widgets.png)
- Alerts Widget: show all alert not notifications.
- Availability Map: Shows all devices with colored tiles, green up, yellow for warning (device has been restarted in last 24 hours),red for
down. You can also list all services and ignored/disabled devcies in this widget.
- Componet Status: List all componets Ok state, Warning state, Critical state.
- Device Summary horizontal: List device totals, up, down, ignored, disabled. Same for ports and services.
- Device Summary vertical: List device totals, up, down, ignored, disabled. Same for ports and services.
- Eventlog: Shows all events with your devices and LibreNMS.
- External Image: can be used to show external images on your dashboard.
- Globe Map: Will display map of the globe.
- Graph: Can be used to display graphs from devices.
- Graylog: Lists all Graylog's syslog entries.
- Notes: use for html tags, embed links and external web pages.
- Syslog: lists all syslog entries.
- Top Devices: By Traffic, or Uptime, or Response time, or Poller Duration, or Procssor load, or Memory Usage.
- Top Interfaces: Lists top interfaces.
- Worldmap: displays all your devices locations. From syslocation or from override sysLocation.
### Dashboard Permissions
- Private: Sets the dashabord to only the user that created the dashboard can view and edit.
- Shared Read: Sets the dashboard to allow other users to view the dashboard, but cant make changes to the dashboard.
- Shared: Allows all users to view the dashboard and make changes.
### Setting a global default dashboard
Step 1: Set the dashboard to either shared read or shared, depending on what you want the users access to change.
Step 2: Then go to Settings -> WebUI settings -> Dashboard Settings and set the global default dashboard.
### Setting embeded webpage
Using the Notes Widget.
```html
<iframe src="http://url/" width="1200" height="800">
<p>Your browser does not support iframes.</p>
</iframe>
```
Note you may need to play with the width and height and also size your widget properly.
Also some web pages may not support html embeded or iframe.
![Example embed webpage](/img/example-embed-website.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 384 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 375 KiB

BIN
doc/img/list-widgets.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.5 KiB

View File

@ -46,6 +46,7 @@ pages:
- Extensions/Interface-Description-Parsing.md
- Extensions/Network-Map.md
- Extensions/Syslog.md
- Extensions/Dashboards.md
- 5. Advanced Setup:
- Support/1-Minute-Polling.md
- Configuration docs: Support/Configuration.md