]> git.immae.eu Git - github/bastienwirtz/homer.git/blame - docs/customservices.md
Added location id
[github/bastienwirtz/homer.git] / docs / customservices.md
CommitLineData
dfb0b146 1# Custom Services
fd12de9e 2
9e0ef05e 3Here is an overview of all custom services that are available within Homer.
fd12de9e
DW
4
5## PiHole
6
7Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
8
9The 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
22Using the OpenWeatherMap service you can display weather information about a given location.
23
24The following configuration is available for the OpenWeatherMap service
25
26```
27items:
dfb0b146 28 - name: "Weather"
dfb0b146
DW
29 location: "Amsterdam" # your location.
30 apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
31 units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
fb158d47 32 background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
dfb0b146 33 type: "OpenWeather"
fd12de9e 34```