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