docs/customservices.md

   1 # Custom Services
   2
   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 and, where applicable, an apikey. Note that config.yml is exposed at /assets/config.yml via HTTP and any
   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 / Jellyfin](#emby--jellyfin)
  20 + [Uptime Kuma](#uptime-kuma)
  21 + [Tautulli](#tautulli)
  22 + [Mealie](#mealie)
  23 + [Healthchecks](#healthchecks)
  24
  25 If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
  26
  27
  28 ## Common options
  29
  30 ```yaml
  31 - name: "My Service"
  32   logo: "assets/tools/sample.png"
  33   url: "http://my-service-link"
  34   endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary.
  35   useCredentials: false # Optional: Override global proxy.useCredentials configuration.
  36   type: "<type>"
  37 ```
  38
  39 ## PiHole
  40
  41 Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
  42
  43 The following configuration is available for the PiHole service.
  44
  45 ```yaml
  46 - name: "Pi-hole"
  47   logo: "assets/tools/sample.png"
  48   # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
  49   url: "http://192.168.0.151/admin"
  50   type: "PiHole"
  51 ```
  52
  53 ## OpenWeatherMap
  54
  55 Using the OpenWeatherMap service you can display weather information about a given location.
  56 The following configuration is available for the OpenWeatherMap service:
  57
  58 ```yaml
  59 - name: "Weather"
  60   location: "Amsterdam" # your location.
  61   locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
  62   apikey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
  63   units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
  64   background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
  65   type: "OpenWeather"
  66 ```
  67
  68 **Remarks:**
  69 If for some reason your city can't be found by entering the name in the `location` property, you could also try to configure the OWM city ID in the `locationId` property. To retrieve your specific City ID, go to the [OWM website](https://openweathermap.org), search for your city and retrieve the ID from the URL (for example, the City ID of Amsterdam is 2759794).
  70
  71 ## Medusa
  72
  73 This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
  74 Two lines are needed in the config.yml :
  75
  76 ```yaml
  77   type: "Medusa"
  78   apikey: "01234deb70424befb1f4ef6a23456789"
  79 ```
  80
  81 The url must be the root url of Medusa application.
  82 The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
  83
  84 ## Lidarr, Prowlarr, Sonarr and Radarr
  85
  86 This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Lidarr, Radarr or Sonarr application.
  87 Two lines are needed in the config.yml :
  88
  89 ```yaml
  90   type: "Lidarr", "Prowlarr", "Radarr" or "Sonarr"
  91   apikey: "01234deb70424befb1f4ef6a23456789"
  92 ```
  93
  94 The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application.
  95 The Lidarr, Prowlarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API.
  96 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:
  97
  98 ```yaml
  99 - name: "Radarr"
 100   type: "Radarr"
 101   url: "http://localhost:7878/"
 102   apikey: "MY-SUPER-SECRET-API-KEY"
 103   target: "_blank"
 104   legacyApi: true
 105 ```
 106
 107 ## PaperlessNG
 108
 109 This service displays total number of documents stored. Two lines are required:
 110
 111 ```yaml
 112   type: "PaperlessNG"
 113   apikey: "0123456789abcdef123456789abcdef"
 114 ```
 115
 116 API key can be generated in Settings > Administration > Auth Tokens
 117
 118 ## Ping
 119
 120 For Ping you need to set the type to Ping and provide a url. By default the HEAD method is used but it can be configured to use GET using the optional `method` property.
 121
 122 ```yaml
 123 - name: "Awesome app"
 124   type: Ping
 125   logo: "assets/tools/sample.png"
 126   subtitle: "Bookmark example"
 127   tag: "app"
 128   url: "https://www.reddit.com/r/selfhosted/"
 129   method: "head"
 130 ```
 131
 132 ## Prometheus
 133
 134 For Prometheus you need to set the type to Prometheus and provide a url.
 135
 136 ```yaml
 137 - name: "Prometheus"
 138   type: Prometheus
 139   logo: "assets/tools/sample.png"
 140   url: "http://192.168.0.151/"
 141   # subtitle: "Monitor data server"
 142 ```
 143
 144 ## AdGuard Home
 145 For AdGuard Home you need to set the type to AdGuard, if you have somes issues as 403 responses on requests you need to provide authentification in headers for locations needed as below.
 146
 147 ```yaml
 148 - name: "Adguard"
 149   logo: "assets/tools/adguardhome.png"
 150   url: "https://adguard.exemple.com"
 151   target: "_blank"
 152   type: "AdGuardHome"
 153 ```
 154
 155 ## Portainer
 156
 157 This service displays info about the total number of containers managed by your Portainer instance.
 158 In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass
 159 it to the apikey field.
 160 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.
 161
 162 See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
 163
 164 ```yaml
 165 - name: "Portainer"
 166   logo: "assets/tools/sample.png"
 167   url: "http://192.168.0.151/"
 168   type: "Portainer"
 169   apikey: "MY-SUPER-SECRET-API-KEY"
 170   # environments:
 171   #   - "raspberry"
 172   #   - "local"
 173 ```
 174
 175 ## Emby / Jellyfin
 176
 177 You need to set the type to Emby, provide an api key and choose which stats to show if the subtitle is disabled.
 178
 179 ```yaml
 180 - name: "Emby"
 181   logo: "assets/tools/sample.png"
 182   url: "http://192.168.0.151/"
 183   type: "Emby"
 184   apikey: "MY-SUPER-SECRET-API-KEY"
 185   libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies.
 186 ```
 187
 188 ## Uptime Kuma
 189
 190 Using the Uptime Kuma service you can display info about your instance uptime right on your Homer dashboard.
 191
 192 The following configuration is available for the UptimeKuma service. Needs v1.13.1 or later because of the change in APIs due to [multiple status pages support](https://github.com/louislam/uptime-kuma/releases/tag/1.13.1).
 193
 194 ```yaml
 195 - name: "Uptime Kuma"
 196   logo: "assets/tools/sample.png"
 197   # subtitle: "A fancy self-hosted monitoring tool" # optional, if no subtitle is defined, Uptime Kuma incidents, if any, will be shown
 198   url: "http://192.168.0.151:3001"
 199   slug: "myCustomDashboard" # Defaults to "default" if not provided.
 200   type: "UptimeKuma"
 201 ```
 202
 203 ## Tautulli
 204
 205 The Tautulli service can allow you to show the number of currently active
 206 streams on you Plex instance. An API key is required, and can be obtained from
 207 the "Web Interface" section of settings on the Tautulli web UI.
 208
 209 ```yaml
 210 - name: "Tautulli"
 211   logo: "assets/tools/sample.png"
 212   url: "http://192.168.0.151:8181"
 213   type: "Tautulli"
 214   apikey: "MY-SUPER-SECRET-API-KEY"
 215 ```
 216
 217 Because the service type and link don't necessarily have to match, you could
 218 even make the service type Tautulli on your Plex card and provide a separate
 219 endpoint pointing to Tautulli!
 220
 221 ```yaml
 222 - name: "Plex"
 223   logo: "assets/tools/sample.png"
 224   url: "http://192.168.0.151:32400/web" # Plex
 225   endpoint: "http://192.168.0.151:8181" # Tautulli
 226   type: "Tautulli"
 227   apikey: "MY-SUPER-SECRET-API-KEY"
 228 ```
 229
 230 ## Mealie
 231
 232 First off make sure to remove an existing `subtitle` as it will take precedence if set.
 233 Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized or the planned meal for today if one is planned. You will have to set an API key in the field `apikey` which can be created in your Mealie installation.
 234
 235 ## Healthchecks
 236
 237 This service displays information about the configured status checks from the Healthchecks application.
 238 Two lines are needed in the config.yml :
 239
 240 ```yaml
 241   type: "Healthchecks"
 242   apikey: "01234deb70424befb1f4ef6a23456789"
 243 ```
 244
 245 The url must be the root url of the Healthchecks application.
 246 The Healthchecks API key can be found in Settings > API Access > API key (read-only). The key is needed to access Healthchecks API.