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
  11 - [Custom Services](#custom-services)
  12   - [Common options](#common-options)
  13   - [PiHole](#pihole)
  14   - [OpenWeatherMap](#openweathermap)
  15   - [Medusa](#medusa)
  16   - [Lidarr, Prowlarr, Sonarr and Radarr](#lidarr-prowlarr-sonarr-and-radarr)
  17   - [PaperlessNG](#paperlessng)
  18   - [Ping](#ping)
  19   - [Prometheus](#prometheus)
  20   - [AdGuard Home](#adguard-home)
  21   - [Portainer](#portainer)
  22   - [Emby / Jellyfin](#emby--jellyfin)
  23   - [Uptime Kuma](#uptime-kuma)
  24   - [Tautulli](#tautulli)
  25   - [Mealie](#mealie)
  26   - [Healthchecks](#healthchecks)
  27   - [Proxmox](#proxmox)
  28   - [rTorrent](#rtorrent)
  29   - [qBittorrent](#qbittorrent)
  30   - [CopyToClipboard](#copy-to-clipboard)
  31   - [Speedtest Tracker](#SpeedtestTracker)
  32   - [What's Up Docker](#whats-up-docker)
  33   - [SABnzbd](#sabnzbd)
  34   - [OctoPrint](#sabnzbd)
  35   - [Tdarr](#tdarr)
  36
  37 If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
  38
  39 ## Common options
  40
  41 ```yaml
  42 - name: "My Service"
  43   logo: "assets/tools/sample.png"
  44   url: "http://my-service-link"
  45   endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary.
  46   useCredentials: false # Optional: Override global proxy.useCredentials configuration.
  47   type: "<type>"
  48 ```
  49
  50 ## PiHole
  51
  52 Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
  53
  54 The following configuration is available for the PiHole service.
  55
  56 ```yaml
  57 - name: "Pi-hole"
  58   logo: "assets/tools/sample.png"
  59   # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
  60   url: "http://192.168.0.151/admin"
  61   apikey: "<---insert-api-key-here--->" # optional, needed if web interface is password protected
  62   type: "PiHole"
  63 ```
  64
  65 **Remarks:**
  66 If PiHole web interface is password protected, obtain the `apikey` from Settings > API/Web interface > Show API token.
  67
  68 ## OpenWeatherMap
  69
  70 Using the OpenWeatherMap service you can display weather information about a given location.
  71 The following configuration is available for the OpenWeatherMap service:
  72
  73 ```yaml
  74 - name: "Weather"
  75   location: "Amsterdam" # your location.
  76   locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
  77   apikey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
  78   units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
  79   background: "square" # choose which type of background you want behind the image. Can be one of: square, circle, none. Defaults to none.
  80   type: "OpenWeather"
  81 ```
  82
  83 **Remarks:**
  84 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).
  85
  86 ## Medusa
  87
  88 This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
  89 Two lines are needed in the config.yml :
  90
  91 ```yaml
  92   type: "Medusa"
  93   apikey: "<---insert-api-key-here--->"
  94 ```
  95
  96 The url must be the root url of Medusa application.
  97 The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
  98
  99 ## Lidarr, Prowlarr, Sonarr and Radarr
 100
 101 This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Lidarr, Radarr or Sonarr application.
 102 Two lines are needed in the config.yml :
 103
 104 ```yaml
 105   type: "Lidarr", "Prowlarr", "Radarr" or "Sonarr"
 106   apikey: "<---insert-api-key-here--->"
 107 ```
 108
 109 The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application.
 110 The Lidarr, Prowlarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API.
 111 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:
 112
 113 ```yaml
 114 - name: "Radarr"
 115   type: "Radarr"
 116   url: "http://localhost:7878/"
 117   apikey: "<---insert-api-key-here--->"
 118   target: "_blank"
 119   legacyApi: true
 120 ```
 121
 122 ## PaperlessNG
 123
 124 This service displays total number of documents stored. Two lines are required:
 125
 126 ```yaml
 127   type: "PaperlessNG"
 128   apikey: "<---insert-api-key-here--->"
 129 ```
 130
 131 API key can be generated in Settings > Administration > Auth Tokens
 132
 133 ## Ping
 134
 135 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.
 136
 137 ```yaml
 138 - name: "Awesome app"
 139   type: Ping
 140   logo: "assets/tools/sample.png"
 141   subtitle: "Bookmark example"
 142   tag: "app"
 143   url: "https://www.reddit.com/r/selfhosted/"
 144   method: "head"
 145 ```
 146
 147 ## Prometheus
 148
 149 For Prometheus you need to set the type to Prometheus and provide a url.
 150
 151 ```yaml
 152 - name: "Prometheus"
 153   type: Prometheus
 154   logo: "assets/tools/sample.png"
 155   url: "http://192.168.0.151/"
 156   # subtitle: "Monitor data server"
 157 ```
 158
 159 ## AdGuard Home
 160 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.
 161
 162 ```yaml
 163 - name: "Adguard"
 164   logo: "assets/tools/adguardhome.png"
 165   url: "https://adguard.exemple.com"
 166   target: "_blank"
 167   type: "AdGuardHome"
 168 ```
 169
 170 ## Portainer
 171
 172 This service displays info about the total number of containers managed by your Portainer instance.
 173 In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass
 174 it to the apikey field.
 175 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.
 176
 177 See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
 178
 179 ```yaml
 180 - name: "Portainer"
 181   logo: "assets/tools/sample.png"
 182   url: "http://192.168.0.151/"
 183   type: "Portainer"
 184   apikey: "<---insert-api-key-here--->"
 185   # environments:
 186   #   - "raspberry"
 187   #   - "local"
 188 ```
 189
 190 ## Emby / Jellyfin
 191
 192 You need to set the type to Emby, provide an api key and choose which stats to show if the subtitle is disabled.
 193
 194 ```yaml
 195 - name: "Emby"
 196   logo: "assets/tools/sample.png"
 197   url: "http://192.168.0.151/"
 198   type: "Emby"
 199   apikey: "<---insert-api-key-here--->"
 200   libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies.
 201 ```
 202
 203 ## Uptime Kuma
 204
 205 Using the Uptime Kuma service you can display info about your instance uptime right on your Homer dashboard.
 206
 207 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).
 208
 209 ```yaml
 210 - name: "Uptime Kuma"
 211   logo: "assets/tools/sample.png"
 212   # subtitle: "A fancy self-hosted monitoring tool" # optional, if no subtitle is defined, Uptime Kuma incidents, if any, will be shown
 213   url: "http://192.168.0.151:3001"
 214   slug: "myCustomDashboard" # Defaults to "default" if not provided.
 215   type: "UptimeKuma"
 216 ```
 217
 218 ## Tautulli
 219
 220 The Tautulli service can allow you to show the number of currently active
 221 streams on you Plex instance. An API key is required, and can be obtained from
 222 the "Web Interface" section of settings on the Tautulli web UI.
 223
 224 ```yaml
 225 - name: "Tautulli"
 226   logo: "assets/tools/sample.png"
 227   url: "http://192.168.0.151:8181"
 228   type: "Tautulli"
 229   apikey: "<---insert-api-key-here--->"
 230 ```
 231
 232 Because the service type and link don't necessarily have to match, you could
 233 even make the service type Tautulli on your Plex card and provide a separate
 234 endpoint pointing to Tautulli!
 235
 236 ```yaml
 237 - name: "Plex"
 238   logo: "assets/tools/sample.png"
 239   url: "http://192.168.0.151:32400/web" # Plex
 240   endpoint: "http://192.168.0.151:8181" # Tautulli
 241   type: "Tautulli"
 242   apikey: "<---insert-api-key-here--->"
 243 ```
 244
 245 ## Mealie
 246
 247 First off make sure to remove an existing `subtitle` as it will take precedence if set.
 248 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.
 249
 250 ## Healthchecks
 251
 252 This service displays information about the configured status checks from the Healthchecks application.
 253 Two lines are needed in the config.yml :
 254
 255 ```yaml
 256   type: "Healthchecks"
 257   apikey: "<---insert-api-key-here--->"
 258 ```
 259
 260 The url must be the root url of the Healthchecks application.
 261 The Healthchecks API key can be found in Settings > API Access > API key (read-only). The key is needed to access Healthchecks API.
 262
 263 ## rTorrent
 264
 265 This service displays the global upload and download rates, as well as the number of torrents
 266 listed in rTorrent. The service communicates with the rTorrent XML-RPC interface which needs
 267 to be accessible from the browser. Please consult
 268 [the instructions](https://github.com/rakshasa/rtorrent-doc/blob/master/RPC-Setup-XMLRPC.md)
 269 for setting up rTorrent and make sure the correct CORS-settings are applied. Examples for various
 270 servers can be found at https://enable-cors.org/server.html.
 271
 272 ```yaml
 273 - name: "rTorrent"
 274   logo: "assets/tools/sample.png"
 275   url: "http://192.168.0.151" # Your rTorrent web UI, f.e. ruTorrent or Flood.
 276   xmlrpc: "http://192.168.0.151:8081" # Reverse proxy for rTorrent's XML-RPC.
 277   type: "Rtorrent"
 278   rateInterval: 5000 # Interval for updating the download and upload rates.
 279   torrentInterval: 60000 # Interval for updating the torrent count.
 280   username: "username" # Username for logging into rTorrent (if applicable).
 281   password: "password" # Password for logging into rTorrent (if applicable).
 282 ```
 283
 284
 285 ## Proxmox
 286
 287 This service displays status information of a Proxmox node (VMs running and disk, memory and cpu used). It uses the proxmox API and [API Tokens](https://pve.proxmox.com/pve-docs/pveum-plain.html) for authorization so you need to generate one to set in the yaml config. You can set it up in Proxmox under Permissions > API Tokens. You also need to know the realm the user of the API Token is assigned to (by default pam).
 288
 289 The API Token (or the user asigned to that token if not separated permissions is checked) are this:
 290
 291 | Path               | Permission | Comments                                                          |
 292 |--------------------|------------|-------------------------------------------------------------------|
 293 | /nodes/<your-node> | Sys.Audit  |                                                                   |
 294 | /vms/<id-vm>       | VM.Audit   | You need to have this permission on any VM you want to be counted |
 295
 296 It is highly recommended that you create and API Token with only these permissions on a read-only mode.
 297
 298 If you get errors, they will be shown on browser's dev console. Main issues tend to be CORS related as Proxmox does not include CORS headers and you have to deploy it behind a reverse proxy and make the proxy add this headers.
 299
 300 Configuration example:
 301
 302 ```yaml
 303 - name: "Proxmox - Node"
 304   logo: "https://www.google.com/url?sa=i&url=https%3A%2F%2Fgithub.com%2FandOTP%2FandOTP%2Fissues%2F337&psig=AOvVaw2YKVuEUIBeTUikr7kAjm8D&ust=1665323538747000&source=images&cd=vfe&ved=0CAkQjRxqFwoTCPCTruLj0PoCFQAAAAAdAAAAABAN"
 305   type: "Proxmox"
 306   url: "https://your.proxmox.server"
 307   node: "your-node-name"
 308   warning_value: 50
 309   danger_value: 80
 310   api_token: "PVEAPIToken=root@pam!your-api-token-name=your-api-token-key"
 311   # values below this line are optional (default value are false/empty):
 312   hide_decimals: true # removes decimals from stats values.
 313   hide: [] # hides information. Possible values are "vms", "vms_total", "lxcs", "lxcs_total", "disk", "mem" and "cpu".
 314   small_font_on_small_screens: true # uses small font on small screens (like mobile)
 315   small_font_on_desktop: true # uses small font on desktops (just in case you're showing much info)
 316 ```
 317
 318 ## qBittorrent
 319
 320 This service displays the global upload and download rates, as well as the number of torrents
 321 listed. The service communicates with the qBittorrent API interface which needs
 322 to be accessible from the browser. Please consult
 323 [the instructions](https://github.com/qbittorrent/qBittorrent/pull/12579)
 324 for setting up qBittorrent and make sure the correct CORS-settings are applied. Examples for various
 325 servers can be found at [enable-cors.org](https://enable-cors.org/server.html).
 326
 327 ```yaml
 328 - name: "qBittorrent"
 329   logo: "assets/tools/sample.png"
 330   url: "http://192.168.1.2:8080" # Your rTorrent web UI, f.e. ruTorrent or Flood.
 331   type: "qBittorrent"
 332   rateInterval: 2000 # Interval for updating the download and upload rates.
 333   torrentInterval: 5000 # Interval for updating the torrent count.
 334   target: "_blank" # optional html a tag target attribute
 335 ```
 336
 337 ## Copy to Clipboard
 338
 339 This service displays the same information of a generic one, but shows an icon button on the indicator place (right side) you can click to get the content of the `clipboard` field copied to your clipboard.
 340
 341 You can still provide an `url` that would be open when clicked anywhere but on the icon button.
 342
 343 Configuration example:
 344
 345 ```yaml
 346 - name: "Copy me!"
 347   logo: "assets/tools/sample.png"
 348   subtitle: "Subtitle text goes here"
 349   url: "#"
 350   type: "CopyToClipboard"
 351   clipboard: "this text will be copied to your clipboard"
 352 ```
 353
 354 ## SpeedtestTracker
 355
 356 For the SpeedtestTracker service you just need to define a entry with type `SpeedtestTracker`.
 357
 358 ## What's up Docker
 359
 360 What's up Docker allow to display info about the number of container running and the number for which an update is available on your Homer dashboard.
 361
 362 The following configuration is available for the WUD service.
 363
 364 ```yaml
 365 - name: "What's Up Docker"
 366   logo: "assets/tools/sample.png"
 367   subtitle: "Docker image update notifier"
 368   url: "http://192.168.1.12:3001"
 369   type: "WUD"
 370 ```
 371
 372 ## SABnzbd
 373
 374 The SABnzbd service can allow you to show the number of currently active
 375 downloads on your SABnzbd instance. An API key is required, and can be obtained from
 376 the "Config" > "General" section of the SABnzbd config in the SABnzbd web UI.
 377
 378 ```yaml
 379 - name: "SABnzbd"
 380   logo: "assets/tools/sample.png"
 381   url: "http://192.168.0.151:8080"
 382   type: "SABnzbd"
 383   apikey: "MY-SUPER-SECRET-API-KEY"
 384   downloadInterval: 5000 # (Optional) Interval (in ms) for updating the download count
 385 ```
 386
 387 ## OctoPrint
 388
 389 The OctoPrint service only needs an `apikey` & `url` and optionally a `display` option.
 390
 391 ```yaml
 392 - name: "Octoprint"
 393   logo: "https://cdn-icons-png.flaticon.com/512/3112/3112529.png"
 394   apikey: "xxxxxxxxxxxx" # insert your own API key here. Request one from https://openweathermap.org/api.
 395   url: "http://192.168.0.151:8080"
 396   display: "text" # 'text' or 'bar'. Default to `text`.
 397   type: "OctoPrint"
 398 ```
 399
 400 ## Tdarr
 401
 402 The Tdarr service can allow you to show the number of currently queued items
 403 for transcoding on your Tdarr instance as well as the number of errored items.
 404
 405 ```yaml
 406 - name: "Tdarr"
 407   logo: "assets/tools/sample.png"
 408   url: "http://192.168.0.151:8265"
 409   type: "Tdarr"
 410   checkInterval: 5000 # (Optional) Interval (in ms) for updating the queue & error counts
 411 ```