mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: added new widgets to dashboard doc. (#7948)

Browse Source 
* docs: added new widgets to dashboard doc. 

Storage Widget.
Server Stats Widget.

* Update Dashboards.md

* Update Dashboards.md
This commit is contained in:
Kevin Krumm
2017-12-23 13:30:33 -06:00
committed by GitHub
parent 1e0d7d8b07
commit 7b0c0c8ca7
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/Extensions/Dashboards.md
View File

@@ -21,8 +21,9 @@ LibreNMS has a whole list of Widgets to select from.
+ Graph: Can be used to display graphs from devices. + Graph: Can be used to display graphs from devices.
+ Graylog: Displays all Graylog's syslog entries. + Graylog: Displays all Graylog's syslog entries.
+ Notes: use for html tags, embed links and external web pages. Or just notes in general. + Notes: use for html tags, embed links and external web pages. Or just notes in general.
+ Server Stats: Will display gauges for CPU, Memory, Storage usage. Note the device type has to be listed as "Server".
+ Syslog: Displays all syslog entries. + Syslog: Displays all syslog entries.
+ Top Devices: By Traffic, or Uptime, or Response time, or Poller Duration, or Procssor load, or Memory Usage. + Top Devices: By Traffic, or Uptime, or Response time, or Poller Duration, or Procssor load, or Memory Usage, or Storage Usage.
+ Top Interfaces: Lists top interfaces by traffic utilization. + Top Interfaces: Lists top interfaces by traffic utilization.
+ Worldmap: displays all your devices locations. From syslocation or from override sysLocation. + Worldmap: displays all your devices locations. From syslocation or from override sysLocation.
@@ -38,10 +39,13 @@ List of Widgets:
- Shared: Allows all users to view the dashboard and make changes. - Shared: Allows all users to view the dashboard and make changes.
### Setting a global default dashboard ### 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 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. Step 2: Then go to Settings -> WebUI settings -> Dashboard Settings and set the global default dashboard.
### Setting embeded webpage ### Setting embeded webpage
Using the Notes Widget. Using the Notes Widget.
```html ```html
<iframe src="url/" width="1200" height="800"> <iframe src="url/" width="1200" height="800">
@@ -54,8 +58,10 @@ Also some web pages may not support html embeded or iframe.
![Example embed webpage](/img/example-embed-website.png) ![Example embed webpage](/img/example-embed-website.png)
### How to create ports graph ### How to create ports graph
In the dashboard, you want to create an interface graph select the widget called "Graph"
* Graph: select "Port" "Bits" In the dashboard, you want to create an interface graph select the widget called
* Graph: then select "Port" "Bits"
![port-bits-graph](/img/port-bits-graph.png) ![port-bits-graph](/img/port-bits-graph.png)
* Note: you can map the port by description or the alias or by port id. You will need to know this in order to map the port to the graph. * Note: you can map the port by description or the alias or by port id. You will need to know this in order to map the port to the graph.