PiAlert custom service (#674)

[github/bastienwirtz/homer.git] / docs / customservices.md

diff --git a/docs/customservices.md b/docs/customservices.md
index ca88d853b43d83e595faaae57178b339a8abc9b9..cb897a2883f1350fb0bad68faa60a3bc4e3750a9 100644 (file)
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -33,6 +33,7 @@ within Homer:
   - [SABnzbd](#sabnzbd)
   - [OctoPrint](#octoprint)
   - [Tdarr](#tdarr)
+  - [PiAlert](#pialert)
   - [Immich](#immich)
 
 If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
@@ -413,6 +414,16 @@ for transcoding on your Tdarr instance as well as the number of errored items.
   checkInterval: 5000 # (Optional) Interval (in ms) for updating the queue & error counts
 ```
 
+## PiAlert
+
+The PiAlert service displays stats from your PiAlert server.
+
+```yaml
+- name: "PiAlert"
+  type: "PiAlert"
+  updateInterval: 5000 # (Optional) Interval (in ms) for updating the stats
+```
+
 ## Immich
 
 The Immich service displays stats from your Immich server.
@@ -422,4 +433,4 @@ The Immich service displays stats from your Immich server.
   type: "Immich"
   apikey: "<--- Your api key --->" # administrator user
   updateInterval: 5000 # (Optional) Interval (in ms) for updating the stats
-```
\ No newline at end of file
+```