X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=docs%2Fcustomservices.md;h=f79428fc7afa6898f1aee579ecf2982a39583622;hb=b2f6da03829fb7cff4df3e2a9af5f6675fd0ae42;hp=150e232fd002e406f04f31e38d454fe322aedbf9;hpb=4eeed6596bc79d340d8b3e4dd7d0efa5aa358efc;p=github%2Fbastienwirtz%2Fhomer.git

diff --git a/docs/customservices.md b/docs/customservices.md
index 150e232..f79428f 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -1,16 +1,18 @@
 # Custom Services
 
 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 
+configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available
 within Homer.
 
+If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
+
 ## PiHole
 
 Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
 
 The following configuration is available for the PiHole service.
 
-```
+```yaml
  items:
       - name: "Pi-hole"
         logo: "assets/tools/sample.png"
@@ -19,13 +21,12 @@ 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.
 The following configuration is available for the OpenWeatherMap service:
 
-```
+```yaml
 items:
      - name: "Weather"
        location: "Amsterdam" # your location.
@@ -39,36 +40,45 @@ 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).
 
-
 ## 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 :
-```
+
+```yaml
 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 :
-```
+
+```yaml
 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`.
+For Ping you need to set the type to Ping and provide a url.
+
+```yaml
+items:
+   - name: "Awesome app"
+     type: Ping
+     logo: "assets/tools/sample.png"
+     subtitle: "Bookmark example" tag: "app" 
+     url: "https://www.reddit.com/r/selfhosted/" 
+```