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