github
/
homer
mirror of https://github.com/bastienwirtz/homer
1
0
Fork 0
Code Issues Releases Wiki Activity

Custom services common options documentation

pull/307/head^2
Bastien Wirtz 2021-10-10 10:47:23 +02:00
parent 2fba043575
commit 3acfb01d99
1 changed files with 32 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
docs/customservices.md
View File

@ -6,6 +6,17 @@ within Homer.
If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. 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 ## PiHole
Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
@ -13,12 +24,11 @@ Using the PiHole service you can display info about your local PiHole instance r
The following configuration is available for the PiHole service. The following configuration is available for the PiHole service.
```yaml ```yaml
items: - name: "Pi-hole"
- name: "Pi-hole" logo: "assets/tools/sample.png"
logo: "assets/tools/sample.png" # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
# subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown url: "http://192.168.0.151/admin"
url: "http://192.168.0.151/admin" type: "PiHole"
type: "PiHole"
``` ```
## OpenWeatherMap ## OpenWeatherMap
@ -27,14 +37,13 @@ Using the OpenWeatherMap service you can display weather information about a giv
The following configuration is available for the OpenWeatherMap service: The following configuration is available for the OpenWeatherMap service:
```yaml ```yaml
items: - name: "Weather"
- name: "Weather" location: "Amsterdam" # your location.
location: "Amsterdam" # your location. locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
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.
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.
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.
background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. type: "OpenWeather"
type: "OpenWeather"
``` ```
**Remarks:** **Remarks:**
@ -46,8 +55,8 @@ This service displays News (grey), Warning (orange) or Error (red) notifications
Two lines are needed in the config.yml : Two lines are needed in the config.yml :
```yaml ```yaml
type: "Medusa" type: "Medusa"
apikey: "01234deb70424befb1f4ef6a23456789" apikey: "01234deb70424befb1f4ef6a23456789"
``` ```
The url must be the root url of Medusa application. The url must be the root url of Medusa application.
@ -59,8 +68,8 @@ This service displays Activity (blue), Warning (orange) or Error (red) notificat
Two lines are needed in the config.yml : Two lines are needed in the config.yml :
```yaml ```yaml
type: "Radarr" or "Sonarr" type: "Radarr" or "Sonarr"
apikey: "01234deb70424befb1f4ef6a23456789" apikey: "01234deb70424befb1f4ef6a23456789"
``` ```
The url must be the root url of Radarr/Sonarr application. The url must be the root url of Radarr/Sonarr application.
@ -75,10 +84,9 @@ For Paperless you need an API-Key which you have to store at the item in the fie
For Ping you need to set the type to Ping and provide a url. For Ping you need to set the type to Ping and provide a url.
```yaml ```yaml
items: - name: "Awesome app"
- name: "Awesome app" type: Ping
type: Ping logo: "assets/tools/sample.png"
logo: "assets/tools/sample.png" subtitle: "Bookmark example" tag: "app"
subtitle: "Bookmark example" tag: "app" url: "https://www.reddit.com/r/selfhosted/"
url: "https://www.reddit.com/r/selfhosted/"
``` ```