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