Karl/homepage
1
0
Fork 0
mirror of https://github.com/karl0ss/homepage.git synced 2025-04-29 12:03:41 +01:00
Code Issues Packages Projects Releases Wiki Activity
homepage/docs/widgets/services/healthchecks.md
Metin Yazici 1103df2b64
Feature: support multiple checks for healthchecks widget (#2580) 
* 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>
2024-01-07 09:17:07 -08:00

750 B
Raw Blame History

title, description
title description
Health checks 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.

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