If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
+
+## Common options
+
+```yaml
+- name: "My Service"
+ logo: "assets/tools/sample.png"
+ url: "http://my-service-link"
+ endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary.
+ type: "<type>"
+```
+
## 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.
```yaml
- 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"
+- 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
The following configuration is available for the OpenWeatherMap service:
```yaml
-items:
- - name: "Weather"
- location: "Amsterdam" # your location.
- locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
- 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"
+- name: "Weather"
+ location: "Amsterdam" # your location.
+ locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
+ 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:**
Two lines are needed in the config.yml :
```yaml
-type: "Medusa"
-apikey: "01234deb70424befb1f4ef6a23456789"
+ type: "Medusa"
+ apikey: "01234deb70424befb1f4ef6a23456789"
```
The url must be the root url of Medusa application.
Two lines are needed in the config.yml :
```yaml
-type: "Radarr" or "Sonarr"
-apikey: "01234deb70424befb1f4ef6a23456789"
+ type: "Radarr" or "Sonarr"
+ apikey: "01234deb70424befb1f4ef6a23456789"
```
The url must be the root url of Radarr/Sonarr application.
For Ping you need to set the type to Ping and provide a url.
```yaml
-items:
- - name: "Awesome app"
- type: Ping
- logo: "assets/tools/sample.png"
- subtitle: "Bookmark example" tag: "app"
- url: "https://www.reddit.com/r/selfhosted/"
+- name: "Awesome app"
+ type: Ping
+ logo: "assets/tools/sample.png"
+ subtitle: "Bookmark example" tag: "app"
+ url: "https://www.reddit.com/r/selfhosted/"
```