aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorArtur Bauer <bauerart1@gmail.com>2021-10-10 22:20:34 +0200
committerArtur Bauer <bauerart1@gmail.com>2021-10-10 22:20:34 +0200
commit277dafafa958c970af1a36783cb9e03da2944717 (patch)
tree0d34f0554a268c22a5cb20a10d9b8d67d1705684
parent8d9cfa98bdeb88445f2f33d630998ac9b1f0dcd7 (diff)
downloadhomer-277dafafa958c970af1a36783cb9e03da2944717.tar.gz
homer-277dafafa958c970af1a36783cb9e03da2944717.tar.zst
homer-277dafafa958c970af1a36783cb9e03da2944717.zip
Update docs
-rw-r--r--docs/customservices.md23
1 files changed, 17 insertions, 6 deletions
diff --git a/docs/customservices.md b/docs/customservices.md
index ef84948..548af96 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -6,16 +6,15 @@ 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 9## Common options
11 10
12```yaml 11```yaml
13- name: "My Service" 12- name: 'My Service'
14 logo: "assets/tools/sample.png" 13 logo: 'assets/tools/sample.png'
15 url: "http://my-service-link" 14 url: 'http://my-service-link'
16 endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary. 15 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. 16 useCredentials: false # Optional: Override global proxy.useCredentials configuration.
18 type: "<type>" 17 type: '<type>'
19``` 18```
20 19
21⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon). 20⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon).
@@ -93,3 +92,15 @@ For Ping you need to set the type to Ping and provide a url.
93 subtitle: "Bookmark example" tag: "app" 92 subtitle: "Bookmark example" tag: "app"
94 url: "https://www.reddit.com/r/selfhosted/" 93 url: "https://www.reddit.com/r/selfhosted/"
95``` 94```
95
96## Prometheus
97
98For Prometheus you need to set the type to Prometheus and provide a url.
99
100```yaml
101- name: "Prometheus"
102 type: Prometheus
103 logo: "assets/tools/sample.png"
104 url: "http://192.168.0.151/"
105 # subtitle: "Monitor data server"
106```