diff options
| author | Bastien Wirtz <bastien.wirtz@gmail.com> | 2022-07-05 13:37:15 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-05 13:37:15 -0700 |
| commit | d57821b5fa8b994bc4082f7565a072090ff288a1 (patch) | |
| tree | 1a01c3025d20e89575701234c9cc974a9f142966 /docs | |
| parent | 95c589ba71d80ed0073158bbb6f81ec449b058d6 (diff) | |
| parent | 1b9a3f197526c69921d37e84f1eeff27dc42df8e (diff) | |
| download | homer-d57821b5fa8b994bc4082f7565a072090ff288a1.tar.gz homer-d57821b5fa8b994bc4082f7565a072090ff288a1.tar.zst homer-d57821b5fa8b994bc4082f7565a072090ff288a1.zip | |
Merge pull request #475 from Tooa/add-healthchecks-custom-service
feat: add custom service Healthchecks
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/customservices.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/customservices.md b/docs/customservices.md index efe8ca4..3f14f8c 100644 --- a/docs/customservices.md +++ b/docs/customservices.md | |||
| @@ -19,6 +19,7 @@ within Homer: | |||
| 19 | + [Emby / Jellyfin](#emby--jellyfin) | 19 | + [Emby / Jellyfin](#emby--jellyfin) |
| 20 | + [Uptime Kuma](#uptime-kuma) | 20 | + [Uptime Kuma](#uptime-kuma) |
| 21 | + [Tautulli](#tautulli) | 21 | + [Tautulli](#tautulli) |
| 22 | + [Healthchecks](#healthchecks) | ||
| 22 | 23 | ||
| 23 | If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. | 24 | If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. |
| 24 | 25 | ||
| @@ -223,3 +224,16 @@ endpoint pointing to Tautulli! | |||
| 223 | type: "Tautulli" | 224 | type: "Tautulli" |
| 224 | apikey: "MY-SUPER-SECRET-API-KEY" | 225 | apikey: "MY-SUPER-SECRET-API-KEY" |
| 225 | ``` | 226 | ``` |
| 227 | |||
| 228 | ## Healthchecks | ||
| 229 | |||
| 230 | This service displays information about the configured status checks from the Healthchecks application. | ||
| 231 | Two lines are needed in the config.yml : | ||
| 232 | |||
| 233 | ```yaml | ||
| 234 | type: "Healthchecks" | ||
| 235 | apikey: "01234deb70424befb1f4ef6a23456789" | ||
| 236 | ``` | ||
| 237 | |||
| 238 | The url must be the root url of the Healthchecks application. | ||
| 239 | The Healthchecks API key can be found in Settings > API Access > API key (read-only). The key is needed to access Healthchecks API. | ||