From fea0f0904537db7ca164b1cb29ffcfcbb807a709 Mon Sep 17 00:00:00 2001 From: Bastien Wirtz Date: Sun, 10 Oct 2021 09:46:51 +0200 Subject: Proxy settings documentation --- docs/configuration.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs') diff --git a/docs/configuration.md b/docs/configuration.md index d90981a..b1cce56 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -24,6 +24,10 @@ footer: '

Created with ❤️ with Date: Sun, 10 Oct 2021 10:16:18 +0200 Subject: Allow any service to override the credentials option --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/configuration.md b/docs/configuration.md index b1cce56..0dd0a85 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -26,7 +26,7 @@ connectivityCheck: true # whether you want to display a message when the apps ar # Optional: Proxy / hosting option proxy: - useCredentials: false # send cookies & authorization headers when fetching service specific data. Set to `true` if you use an authentication proxy. + 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. # Optional theming theme: default # 'default' or one of the themes available in 'src/assets/themes'. -- cgit v1.2.3 From 3acfb01d999527b609c08cd0790d3bb6bc2e2560 Mon Sep 17 00:00:00 2001 From: Bastien Wirtz Date: Sun, 10 Oct 2021 10:47:23 +0200 Subject: Custom services common options documentation --- docs/customservices.md | 56 ++++++++++++++++++++++++++++---------------------- 1 file changed, 32 insertions(+), 24 deletions(-) (limited to 'docs') diff --git a/docs/customservices.md b/docs/customservices.md index f79428f..8ea28ee 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -6,6 +6,17 @@ 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. + type: "" +``` + ## PiHole Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. @@ -13,12 +24,11 @@ Using the PiHole service you can display info about your local PiHole instance r The following configuration is available for the PiHole service. ```yaml - items: - - name: "Pi-hole" - logo: "assets/tools/sample.png" - # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown - url: "http://192.168.0.151/admin" - type: "PiHole" +- name: "Pi-hole" + logo: "assets/tools/sample.png" + # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown + url: "http://192.168.0.151/admin" + type: "PiHole" ``` ## OpenWeatherMap @@ -27,14 +37,13 @@ Using the OpenWeatherMap service you can display weather information about a giv The following configuration is available for the OpenWeatherMap service: ```yaml -items: - - name: "Weather" - location: "Amsterdam" # your location. - locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy - apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. - units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. - background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. - type: "OpenWeather" +- name: "Weather" + location: "Amsterdam" # your location. + locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy + apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. + units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. + background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. + type: "OpenWeather" ``` **Remarks:** @@ -46,8 +55,8 @@ This service displays News (grey), Warning (orange) or Error (red) notifications Two lines are needed in the config.yml : ```yaml -type: "Medusa" -apikey: "01234deb70424befb1f4ef6a23456789" + type: "Medusa" + apikey: "01234deb70424befb1f4ef6a23456789" ``` The url must be the root url of Medusa application. @@ -59,8 +68,8 @@ This service displays Activity (blue), Warning (orange) or Error (red) notificat Two lines are needed in the config.yml : ```yaml -type: "Radarr" or "Sonarr" -apikey: "01234deb70424befb1f4ef6a23456789" + type: "Radarr" or "Sonarr" + apikey: "01234deb70424befb1f4ef6a23456789" ``` The url must be the root url of Radarr/Sonarr application. @@ -75,10 +84,9 @@ For Paperless you need an API-Key which you have to store at the item in the fie For Ping you need to set the type to Ping and provide a url. ```yaml -items: - - name: "Awesome app" - type: Ping - logo: "assets/tools/sample.png" - subtitle: "Bookmark example" tag: "app" - url: "https://www.reddit.com/r/selfhosted/" +- name: "Awesome app" + type: Ping + logo: "assets/tools/sample.png" + subtitle: "Bookmark example" tag: "app" + url: "https://www.reddit.com/r/selfhosted/" ``` -- cgit v1.2.3 From 66a434e7dba49011dd5401e32bb45ab180a73a11 Mon Sep 17 00:00:00 2001 From: Bastien Wirtz Date: Sun, 10 Oct 2021 20:57:04 +0200 Subject: Implementation status warning --- docs/configuration.md | 3 ++- docs/customservices.md | 3 +++ 2 files changed, 5 insertions(+), 1 deletion(-) (limited to 'docs') 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 # Optional: Proxy / hosting option proxy: - 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. + # NOT All custom services implements this new option YET. Support will be extended very soon. + 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. # Optional theming theme: 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 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: "" ``` +⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon). + ## PiHole Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. -- cgit v1.2.3