dominik/homepage-plus
1
0
Fork 0
mirror of https://github.com/DI0IK/homepage-plus.git synced 2025-07-07 22:28:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Feature: support multiple checks for healthchecks widget (#2580)

Browse source 
* 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>
This commit is contained in:
Metin Yazici 2024-01-07 18:17:07 +01:00 • committed by GitHub
parent 50c989e36a
commit 1103df2b64
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 51 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/widgets/services/healthchecks.md
View file

@ -3,18 +3,21 @@ title: Health checks
description: Health checks Widget Configuration
---
To use the Health Checks widget, you first need to generate an API key. To do this, follow these steps:
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.
1. Go to Settings in your check dashboard.
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"]`.
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: <YOUR_CHECK_UUID>
uuid: <CHECK_UUID> # optional, if not included total statistics for all checks is shown
```