From fd12de9ebd7a75ca2f31e8b28bd2c5ac10c46e21 Mon Sep 17 00:00:00 2001 From: Dick Wolff Date: Wed, 13 Jan 2021 21:22:35 +0100 Subject: Improvements --- docs/configuration.md | 4 +++- docs/customservices.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 docs/customservices.md (limited to 'docs') diff --git a/docs/configuration.md b/docs/configuration.md index a43d7f1..6c6a444 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -7,7 +7,7 @@ Title, icons, links, colors, and services can be configured in the `config.yml` # Homepage configuration # See https://fontawesome.com/icons for icons options -# Optional: Use external configuration file. +# Optional: Use external configuration file. # Using this will ignore remaining config in this file # externalConfig: https://example.com/server-luci/config.yaml @@ -118,6 +118,8 @@ services: # background: red # optional color for card to set color directly without custom stylesheet ``` +View the (Custom Services)[customservices.md] file for details about all available custom services (like PiHole). + If you choose to fetch message information from an endpoint, the output format should be: ```json diff --git a/docs/customservices.md b/docs/customservices.md new file mode 100644 index 0000000..42bd87d --- /dev/null +++ b/docs/customservices.md @@ -0,0 +1,35 @@ +# Tips & Tricks + +Here is an overview of all custom services that are avaiable within Homer. + +## 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. + +``` + 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" +``` + +## OpenWeatherMap + +Using the OpenWeatherMap service you can display weather information about a given location. + +The following configuration is available for the OpenWeatherMap service + +``` +items: + - name: "Weather" + url: "https://api.openweathermap.org/data/2.5/weather" + location: "Amsterdam" # your location. + 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" +``` -- cgit v1.2.3