aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/customservices.md
diff options
context:
space:
mode:
authorBastien Wirtz <bastien.wirtz@gmail.com>2022-04-07 22:33:20 +0200
committerGitHub <noreply@github.com>2022-04-07 22:33:20 +0200
commit7341d7634b5a7d66e7eab921c0fcfe7034d2047f (patch)
tree943e41fee0bc8e4333d64331fab42b967d7f9d2e /docs/customservices.md
parentb2a41400540b5003431bd83f6859b74991f195c5 (diff)
parent9e1e82b0f3ce57f95f21fc09c70e2711e5105997 (diff)
downloadhomer-7341d7634b5a7d66e7eab921c0fcfe7034d2047f.tar.gz
homer-7341d7634b5a7d66e7eab921c0fcfe7034d2047f.tar.zst
homer-7341d7634b5a7d66e7eab921c0fcfe7034d2047f.zip
Merge branch 'main' into feature/adguard-home-customservices-doc
Diffstat (limited to 'docs/customservices.md')
-rw-r--r--docs/customservices.md73
1 files changed, 64 insertions, 9 deletions
diff --git a/docs/customservices.md b/docs/customservices.md
index 3fbd695..509278f 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -1,8 +1,22 @@
1# Custom Services 1# Custom Services
2 2
3Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml 3Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml
4configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available 4configuration and, where applicable, an apikey. Note that config.yml is exposed at /assets/config.yml via HTTP and any
5within Homer. 5apikey included in the configuration file is exposed to anyone who can access the homer instance. Only include an apikey
6if your homer instance is secured behind some form of authentication or access restriction.
7
8Available services are in `src/components/`. Here is an overview of all custom services that are available
9within Homer:
10+ [PiHole](#pihole)
11+ [OpenWeatherMap](#openweathermap)
12+ [Medusa](#medusa)
13+ [Lidarr, Prowlarr, Sonarr and Radarr](#lidarr-prowlarr-sonarr-and-radarr)
14+ [PaperlessNG](#paperlessng)
15+ [Ping](#ping)
16+ [Prometheus](#prometheus)
17+ [AdGuard Home](#adguard-home)
18+ [Portainer](#portainer)
19+ [Emby](#emby)
6 20
7If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. 21If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
8 22
@@ -18,8 +32,6 @@ If you experiencing any issue, please have a look to the [troubleshooting](troub
18 type: "<type>" 32 type: "<type>"
19``` 33```
20 34
21⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon).
22
23## PiHole 35## PiHole
24 36
25Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. 37Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
@@ -65,18 +77,28 @@ Two lines are needed in the config.yml :
65The url must be the root url of Medusa application. 77The url must be the root url of Medusa application.
66The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. 78The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
67 79
68## Sonarr/Radarr 80## Lidarr, Prowlarr, Sonarr and Radarr
69 81
70This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. 82This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Lidarr, Radarr or Sonarr application.
71Two lines are needed in the config.yml : 83Two lines are needed in the config.yml :
72 84
73```yaml 85```yaml
74 type: "Radarr" or "Sonarr" 86 type: "Lidarr", "Prowlarr", "Radarr" or "Sonarr"
75 apikey: "01234deb70424befb1f4ef6a23456789" 87 apikey: "01234deb70424befb1f4ef6a23456789"
76``` 88```
77 89
78The url must be the root url of Radarr/Sonarr application. 90The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application.
79The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. 91The Lidarr, Prowlarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API.
92If 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:
93
94```yaml
95- name: "Radarr"
96 type: "Radarr"
97 url: "http://localhost:7878/"
98 apikey: "MY-SUPER-SECRET-API-KEY"
99 target: "_blank"
100 legacyApi: true
101```
80 102
81## PaperlessNG 103## PaperlessNG
82 104
@@ -124,3 +146,36 @@ For AdGuard Home you need to set the type to AdGuard, if you have somes issues a
124 target: "_blank" 146 target: "_blank"
125 type: "AdGuardHome" 147 type: "AdGuardHome"
126``` 148```
149
150## Portainer
151
152This service displays info about the total number of containers managed by your Portainer instance.
153In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass
154it to the apikey field.
155By 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.
156
157See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
158
159```yaml
160- name: "Portainer"
161 logo: "assets/tools/sample.png"
162 url: "http://192.168.0.151/"
163 type: "Portainer"
164 apikey: "MY-SUPER-SECRET-API-KEY"
165 # environments:
166 # - "raspberry"
167 # - "local"
168```
169
170## Emby
171
172You need to set the type to Emby, provide an api key and choose which stats to show if the subtitle is disabled.
173
174```yaml
175- name: "Emby"
176 logo: "assets/tools/sample.png"
177 url: "http://192.168.0.151/"
178 type: "Emby"
179 apikey: "MY-SUPER-SECRET-API-KEY"
180 libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies.
181```