aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/customservices.md
diff options
context:
space:
mode:
authorArtur Bauer <bauerart1@gmail.com>2021-10-11 18:38:13 +0200
committerArtur Bauer <bauerart1@gmail.com>2021-10-11 18:41:28 +0200
commit80ba98cf661801956f773bdfd0b0ded1b2f80487 (patch)
tree5f182427f12528dfa637a90f5901ea59bd8b2d3b /docs/customservices.md
parent277dafafa958c970af1a36783cb9e03da2944717 (diff)
downloadhomer-80ba98cf661801956f773bdfd0b0ded1b2f80487.tar.gz
homer-80ba98cf661801956f773bdfd0b0ded1b2f80487.tar.zst
homer-80ba98cf661801956f773bdfd0b0ded1b2f80487.zip
Code review fixes
Diffstat (limited to 'docs/customservices.md')
-rw-r--r--docs/customservices.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/customservices.md b/docs/customservices.md
index 548af96..7a151d1 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -6,15 +6,16 @@ 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
9## Common options 10## Common options
10 11
11```yaml 12```yaml
12- name: 'My Service' 13- name: "My Service"
13 logo: 'assets/tools/sample.png' 14 logo: "assets/tools/sample.png"
14 url: 'http://my-service-link' 15 url: "http://my-service-link"
15 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.
16 useCredentials: false # Optional: Override global proxy.useCredentials configuration. 17 useCredentials: false # Optional: Override global proxy.useCredentials configuration.
17 type: '<type>' 18 type: "<type>"
18``` 19```
19 20
20⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon). 21⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon).