mirror of
https://github.com/karl0ss/homepage.git
synced 2025-04-29 12:03:41 +01:00
1103df2b64
* Change healthchecks online/offline with the original up/down * Add group statistics to healthcheck widget * Update healthchecks docs --------- Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
24 lines
750 B
Markdown
24 lines
750 B
Markdown
---
|
|
title: Health checks
|
|
description: Health checks Widget Configuration
|
|
---
|
|
|
|
Specify a single check by including the `uuid` field or show the total 'up' and 'down' for all
|
|
checks by leaving off the `uuid` field.
|
|
|
|
To use the Health Checks widget, you first need to generate an API key.
|
|
|
|
1. In your project, go to project Settings on the navigation bar.
|
|
2. Click on API key (read-only) and then click _Create_.
|
|
3. Copy the API key that is generated for you.
|
|
|
|
Allowed fields: `["status", "last_ping"]` for single checks, `["up", "down"]` for total stats.
|
|
|
|
```yaml
|
|
widget:
|
|
type: healthchecks
|
|
url: http://healthchecks.host.or.ip:port
|
|
key: <YOUR_API_KEY>
|
|
uuid: <CHECK_UUID> # optional, if not included total statistics for all checks is shown
|
|
```
|