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