mirror of https://github.com/bastienwirtz/homer
Custom services common options documentation
parent
2fba043575
commit
3acfb01d99
|
@ -6,6 +6,17 @@ within Homer.
|
|||
|
||||
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.
|
||||
|
@ -13,7 +24,6 @@ Using the PiHole service you can display info about your local PiHole instance r
|
|||
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
|
||||
|
@ -27,7 +37,6 @@ Using the OpenWeatherMap service you can display weather information about a giv
|
|||
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
|
||||
|
@ -75,7 +84,6 @@ 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.
|
||||
|
||||
```yaml
|
||||
items:
|
||||
- name: "Awesome app"
|
||||
type: Ping
|
||||
logo: "assets/tools/sample.png"
|
||||
|
|
Loading…
Reference in New Issue