aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md3
-rw-r--r--docs/customservices.md3
2 files changed, 5 insertions, 1 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index 0dd0a85..e4ddfcf 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -26,7 +26,8 @@ connectivityCheck: true # whether you want to display a message when the apps ar
26 26
27# Optional: Proxy / hosting option 27# Optional: Proxy / hosting option
28proxy: 28proxy:
29 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. 29 # NOT All custom services implements this new option YET. Support will be extended very soon.
30 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.
30 31
31# Optional theming 32# Optional theming
32theme: default # 'default' or one of the themes available in 'src/assets/themes'. 33theme: default # 'default' or one of the themes available in 'src/assets/themes'.
diff --git a/docs/customservices.md b/docs/customservices.md
index 8ea28ee..ef84948 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -14,9 +14,12 @@ If you experiencing any issue, please have a look to the [troubleshooting](troub
14 logo: "assets/tools/sample.png" 14 logo: "assets/tools/sample.png"
15 url: "http://my-service-link" 15 url: "http://my-service-link"
16 endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary. 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.
17 type: "<type>" 18 type: "<type>"
18``` 19```
19 20
21⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon).
22
20## PiHole 23## PiHole
21 24
22Using 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.