Skip to content

armgit / dashy

Public Imported from GitHub
0

πŸš€ A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!

πŸ“ Updates contents of widget docs

Alicia Sykes00709acd51e6
diff --git a/docs/widgets.md b/docs/widgets.md
index 3c005c49..0919e8f0 100644
--- a/docs/widgets.md
+++ b/docs/widgets.md
@@ -69,6 +69,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a
- [Widget Usage Guide](#widget-usage-guide)
- [Continuous Updates](#continuous-updates)
- [Proxying Requests](#proxying-requests)
+ - [Setting Timeout](#setting-timeout)
- [Custom CSS Styling](#widget-styling)
- [Customizing Charts](#customizing-charts)
- [Language Translations](#language-translations)
@@ -1729,7 +1730,16 @@ Vary: Origin
### Setting Timeout
-Default timeout is Β½ a second. This can be overridden with the `timeout` attribute on a widget, specified as an integer in milliseconds.
+If the endpoint you are requesting data from is slow to respond, you may see a timeout error in the console. This can easily be fixed by specifying the `timeout` property on the offending widget. This should be an integer value, in milliseconds. By default timeout is `2500` ms (2Β½ seconds).
+
+For example:
+
+```yaml
+- type: gl-current-cpu
+ timeout: 8000
+ options:
+ hostname: https://glances.dns-device.local
+```
---