diff options
Diffstat (limited to 'docs/customservices.md')
-rw-r--r-- | docs/customservices.md | 73 |
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 | ||
3 | Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml | 3 | Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml |
4 | configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available | 4 | configuration and, where applicable, an apikey. Note that config.yml is exposed at /assets/config.yml via HTTP and any |
5 | within Homer. | 5 | apikey included in the configuration file is exposed to anyone who can access the homer instance. Only include an apikey |
6 | if your homer instance is secured behind some form of authentication or access restriction. | ||
7 | |||
8 | Available services are in `src/components/`. Here is an overview of all custom services that are available | ||
9 | within 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 | ||
7 | If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. | 21 | If 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 | ||
25 | Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. | 37 | Using 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 : | |||
65 | The url must be the root url of Medusa application. | 77 | The url must be the root url of Medusa application. |
66 | The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. | 78 | The 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 | ||
70 | This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. | 82 | This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Lidarr, Radarr or Sonarr application. |
71 | Two lines are needed in the config.yml : | 83 | Two 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 | ||
78 | The url must be the root url of Radarr/Sonarr application. | 90 | The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application. |
79 | The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. | 91 | The Lidarr, Prowlarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API. |
92 | 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: | ||
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 | |||
152 | This service displays info about the total number of containers managed by your Portainer instance. | ||
153 | In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass | ||
154 | it to the apikey field. | ||
155 | 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. | ||
156 | |||
157 | See 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 | |||
172 | You 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 | ``` | ||