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