diff --git a/docs/widgets.md b/docs/widgets.md index 783fd26c..4a1d6551 100644 --- a/docs/widgets.md +++ b/docs/widgets.md @@ -34,6 +34,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a - [NASA APOD](#astronomy-picture-of-the-day) - [GitHub Trending](#github-trending) - [GitHub Profile Stats](#github-profile-stats) + - [Healthchecks Status](#healthchecks status) - **[Self-Hosted Services Widgets](#self-hosted-services-widgets)** - [System Info](#system-info) - [Cron Monitoring](#cron-monitoring-health-checks) @@ -1140,6 +1141,38 @@ 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 healthcheck.io and your selfhosted instance. + +
+ +#### 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) + +```yaml +- type: HealthChecks + options: + host: https://healthcheck.your-domain.de + apiKey: + - abcdefg... + - zxywvu... +``` + +#### Info + +- **CORS**: 🟢 Enabled +- **Auth**: 🟢 Required +- **Price**: 🟢 Free / Paid / Self-hosted +- **Host**: Managed Instance or Self-Hosted (see [healthchecks/healthchecks](https://github.com/healthchecks/healthchecks)) +- **Privacy**: _See [Healthchecks.io Privacy Policy](https://healthchecks.io/privacy/)_ + +--- + ## Self-Hosted Services Widgets ### System Info diff --git a/src/components/Widgets/HealthChecks.vue b/src/components/Widgets/HealthChecks.vue index 1243eb5c..4115897f 100644 --- a/src/components/Widgets/HealthChecks.vue +++ b/src/components/Widgets/HealthChecks.vue @@ -1,18 +1,19 @@{{ cron.status | formatStatus }}
{{ cron.name }}
{{ cron.desc }}