From 91f3ae28d6a2aae7e4eee0a4a59cfbd63aa0b67a Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Thu, 26 Aug 2021 23:02:22 +0100 Subject: [PATCH] :memo: Updates info section of status check docs --- docs/status-indicators.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/status-indicators.md b/docs/status-indicators.md index ff45ecad..ad9e6724 100644 --- a/docs/status-indicators.md +++ b/docs/status-indicators.md @@ -1,6 +1,6 @@ # Status Indicators -Dashy has an optional feature that can display a small icon next to each of your running services, indicating it's current status. This is useful if you are using Dashy as your homelab's start page, as it gives you an overview of the health of each of your running services. +Dashy has an optional feature that can display a small icon next to each of your running services, indicating it's current status. This can be useful if you are using Dashy as your homelab's start page, as it gives you an overview of the health of each of your running services. The status feature will show response time, response code, online/ offline check and if applicable, a relevant error message

@@ -24,21 +24,21 @@ sections: description: Firewall Central Management icon: networking/opnsense.png url: https://192.168.1.1 - statusCheck: false + statusCheck: false - title: MalTrail description: Malicious traffic detection system icon: networking/maltrail.png url: http://192.168.1.1:8338 - statusCheck: true + statusCheck: true - title: Ntopng description: Network traffic probe and network use monitor icon: networking/ntop.png url: http://192.168.1.1:3001 - statusCheck: true + statusCheck: true ``` ## Continuous Checking -By default, with status indicators enabled Dashy will check an applications status on page load, and will not keep indicators updated. This is usually desirable behavior. However, if you do want the status indicators to continue to poll your running services, this can be enabled by setting the `statusCheckInterval` attribute. Here you define an interval in seconds, and Dashy will poll your apps every x seconds. Note that if this number is very low (below 5 seconds), you may notice the app running slightly slower. +By default, with status indicators enabled Dashy will check an applications status on page load, and will not keep indicators updated. This is usually desirable behavior. However, if you do want the status indicators to continue to poll your running services, this can be enabled by setting the `statusCheckInterval` attribute. Here you define an interval as an integer in seconds, and Dashy will poll your apps every x seconds. Note that if this number is very low (below 5 seconds), you may notice the app running slightly slower. The following example, will instruct Dashy to continuously check the status of your services every 20 seconds @@ -58,7 +58,7 @@ If your service is responding with an error, despite being up and running, it is For example, `statusCheckHeaders: { 'X-Custom-Header': 'foobar' }` ## Disabling Security -By default, (if you're using HTTPS) any requests to insecure or non-HTTPS content will be blocked. This will likely cause the status check to fail. If you trust the endpoint (e.g. you're self-hosting it), then you can disable this security measure for an individual item. This is done by setting `statusCheckAllowInsecure: true` +By default, (if you're using HTTPS) any requests to insecure or non-HTTPS content will be blocked. This will cause the status check to fail. If you trust the endpoint (e.g. you're self-hosting it), then you can disable this security measure for an individual item. This is done by setting `statusCheckAllowInsecure: true` ## Troubleshooting Failing Status Checks If the status is always returning an error, despite the service being online, then it is most likely an issue with access control, and should be fixed with the correct headers. Hover over the failing status to see the error code and response, in order to know where to start with addressing it. @@ -68,12 +68,16 @@ If you are still having issues, it may be because your target application is blo Access-Control-Allow-Origin: https://location-of-dashy/ Vary: Origin ``` +If the URL you are checking is not using HTTPS, then you may need to disable the rejection of insecure requests. This can be done by setting `statusCheckAllowInsecure` to true for a given item. + +If you're serving Dashy though a CDN, instead of using the Node server or Docker image, then the Node endpoint that makes requests will not be available to you, and all requests will fail. A workaround for this may be implemented in the future, but in the meantime, your only option is to use the Docker or Node deployment method. + For further troubleshooting, use an application like [Postman](https://postman.com) to diagnose the issue. ## How it Works -When Dashy is loaded, items with `statusCheck` enabled will make a request, to `https://[your-host-name]/ping?url=[address-or-servce]`, which in turn will ping that running service, and respond with a status code. Response time is calculated from the difference between start and end time of the request. +When the app is loaded, if `appConfig.statusCheck: true` is set, or if any items have the `statusCheck: true` enabled, then Dashy will make a request, to `https://[your-host-name]/ping?url=[address-or-servce]` (may al include GET params for headers and the secure flag), which in turn will ping that running service, and respond with a status code. Response time is calculated from the difference between start and end time of the request. When the response completes, an indicator will display next to each item. The color denotes the status: Yellow while waiting for the response to return, green if request was successful, red if it failed, and grey if it was unable to make the request all together. -All requests are made straight from your server, there is no intermediary. So providing you are hosting Dashy yourself, and are checking the status of other self-hosted services, there shouldn't be any privacy concerns. Requests are made asynchronously, so this won't have any impact on page load speeds. However recurring requests (using `statusCheckInterval`) may run more slowly if the interval between requests is very short. +All requests are made straight from your server, there is no intermediary. So providing you are hosting Dashy yourself, and are checking the status of other self-hosted services, there shouldn't be any privacy concerns. Requests are made asynchronously, so this won't have any significant impact on page load speeds. However recurring requests (using `statusCheckInterval`) may run more slowly if the interval between requests is very short.