From ae3debd597ef8af285ae0d3179393e63ef83207c Mon Sep 17 00:00:00 2001 From: Ben Phelps Date: Fri, 26 Aug 2022 13:19:39 +0300 Subject: [PATCH] Updated Information Widgets (markdown) --- Information-Widgets.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/Information-Widgets.md b/Information-Widgets.md index aaeb6ed..2e8afcf 100644 --- a/Information-Widgets.md +++ b/Information-Widgets.md @@ -1,5 +1,41 @@ # Configuration +Information widgets are placed above the first horizontal fold line, and can be configured more than once. + +As an example, we'll place two resource widgets, one that reports all stats, and one that report only disk usage for a separate location. + +```yaml +- resources: + cpu: true + memory: true + disk: /mnt/storage + +- resources: + cpu: false + memory: false + disk: /mnt/backups +``` + +Which results in something like this: + +Resource Widgets + + +## Resources + +You can include all or some of the available resources. If you do not want to see that resource, simply pass `false`. + +The disk path is the path reported by `df` (Mounted On), or the mount point of the disk. + +```yaml +- resources: + cpu: true + memory: true + disk: /disk/mount/path +``` + +## Weather + The weather widget uses the weatherapi.com API, so you will need to register and grab your API key (free tier is more than enough). The widget is configured inside of the `widgets.yaml` file.