From 5db2414d052af629e2848f53ce9c2e0e686eefaf Mon Sep 17 00:00:00 2001 From: Aryess Date: Tue, 12 Oct 2021 11:28:41 +1100 Subject: Fix #121 - Change default theme and layout from config --- docs/configuration.md | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs') diff --git a/docs/configuration.md b/docs/configuration.md index 50b5bd5..65fd018 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -29,6 +29,11 @@ proxy: # 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. +# Set the default layout and color scheme +defaults: + layout: columns # Either 'columns', or 'list' + colorTheme: auto # One of 'auto', 'light', or 'dark' + # Optional theming theme: default # 'default' or one of the themes available in 'src/assets/themes'. -- cgit v1.2.3 From 0121fa8036caaa1f7136564a06da0e5aab697813 Mon Sep 17 00:00:00 2001 From: Paul Hagedorn Date: Tue, 2 Nov 2021 18:28:47 +0100 Subject: docs: add Lidarr service to customservices.md --- docs/customservices.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/customservices.md b/docs/customservices.md index 3b3320d..311a4f2 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -65,18 +65,18 @@ Two lines are needed in the config.yml : The url must be the root url of Medusa application. The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. -## Sonarr/Radarr +## Lidarr, Sonarr and Radarr -This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. +This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Lidarr, Radarr or Sonarr application. Two lines are needed in the config.yml : ```yaml - type: "Radarr" or "Sonarr" + type: "Lidarr", "Radarr" or "Sonarr" apikey: "01234deb70424befb1f4ef6a23456789" ``` -The url must be the root url of Radarr/Sonarr application. -The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. +The url must be the root url of Lidarr, Radarr or Sonarr application. +The Lidarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API. ## PaperlessNG -- cgit v1.2.3 From 9c77651692468ba68f631e03b22a6227b5759240 Mon Sep 17 00:00:00 2001 From: Bastien Wirtz Date: Sun, 12 Dec 2021 22:20:10 +0100 Subject: Last batch of custom services refacto. --- docs/configuration.md | 1 - docs/customservices.md | 2 -- 2 files changed, 3 deletions(-) (limited to 'docs') diff --git a/docs/configuration.md b/docs/configuration.md index e2b5506..552b22a 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -29,7 +29,6 @@ connectivityCheck: true # whether you want to display a message when the apps ar # Optional: Proxy / hosting option proxy: - # 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 diff --git a/docs/customservices.md b/docs/customservices.md index 3b3320d..6850bbb 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -18,8 +18,6 @@ If you experiencing any issue, please have a look to the [troubleshooting](troub 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 From a9cdf5704383888e641947982902b0768a934fdb Mon Sep 17 00:00:00 2001 From: BTK <45247934+b-t-k@users.noreply.github.com> Date: Wed, 15 Dec 2021 12:58:56 -0700 Subject: Typo: should have "s" in alias --- docs/tips-and-tricks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/tips-and-tricks.md b/docs/tips-and-tricks.md index 17bba9a..6f1b995 100644 --- a/docs/tips-and-tricks.md +++ b/docs/tips-and-tricks.md @@ -51,7 +51,7 @@ and then simply reference these pre-defined (anchored) tags in each item like so - name: "VS Code" logo: "/assets/vscode.png" subtitle: "Develop Code Anywhere, On Anything!" - <<: *App # Reference to the predefined "App" Tag + <<: *Apps # Reference to the predefined "App" Tag url: "https://vscode.example.com/" target: "_blank" # optional html tag target attribute ```` -- cgit v1.2.3 From ad8efdc799fb066a50aeb4ee28a388239f7b9fc8 Mon Sep 17 00:00:00 2001 From: Michael Krieger Date: Mon, 20 Dec 2021 16:11:15 -0500 Subject: Warn about exposed apikeys --- docs/customservices.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/customservices.md b/docs/customservices.md index 7d47542..77109b7 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -1,7 +1,11 @@ # Custom Services Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml -configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available +configuration and, where applicable, an apikey. Note that config.yml is exposed at /assets/config.yml via HTTP and any +apikey included in the configuration file is exposed to anyone who can access the homer instance. Only include an apikey +if your homer instance is secured behind some form of authentication or access restriction. + +Available services are in `src/components/`. Here is an overview of all custom services that are available within Homer. If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. -- cgit v1.2.3 From 50b3bddff1545d800cc4deeaa6e73b6eb278460d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Catarino?= Date: Mon, 31 Jan 2022 13:14:40 +0100 Subject: Added Prowlarr doc --- docs/customservices.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/customservices.md b/docs/customservices.md index 77109b7..747d7a4 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -67,18 +67,18 @@ Two lines are needed in the config.yml : The url must be the root url of Medusa application. The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. -## Lidarr, Sonarr and Radarr +## Lidarr, Prowlarr, Sonarr and Radarr This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Lidarr, Radarr or Sonarr application. Two lines are needed in the config.yml : ```yaml - type: "Lidarr", "Radarr" or "Sonarr" + type: "Lidarr", "Prowlarr", "Radarr" or "Sonarr" apikey: "01234deb70424befb1f4ef6a23456789" ``` -The url must be the root url of Lidarr, Radarr or Sonarr application. -The Lidarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API. +The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application. +The Lidarr, Prowlarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API. ## PaperlessNG -- cgit v1.2.3 From 8ede30411ed1726ed3885fd617364924e677abc2 Mon Sep 17 00:00:00 2001 From: Duy NGUYEN Date: Tue, 1 Feb 2022 17:05:23 +0100 Subject: Radarr and Sonarr V3 api support optional --- docs/customservices.md | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'docs') diff --git a/docs/customservices.md b/docs/customservices.md index 77109b7..91c4051 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -79,6 +79,16 @@ Two lines are needed in the config.yml : The url must be the root url of Lidarr, Radarr or Sonarr application. The Lidarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API. +If you are using an older version of Radarr or Sonarr which don't support the new V3 api endpoints, add the following line to your service config "legacyApi: true", example: + +```yaml +- name: "Radarr" + type: "Radarr" + url: "http://localhost:8989/" + apikey: "MY-SUPER-SECRET-API-KEY" + target: "_blank" # optional html tag target attribute + legacyApi: true +``` ## PaperlessNG -- cgit v1.2.3 From f7f4ebdf667db848509f93d470cd46c648bb2439 Mon Sep 17 00:00:00 2001 From: Duy NGUYEN Date: Tue, 1 Feb 2022 18:32:25 +0100 Subject: Parse new V3 api response --- docs/customservices.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/customservices.md b/docs/customservices.md index 91c4051..9317907 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -84,9 +84,9 @@ If you are using an older version of Radarr or Sonarr which don't support the ne ```yaml - name: "Radarr" type: "Radarr" - url: "http://localhost:8989/" + url: "http://localhost:7878/" apikey: "MY-SUPER-SECRET-API-KEY" - target: "_blank" # optional html tag target attribute + target: "_blank" legacyApi: true ``` -- cgit v1.2.3 From e4b077843caac86d161b095173fd804abf194bef Mon Sep 17 00:00:00 2001 From: Sascha Brockel Date: Mon, 21 Feb 2022 22:04:51 +0100 Subject: Fix typos in troubleshooting --- docs/troubleshooting.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index ed1f85d..649e5a6 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -6,7 +6,7 @@ You might by facing a [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/C It happens when the targeted service is hosted on a different domain or port. Web browsers will not allow to fetch information from a different site without explicit permissions (the targeted service must include a special `Access-Control-Allow-Origin: *` HTTP headers). -If this happens your web console (`ctrl+shit+i` or `F12`) will be filled with this kind of errors: +If this happens your web console (`ctrl+shift+i` or `F12`) will be filled with this kind of errors: ```text Access to fetch at 'https://' from origin 'https://' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource. If an opaque response serves your needs, set the request's mode to 'no-cors' to fetch the resource with CORS disabled. @@ -15,5 +15,5 @@ Access to fetch at 'https://' from origin 'https://' has To resolve this, you can either: * Host all your target service under the same domain & port. -* Modify the target sever configuration so that the response of the server included following header- `Access-Control-Allow-Origin: *` (). It might be an option in the targeted service, otherwise depending on how the service is hosted, the proxy or web server can seamlessly add it. -* Use a cors proxy sever like [`cors-container`](https://github.com/imjacobclark/cors-container), [`cors-anywhere`](https://github.com/Rob--W/cors-anywhere) or many others. +* Modify the target server configuration so that the response of the server included following header- `Access-Control-Allow-Origin: *` (). It might be an option in the targeted service, otherwise depending on how the service is hosted, the proxy or web server can seamlessly add it. +* Use a cors proxy server like [`cors-container`](https://github.com/imjacobclark/cors-container), [`cors-anywhere`](https://github.com/Rob--W/cors-anywhere) or many others. -- cgit v1.2.3 From a1a70d4a3c6a8314dd2ad35344d440e4ba8e86e8 Mon Sep 17 00:00:00 2001 From: Evan Steinkerchner Date: Tue, 1 Mar 2022 20:55:45 -0500 Subject: Added Portainer custom service --- docs/customservices.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'docs') diff --git a/docs/customservices.md b/docs/customservices.md index 7e3e6b3..cb68e1d 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -125,3 +125,19 @@ For Prometheus you need to set the type to Prometheus and provide a url. url: "http://192.168.0.151/" # subtitle: "Monitor data server" ``` + +## Portainer + +This service displays info about the total number of containers managed by your Portainer instance. +In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass +it to the apikey field. + +See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens + +```yaml +- name: "Portainer" + logo: "assets/tools/sample.png" + url: "http://192.168.0.151/" + type: "Portainer" + apikey: "MY-SUPER-SECRET-API-KEY" +``` -- cgit v1.2.3 From e2ebf9973bec9884154093d6bd7a9688261e6fed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Catarino?= Date: Sat, 19 Mar 2022 13:52:41 +0100 Subject: select environments --- docs/customservices.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs') diff --git a/docs/customservices.md b/docs/customservices.md index cb68e1d..2e65f19 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -131,6 +131,7 @@ For Prometheus you need to set the type to Prometheus and provide a url. This service displays info about the total number of containers managed by your Portainer instance. In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass it to the apikey field. +By default, every connected environments will be checked. To select specific ones,add an "environments" entry which can be a simple string or an array containing all the selected environments name. See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens @@ -140,4 +141,7 @@ See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens url: "http://192.168.0.151/" type: "Portainer" apikey: "MY-SUPER-SECRET-API-KEY" + # environments: + # - "raspberry" + # - "local" ``` -- cgit v1.2.3 From 775d0a8e862247bc78a53d6cf0ceef5651d4f98c Mon Sep 17 00:00:00 2001 From: Little-Karl Date: Sun, 20 Mar 2022 07:34:16 +0800 Subject: FA note chages for new users (#404) Update link to Font Awesome to reference v5 directly --- 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 2083be3..84a7ea7 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -5,7 +5,7 @@ Title, icons, links, colors, and services can be configured in the `config.yml` ```yaml --- # Homepage configuration -# See https://fontawesome.com/icons for icons options +# See https://fontawesome.com/v5/search for icons options # Optional: Use external configuration file. # Using this will ignore remaining config in this file -- cgit v1.2.3 From 345dd6c194a588ab038a8cb46846f74f4b96650e Mon Sep 17 00:00:00 2001 From: SouLSLayeR Date: Mon, 28 Mar 2022 20:41:19 +0300 Subject: Update customservices.md --- docs/customservices.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/customservices.md b/docs/customservices.md index cb68e1d..dead8ce 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -6,7 +6,16 @@ apikey included in the configuration file is exposed to anyone who can access th if your homer instance is secured behind some form of authentication or access restriction. Available services are in `src/components/`. Here is an overview of all custom services that are available -within Homer. +within Homer: ++ [PiHole](#pihole) ++ [OpenWeatherMap](#openweathermap) ++ [Medusa](#medusa) ++ [Lidarr, Prowlarr, Sonarr and Radarr](#lidarr-prowlarr-sonarr-and-radarr) ++ [PaperlessNG](#paperlessng) ++ [Ping](#ping) ++ [Prometheus](#prometheus) ++ [Portainer](#portainer) ++ [Emby](#emby) If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. @@ -141,3 +150,16 @@ See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens type: "Portainer" apikey: "MY-SUPER-SECRET-API-KEY" ``` + +## Emby + +You need to set the type to Emby, provide an api key and choose which stats to show if the subtitle is disabled. + +```yaml +- name: "Emby" + logo: "assets/tools/sample.png" + url: "http://192.168.0.151/" + type: "Portainer" + apikey: "MY-SUPER-SECRET-API-KEY" + libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies. +``` -- cgit v1.2.3 From 6dc8fa20260535aafba16242d36cd053222b5d3f Mon Sep 17 00:00:00 2001 From: SouLSLayeR Date: Mon, 28 Mar 2022 20:42:06 +0300 Subject: Update customservices.md --- docs/customservices.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/customservices.md b/docs/customservices.md index dead8ce..49798a8 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -159,7 +159,7 @@ You need to set the type to Emby, provide an api key and choose which stats to s - name: "Emby" logo: "assets/tools/sample.png" url: "http://192.168.0.151/" - type: "Portainer" + type: "Emby" apikey: "MY-SUPER-SECRET-API-KEY" libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies. ``` -- cgit v1.2.3