π A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
Vue awesomedashboarddockerhomelabhomepagemitnodejsorganizationproductivitypwaself-hostedstartpagevue
π Updates the healthcheck widget docs
Alicia Sykes3028dcf18e30
diff --git a/docs/privacy.md b/docs/privacy.mdindex df0d4e6d..4d1b82ab 100644--- a/docs/privacy.md+++ b/docs/privacy.md@@ -204,7 +204,7 @@ Dashy supports [Widgets](/docs/widgets.md) for displaying dynamic content. Below| [Astronomy Picture of the Day](/docs/widgets.md#astronomy-picture-of-the-day) | `https://apod.as93.net` | [NASA's Privacy Policy](https://www.nasa.gov/about/highlights/HP_Privacy.html) || [GitHub Trending](/docs/widgets.md#github-trending) | `https://trend.doforce.xyz` | No Policy Available || [GitHub Profile Stats](/docs/widgets.md#github-profile-stats) | `https://github-readme-stats.vercel.app` | [GitHub's Privacy Policy](https://docs.github.com/en/github/site-policy/github-privacy-statement) |-| [Cron Monitoring (Health Checks)](/docs/widgets.md#cron-monitoring-health-checks) | `https://healthchecks.io` | [Health-Checks Privacy Policy](https://healthchecks.io/privacy/) |+| [Healthchecks Status](/docs/widgets.md#healthchecks-status) | `https://healthchecks.io` | [Health-Checks Privacy Policy](https://healthchecks.io/privacy/) || [Hacker News Trending](/docs/widgets.md#hacker-news-trending) | `https://hacker-news.firebaseio.com` | [Y Combinator Privacy Policy](https://www.ycombinator.com/legal#privacy) || [Minecraft Server Status](/docs/widgets.md#minecraft-server-status) | `https://api.mcsrvstat.us` | No Policy Available || [MVG](/docs/widgets.md#mvg) | `https://www.mvg.de/api/fib/v2/` | No Policy Available |diff --git a/docs/widgets.md b/docs/widgets.mdindex 65cabbd1..6f49c405 100644--- a/docs/widgets.md+++ b/docs/widgets.md@@ -44,7 +44,6 @@ Dashy has support for displaying dynamic content in the form of widgets. There a- [Minecraft Server](#minecraft-server)- **[Self-Hosted Services Widgets](#self-hosted-services-widgets)**- [System Info](#system-info)- - [Cron Monitoring](#cron-monitoring-health-checks)- [CPU History](#cpu-history-netdata)- [Memory History](#memory-history-netdata)- [System Load History](#load-history-netdata)@@ -1227,19 +1226,21 @@ Display stats from your GitHub profile, using embedded cards from [anuraghazra/g### HealthChecks Status-Display status of one or more HealthChecks project(s). Works with healthchecks.io and your selfhosted instance.+Display cron job monitor status of one or more HealthChecks project(s). Works with healthchecks.io and your selfhosted instance.-<p align="center"><img width="380" src="https://pixelflare.cc/alicia/dashy/healthchecks" /></p>+<p align="center"><img width="400" src="https://pixelflare.cc/alicia/dashy/cron-monitor" /></p>#### Options**Field** | **Type** | **Required** | **Description**--- | --- | --- | ---**`host`** | `string` | Optional | The base url of your instance, default is `https://healthchecks.io`-**`apiKey`** | `string` or `array` | Required | One or more API keys for your healthcheck projects. (Read-only works fine)+**`apiKey`** | `string` (or `string[]` for multiple) | Required | API key(s) for project(s) to monitor. Generate a separate key per project (read-only is fine), under Project --> Settings --> API Access++##### Example```yaml-- type: HealthChecks+- type: health-checksoptions:host: https://healthcheck.your-domain.deapiKey:@@ -1247,9 +1248,17 @@ Display status of one or more HealthChecks project(s). Works with healthchecks.i- zxywvu...```+Or, a single project:+```yaml+ - type: health-checks+ options:+ host: https://healthchecks.io+ apiKey: hcw_xxxxxxxxxxxxxxxxxxxxxxxx+```+#### Info-- **CORS**: π’ Enabled+- **CORS**: π Proxied- **Auth**: π’ Required- **Price**: π’ Free / Paid / Self-hosted- **Host**: Managed Instance or Self-Hosted (see [healthchecks/healthchecks](https://github.com/healthchecks/healthchecks))@@ -1661,37 +1670,6 @@ Note that this widget is not available if you are running Dashy in a container o----### Cron Monitoring (Health Checks)--Cron job monitoring using [Health Checks](https://github.com/healthchecks/healthchecks). Both managed and self-hosted instances are supported.--<p align="center"><img width="400" src="https://pixelflare.cc/alicia/dashy/cron-monitor" /></p>--#### Options--**Field** | **Type** | **Required** | **Description**---- | --- | --- | ----**`apiKey`** | `string` | Required | A read-only API key for the project to monitor. You can generate this by selecting a Project --> Settings --> API Access. Note that you must generate a separate key for each project-**`host`** | `string` | _Optional_ | If you're self-hosting, or using any instance other than the official (healthchecks.io), you will need to specify the host address. E.g. `https://healthchecks.example.com` or `http://cron-monitoing.local`--#### Example--```yaml-- type: health-checks- options:- apiKey: XXXXXXXXX-```--#### Info--- **CORS**: π’ Enabled-- **Auth**: π΄ Required-- **Price**: π Free plan (up to 20 services, or self-host for unlimited)-- **Host**: Managed Instance or Self-Hosted (see [GitHub - HealthChecks](https://github.com/healthchecks/healthchecks))-- **Privacy**: _See [Health-Checks Privacy Policy](https://healthchecks.io/privacy/)_------### CPU History (NetData)Pull recent CPU usage history from NetData.