aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/customservices.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/customservices.md')
-rw-r--r--docs/customservices.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/customservices.md b/docs/customservices.md
index 6a54400..c9ce093 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -20,6 +20,7 @@ within Homer:
20+ [Uptime Kuma](#uptime-kuma) 20+ [Uptime Kuma](#uptime-kuma)
21+ [Tautulli](#tautulli) 21+ [Tautulli](#tautulli)
22+ [Mealie](#mealie) 22+ [Mealie](#mealie)
23+ [Healthchecks](#healthchecks)
23 24
24If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. 25If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
25 26
@@ -229,3 +230,16 @@ endpoint pointing to Tautulli!
229 230
230First off make sure to remove an existing `subtitle` as it will take precedence if set. 231First off make sure to remove an existing `subtitle` as it will take precedence if set.
231Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized or the planned meal for today if one is planned. You will have to set an API key in the field `apikey` which can be created in your Mealie installation. 232Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized or the planned meal for today if one is planned. You will have to set an API key in the field `apikey` which can be created in your Mealie installation.
233
234## Healthchecks
235
236This service displays information about the configured status checks from the Healthchecks application.
237Two lines are needed in the config.yml :
238
239```yaml
240 type: "Healthchecks"
241 apikey: "01234deb70424befb1f4ef6a23456789"
242```
243
244The url must be the root url of the Healthchecks application.
245The Healthchecks API key can be found in Settings > API Access > API key (read-only). The key is needed to access Healthchecks API.