From 277dafafa958c970af1a36783cb9e03da2944717 Mon Sep 17 00:00:00 2001 From: Artur Bauer Date: Sun, 10 Oct 2021 22:20:34 +0200 Subject: Update docs --- docs/customservices.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) (limited to 'docs') 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. If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. - ## Common options ```yaml -- name: "My Service" - logo: "assets/tools/sample.png" - url: "http://my-service-link" - endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary. +- name: 'My Service' + logo: 'assets/tools/sample.png' + url: 'http://my-service-link' + endpoint: 'http://my-service-endpoint' # Optional: alternative base URL used to fetch service data is necessary. useCredentials: false # Optional: Override global proxy.useCredentials configuration. - type: "" + type: '' ``` ⚠️🚧 `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. subtitle: "Bookmark example" tag: "app" url: "https://www.reddit.com/r/selfhosted/" ``` + +## Prometheus + +For Prometheus you need to set the type to Prometheus and provide a url. + +```yaml +- name: "Prometheus" + type: Prometheus + logo: "assets/tools/sample.png" + url: "http://192.168.0.151/" + # subtitle: "Monitor data server" +``` -- cgit v1.2.3 From 80ba98cf661801956f773bdfd0b0ded1b2f80487 Mon Sep 17 00:00:00 2001 From: Artur Bauer Date: Mon, 11 Oct 2021 18:38:13 +0200 Subject: Code review fixes --- docs/customservices.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'docs') 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. If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. + ## Common options ```yaml -- name: 'My Service' - logo: 'assets/tools/sample.png' - url: 'http://my-service-link' - endpoint: 'http://my-service-endpoint' # Optional: alternative base URL used to fetch service data is necessary. +- name: "My Service" + logo: "assets/tools/sample.png" + url: "http://my-service-link" + endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary. useCredentials: false # Optional: Override global proxy.useCredentials configuration. - type: '' + type: "" ``` ⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon). -- cgit v1.2.3