From 3acfb01d999527b609c08cd0790d3bb6bc2e2560 Mon Sep 17 00:00:00 2001
From: Bastien Wirtz <bastien.wirtz@gmail.com>
Date: Sun, 10 Oct 2021 10:47:23 +0200
Subject: Custom services common options documentation

---
 docs/customservices.md | 56 ++++++++++++++++++++++++++++----------------------
 1 file changed, 32 insertions(+), 24 deletions(-)

diff --git a/docs/customservices.md b/docs/customservices.md
index f79428f..8ea28ee 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -6,6 +6,17 @@ within Homer.
 
 If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
 
+
+## Common options
+
+```yaml
+- name: "My Service"
+  logo: "assets/tools/sample.png"
+  url: "http://my-service-link"
+  endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary.
+  type: "<type>"
+```
+
 ## PiHole
 
 Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
@@ -13,12 +24,11 @@ Using the PiHole service you can display info about your local PiHole instance r
 The following configuration is available for the PiHole service.
 
 ```yaml
- items:
-      - name: "Pi-hole"
-        logo: "assets/tools/sample.png"
-        # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
-        url: "http://192.168.0.151/admin"
-        type: "PiHole"
+- name: "Pi-hole"
+  logo: "assets/tools/sample.png"
+  # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
+  url: "http://192.168.0.151/admin"
+  type: "PiHole"
 ```
 
 ## OpenWeatherMap
@@ -27,14 +37,13 @@ Using the OpenWeatherMap service you can display weather information about a giv
 The following configuration is available for the OpenWeatherMap service:
 
 ```yaml
-items:
-     - name: "Weather"
-       location: "Amsterdam" # your location.
-       locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
-       apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
-       units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
-       background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
-       type: "OpenWeather"
+- name: "Weather"
+  location: "Amsterdam" # your location.
+  locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
+  apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
+  units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
+  background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
+  type: "OpenWeather"
 ```
 
 **Remarks:**
@@ -46,8 +55,8 @@ This service displays News (grey), Warning (orange) or Error (red) notifications
 Two lines are needed in the config.yml :
 
 ```yaml
-type: "Medusa"
-apikey: "01234deb70424befb1f4ef6a23456789"
+  type: "Medusa"
+  apikey: "01234deb70424befb1f4ef6a23456789"
 ```
 
 The url must be the root url of Medusa application.
@@ -59,8 +68,8 @@ This service displays Activity (blue), Warning (orange) or Error (red) notificat
 Two lines are needed in the config.yml :
 
 ```yaml
-type: "Radarr" or "Sonarr"
-apikey: "01234deb70424befb1f4ef6a23456789"
+  type: "Radarr" or "Sonarr"
+  apikey: "01234deb70424befb1f4ef6a23456789"
 ```
 
 The url must be the root url of Radarr/Sonarr application.
@@ -75,10 +84,9 @@ For Paperless you need an API-Key which you have to store at the item in the fie
 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/" 
+- name: "Awesome app"
+  type: Ping
+  logo: "assets/tools/sample.png"
+  subtitle: "Bookmark example" tag: "app" 
+  url: "https://www.reddit.com/r/selfhosted/" 
 ```
-- 
cgit v1.2.3