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