[github/bastienwirtz/homer.git] / docs / customservices.md

# Custom Services

Here is an overview of all custom services that are available 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"
       location: "Amsterdam" # your location.
       locationId: "2759794" # OpenWeatherMap city ID.
       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:**
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).
Commit	Line	Data
dfb0b146	1	# Custom Services
fd12de9e	2
9e0ef05e	3	Here is an overview of all custom services that are available within Homer.
fd12de9e DW	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:
dfb0b146	28	- name: "Weather"
dfb0b146	29	location: "Amsterdam" # your location.
97f0c43c	30	locationId: "2759794" # OpenWeatherMap city ID.
dfb0b146 DW	31	apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
dfb0b146 DW	32	units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
fb158d47	33	background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
dfb0b146	34	type: "OpenWeather"
fd12de9e	35	```
97f0c43c DW	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).