diff --git a/docs/widgets.md b/docs/widgets.md index 022cc63e..b21f63a4 100644 --- a/docs/widgets.md +++ b/docs/widgets.md @@ -42,6 +42,10 @@ Dashy has support for displaying dynamic content in the form of widgets. There a - [Pi Hole Queries](#pi-hole-queries) - [Recent Traffic](#recent-traffic) - [Stat Ping Statuses](#stat-ping-statuses) +- [System Resource Monitoring](#system-resource-monitoring) + - [CPU Usage Current](#current-cpu-usage) + - [CPU Usage Per Core](#cpu-usage-per-core) + - [CPU Usage History](#cpu-usage-history) - [Dynamic Widgets](#dynamic-widgets) - [Iframe Widget](#iframe-widget) - [HTML Embed Widget](#html-embedded-widget) @@ -1154,6 +1158,88 @@ Displays the current and recent uptime of your running services, via a self-host --- +## System Resource Monitoring + +The easiest method for displaying system info and resource usage in Dashy is with [Glances](https://nicolargo.github.io/glances/). + +Glances is a cross-platform monitoring tool developed by [@nicolargo](https://github.com/nicolargo). It's similar to top/htop but with a [Rest API](https://glances.readthedocs.io/en/latest/api.html) and many [data exporters](https://glances.readthedocs.io/en/latest/gw/index.html) available. Under the hood, it uses [psutil](https://github.com/giampaolo/psutil) for retrieving system info. + +If you don't already have it installed, either follow the [Installation Guide](https://github.com/nicolargo/glances/blob/master/README.rst) for your system, or setup [with Docker](https://glances.readthedocs.io/en/latest/docker.html), or use the one-line install script: `curl -L https://bit.ly/glances | /bin/bash`. You'll need to run Glances as a web server, using the `-w` option, see the [command reference docs](https://glances.readthedocs.io/en/latest/cmds.html) for more info. + + +##### Options + +All Glance's based widgets require a `hostname` + +**Field** | **Type** | **Required** | **Description** +--- | --- | --- | --- +**`hostname`** | `string` | Required | The URL to your Glances instance, without a trailing slash + + +##### Info +- **CORS**: 🟢 Enabled +- **Auth**: 🟢 Not Required +- **Price**: 🟢 Free +- **Host**: Self-Hosted (see [GitHub - Nicolargo/Glances](https://github.com/nicolargo/glances)) +- **Privacy**: ⚫ No Policy Available + +--- + +### Current CPU Usage + +Live-updating current CPU usage, as a combined average across alll cores + +