Merge branch 'main' into main

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

diff --git a/docs/customservices.md b/docs/customservices.md
index 40f2e3dbdd351b29825d9c5420d1cda369c67a65..4f64eccb536d7f14e23e1e49eddfbd1e4b6dbfd9 100644 (file)
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -1,6 +1,8 @@
 # Custom Services
 
-Here is an overview of all custom services that are available within Homer.
+Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml
+configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available 
+within Homer.
 
 ## PiHole
 
@@ -17,6 +19,7 @@ The following configuration is available for the PiHole service.
         type: "PiHole"
 ```
 
+
 ## OpenWeatherMap
 
 Using the OpenWeatherMap service you can display weather information about a given location.
@@ -35,4 +38,38 @@ items:
 ```
 
 **Remarks:**
-If for some reason your city can't be found by entering the name in the `location` property, you could also try to configure the OWM city ID in the `locationId` property. To retrieve your specific City ID, go to the [OWM website](https://openweathermap.org), search for your city and retrieve the ID from the URL (for example, the City ID of Amsterdam is 2759794).
\ No newline at end of file
+If for some reason your city can't be found by entering the name in the `location` property, you could also try to configure the OWM city ID in the `locationId` property. To retrieve your specific City ID, go to the [OWM website](https://openweathermap.org), search for your city and retrieve the ID from the URL (for example, the City ID of Amsterdam is 2759794).
+
+
+## Medusa
+
+This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
+Two lines are needed in the config.yml :
+```
+type: "Medusa"
+apikey: "01234deb70424befb1f4ef6a23456789"
+```
+The url must be the root url of Medusa application.
+The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
+
+
+## Sonarr/Radarr
+
+This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application.
+Two lines are needed in the config.yml :
+```
+type: "Radarr" or "Sonarr"
+apikey: "01234deb70424befb1f4ef6a23456789"
+```
+The url must be the root url of Radarr/Sonarr application.
+The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.
+
+
+## PaperlessNG
+
+For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
+
+
+## Ping
+
+For Ping you need an API-Key which you have to store at the item in the field `apikey`.