homer/docs/customservices.md

35 lines
1.2 KiB
Markdown
Raw Normal View History

2021-01-13 21:25:07 +01:00
# Custom Services
2021-01-13 21:22:35 +01:00
2021-01-13 21:27:19 +01:00
Here is an overview of all custom services that are available within Homer.
2021-01-13 21:22:35 +01:00
## 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:
2021-01-13 21:25:07 +01:00
- name: "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.
2021-01-13 22:19:17 +01:00
background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
2021-01-13 21:25:07 +01:00
type: "OpenWeather"
2021-01-13 21:22:35 +01:00
```