docs/customservices.md

   1 # Custom Services
   2
   3 Here is an overview of all custom services that are available within Homer.
   4
   5 ## PiHole
   6
   7 Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
   8
   9 The following configuration is available for the PiHole service.
  10
  11 ```
  12  items:
  13       - name: "Pi-hole"
  14         logo: "assets/tools/sample.png"
  15         # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
  16         url: "http://192.168.0.151/admin"
  17         type: "PiHole"
  18 ```
  19
  20 ## OpenWeatherMap
  21
  22 Using the OpenWeatherMap service you can display weather information about a given location.
  23
  24 The following configuration is available for the OpenWeatherMap service
  25
  26 ```
  27 items:
  28      - name: "Weather"
  29        location: "Amsterdam" # your location.
  30        locationId: "2759794" # OpenWeatherMap city ID.
  31        apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
  32        units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
  33        background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
  34        type: "OpenWeather"
  35 ```
  36
  37 **Remarks:**
  38 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).