aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--docs/customservices.md56
1 files changed, 32 insertions, 24 deletions
diff --git a/docs/customservices.md b/docs/customservices.md
index f79428f..8ea28ee 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -6,6 +6,17 @@ within Homer.
6 6
7If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. 7If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
8 8
9
10## Common options
11
12```yaml
13- name: "My Service"
14 logo: "assets/tools/sample.png"
15 url: "http://my-service-link"
16 endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary.
17 type: "<type>"
18```
19
9## PiHole 20## PiHole
10 21
11Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. 22Using 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
13The following configuration is available for the PiHole service. 24The following configuration is available for the PiHole service.
14 25
15```yaml 26```yaml
16 items: 27- name: "Pi-hole"
17 - name: "Pi-hole" 28 logo: "assets/tools/sample.png"
18 logo: "assets/tools/sample.png" 29 # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
19 # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown 30 url: "http://192.168.0.151/admin"
20 url: "http://192.168.0.151/admin" 31 type: "PiHole"
21 type: "PiHole"
22``` 32```
23 33
24## OpenWeatherMap 34## OpenWeatherMap
@@ -27,14 +37,13 @@ Using the OpenWeatherMap service you can display weather information about a giv
27The following configuration is available for the OpenWeatherMap service: 37The following configuration is available for the OpenWeatherMap service:
28 38
29```yaml 39```yaml
30items: 40- name: "Weather"
31 - name: "Weather" 41 location: "Amsterdam" # your location.
32 location: "Amsterdam" # your location. 42 locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
33 locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy 43 apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
34 apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. 44 units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
35 units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. 45 background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
36 background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. 46 type: "OpenWeather"
37 type: "OpenWeather"
38``` 47```
39 48
40**Remarks:** 49**Remarks:**
@@ -46,8 +55,8 @@ This service displays News (grey), Warning (orange) or Error (red) notifications
46Two lines are needed in the config.yml : 55Two lines are needed in the config.yml :
47 56
48```yaml 57```yaml
49type: "Medusa" 58 type: "Medusa"
50apikey: "01234deb70424befb1f4ef6a23456789" 59 apikey: "01234deb70424befb1f4ef6a23456789"
51``` 60```
52 61
53The url must be the root url of Medusa application. 62The url must be the root url of Medusa application.
@@ -59,8 +68,8 @@ This service displays Activity (blue), Warning (orange) or Error (red) notificat
59Two lines are needed in the config.yml : 68Two lines are needed in the config.yml :
60 69
61```yaml 70```yaml
62type: "Radarr" or "Sonarr" 71 type: "Radarr" or "Sonarr"
63apikey: "01234deb70424befb1f4ef6a23456789" 72 apikey: "01234deb70424befb1f4ef6a23456789"
64``` 73```
65 74
66The url must be the root url of Radarr/Sonarr application. 75The 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
75For Ping you need to set the type to Ping and provide a url. 84For Ping you need to set the type to Ping and provide a url.
76 85
77```yaml 86```yaml
78items: 87- name: "Awesome app"
79 - name: "Awesome app" 88 type: Ping
80 type: Ping 89 logo: "assets/tools/sample.png"
81 logo: "assets/tools/sample.png" 90 subtitle: "Bookmark example" tag: "app"
82 subtitle: "Bookmark example" tag: "app" 91 url: "https://www.reddit.com/r/selfhosted/"
83 url: "https://www.reddit.com/r/selfhosted/"
84``` 92```