aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md5
-rw-r--r--docs/customservices.md59
2 files changed, 40 insertions, 24 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index 807fa68..c554297 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -26,6 +26,11 @@ footer: '<p>Created with <span class="has-text-danger">❤️</span> with <a hre
26columns: "3" # "auto" or number (must be a factor of 12: 1, 2, 3, 4, 6, 12) 26columns: "3" # "auto" or number (must be a factor of 12: 1, 2, 3, 4, 6, 12)
27connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example) 27connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example)
28 28
29# Optional: Proxy / hosting option
30proxy:
31 # NOT All custom services implements this new option YET. Support will be extended very soon.
32 useCredentials: false # send cookies & authorization headers when fetching service specific data. Set to `true` if you use an authentication proxy. Can be overrided on service level.
33
29# Optional theming 34# Optional theming
30theme: default # 'default' or one of the themes available in 'src/assets/themes'. 35theme: default # 'default' or one of the themes available in 'src/assets/themes'.
31 36
diff --git a/docs/customservices.md b/docs/customservices.md
index f79428f..ef84948 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -6,6 +6,20 @@ 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 useCredentials: false # Optional: Override global proxy.useCredentials configuration.
18 type: "<type>"
19```
20
21⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon).
22
9## PiHole 23## PiHole
10 24
11Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. 25Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
@@ -13,12 +27,11 @@ Using the PiHole service you can display info about your local PiHole instance r
13The following configuration is available for the PiHole service. 27The following configuration is available for the PiHole service.
14 28
15```yaml 29```yaml
16 items: 30- name: "Pi-hole"
17 - name: "Pi-hole" 31 logo: "assets/tools/sample.png"
18 logo: "assets/tools/sample.png" 32 # 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 33 url: "http://192.168.0.151/admin"
20 url: "http://192.168.0.151/admin" 34 type: "PiHole"
21 type: "PiHole"
22``` 35```
23 36
24## OpenWeatherMap 37## OpenWeatherMap
@@ -27,14 +40,13 @@ Using the OpenWeatherMap service you can display weather information about a giv
27The following configuration is available for the OpenWeatherMap service: 40The following configuration is available for the OpenWeatherMap service:
28 41
29```yaml 42```yaml
30items: 43- name: "Weather"
31 - name: "Weather" 44 location: "Amsterdam" # your location.
32 location: "Amsterdam" # your location. 45 locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
33 locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy 46 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. 47 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. 48 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. 49 type: "OpenWeather"
37 type: "OpenWeather"
38``` 50```
39 51
40**Remarks:** 52**Remarks:**
@@ -46,8 +58,8 @@ This service displays News (grey), Warning (orange) or Error (red) notifications
46Two lines are needed in the config.yml : 58Two lines are needed in the config.yml :
47 59
48```yaml 60```yaml
49type: "Medusa" 61 type: "Medusa"
50apikey: "01234deb70424befb1f4ef6a23456789" 62 apikey: "01234deb70424befb1f4ef6a23456789"
51``` 63```
52 64
53The url must be the root url of Medusa application. 65The url must be the root url of Medusa application.
@@ -59,8 +71,8 @@ This service displays Activity (blue), Warning (orange) or Error (red) notificat
59Two lines are needed in the config.yml : 71Two lines are needed in the config.yml :
60 72
61```yaml 73```yaml
62type: "Radarr" or "Sonarr" 74 type: "Radarr" or "Sonarr"
63apikey: "01234deb70424befb1f4ef6a23456789" 75 apikey: "01234deb70424befb1f4ef6a23456789"
64``` 76```
65 77
66The url must be the root url of Radarr/Sonarr application. 78The url must be the root url of Radarr/Sonarr application.
@@ -75,10 +87,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. 87For Ping you need to set the type to Ping and provide a url.
76 88
77```yaml 89```yaml
78items: 90- name: "Awesome app"
79 - name: "Awesome app" 91 type: Ping
80 type: Ping 92 logo: "assets/tools/sample.png"
81 logo: "assets/tools/sample.png" 93 subtitle: "Bookmark example" tag: "app"
82 subtitle: "Bookmark example" tag: "app" 94 url: "https://www.reddit.com/r/selfhosted/"
83 url: "https://www.reddit.com/r/selfhosted/"
84``` 95```