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   - [qBittorrent](#qbittorrent)
  29
  30 If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
  31
  32 ## Common options
  33
  34 ```yaml
  35 - name: "My Service"
  36   logo: "assets/tools/sample.png"
  37   url: "http://my-service-link"
  38   endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary.
  39   useCredentials: false # Optional: Override global proxy.useCredentials configuration.
  40   type: "<type>"
  41 ```
  42
  43 ## PiHole
  44
  45 Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
  46
  47 The following configuration is available for the PiHole service.
  48
  49 ```yaml
  50 - name: "Pi-hole"
  51   logo: "assets/tools/sample.png"
  52   # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
  53   url: "http://192.168.0.151/admin"
  54   type: "PiHole"
  55 ```
  56
  57 ## OpenWeatherMap
  58
  59 Using the OpenWeatherMap service you can display weather information about a given location.
  60 The following configuration is available for the OpenWeatherMap service:
  61
  62 ```yaml
  63 - name: "Weather"
  64   location: "Amsterdam" # your location.
  65   locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
  66   apikey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
  67   units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
  68   background: "square" # choose which type of background you want behind the image. Can be one of: square, circle, none. Defaults to none.
  69   type: "OpenWeather"
  70 ```
  71
  72 **Remarks:**
  73 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).
  74
  75 ## Medusa
  76
  77 This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
  78 Two lines are needed in the config.yml :
  79
  80 ```yaml
  81   type: "Medusa"
  82   apikey: "01234deb70424befb1f4ef6a23456789"
  83 ```
  84
  85 The url must be the root url of Medusa application.
  86 The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
  87
  88 ## Lidarr, Prowlarr, Sonarr and Radarr
  89
  90 This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Lidarr, Radarr or Sonarr application.
  91 Two lines are needed in the config.yml :
  92
  93 ```yaml
  94   type: "Lidarr", "Prowlarr", "Radarr" or "Sonarr"
  95   apikey: "01234deb70424befb1f4ef6a23456789"
  96 ```
  97
  98 The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application.
  99 The Lidarr, Prowlarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API.
 100 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:
 101
 102 ```yaml
 103 - name: "Radarr"
 104   type: "Radarr"
 105   url: "http://localhost:7878/"
 106   apikey: "MY-SUPER-SECRET-API-KEY"
 107   target: "_blank"
 108   legacyApi: true
 109 ```
 110
 111 ## PaperlessNG
 112
 113 This service displays total number of documents stored. Two lines are required:
 114
 115 ```yaml
 116   type: "PaperlessNG"
 117   apikey: "0123456789abcdef123456789abcdef"
 118 ```
 119
 120 API key can be generated in Settings > Administration > Auth Tokens
 121
 122 ## Ping
 123
 124 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.
 125
 126 ```yaml
 127 - name: "Awesome app"
 128   type: Ping
 129   logo: "assets/tools/sample.png"
 130   subtitle: "Bookmark example"
 131   tag: "app"
 132   url: "https://www.reddit.com/r/selfhosted/"
 133   method: "head"
 134 ```
 135
 136 ## Prometheus
 137
 138 For Prometheus you need to set the type to Prometheus and provide a url.
 139
 140 ```yaml
 141 - name: "Prometheus"
 142   type: Prometheus
 143   logo: "assets/tools/sample.png"
 144   url: "http://192.168.0.151/"
 145   # subtitle: "Monitor data server"
 146 ```
 147
 148 ## AdGuard Home
 149 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.
 150
 151 ```yaml
 152 - name: "Adguard"
 153   logo: "assets/tools/adguardhome.png"
 154   url: "https://adguard.exemple.com"
 155   target: "_blank"
 156   type: "AdGuardHome"
 157 ```
 158
 159 ## Portainer
 160
 161 This service displays info about the total number of containers managed by your Portainer instance.
 162 In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass
 163 it to the apikey field.
 164 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.
 165
 166 See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
 167
 168 ```yaml
 169 - name: "Portainer"
 170   logo: "assets/tools/sample.png"
 171   url: "http://192.168.0.151/"
 172   type: "Portainer"
 173   apikey: "MY-SUPER-SECRET-API-KEY"
 174   # environments:
 175   #   - "raspberry"
 176   #   - "local"
 177 ```
 178
 179 ## Emby / Jellyfin
 180
 181 You need to set the type to Emby, provide an api key and choose which stats to show if the subtitle is disabled.
 182
 183 ```yaml
 184 - name: "Emby"
 185   logo: "assets/tools/sample.png"
 186   url: "http://192.168.0.151/"
 187   type: "Emby"
 188   apikey: "MY-SUPER-SECRET-API-KEY"
 189   libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies.
 190 ```
 191
 192 ## Uptime Kuma
 193
 194 Using the Uptime Kuma service you can display info about your instance uptime right on your Homer dashboard.
 195
 196 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).
 197
 198 ```yaml
 199 - name: "Uptime Kuma"
 200   logo: "assets/tools/sample.png"
 201   # subtitle: "A fancy self-hosted monitoring tool" # optional, if no subtitle is defined, Uptime Kuma incidents, if any, will be shown
 202   url: "http://192.168.0.151:3001"
 203   slug: "myCustomDashboard" # Defaults to "default" if not provided.
 204   type: "UptimeKuma"
 205 ```
 206
 207 ## Tautulli
 208
 209 The Tautulli service can allow you to show the number of currently active
 210 streams on you Plex instance. An API key is required, and can be obtained from
 211 the "Web Interface" section of settings on the Tautulli web UI.
 212
 213 ```yaml
 214 - name: "Tautulli"
 215   logo: "assets/tools/sample.png"
 216   url: "http://192.168.0.151:8181"
 217   type: "Tautulli"
 218   apikey: "MY-SUPER-SECRET-API-KEY"
 219 ```
 220
 221 Because the service type and link don't necessarily have to match, you could
 222 even make the service type Tautulli on your Plex card and provide a separate
 223 endpoint pointing to Tautulli!
 224
 225 ```yaml
 226 - name: "Plex"
 227   logo: "assets/tools/sample.png"
 228   url: "http://192.168.0.151:32400/web" # Plex
 229   endpoint: "http://192.168.0.151:8181" # Tautulli
 230   type: "Tautulli"
 231   apikey: "MY-SUPER-SECRET-API-KEY"
 232 ```
 233
 234 ## Mealie
 235
 236 First off make sure to remove an existing `subtitle` as it will take precedence if set.
 237 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.
 238
 239 ## Healthchecks
 240
 241 This service displays information about the configured status checks from the Healthchecks application.
 242 Two lines are needed in the config.yml :
 243
 244 ```yaml
 245   type: "Healthchecks"
 246   apikey: "01234deb70424befb1f4ef6a23456789"
 247 ```
 248
 249 The url must be the root url of the Healthchecks application.
 250 The Healthchecks API key can be found in Settings > API Access > API key (read-only). The key is needed to access Healthchecks API.
 251
 252 ## Proxmox
 253
 254 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).
 255
 256 The API Token (or the user asigned to that token if not separated permissions is checked) are this:
 257
 258 | Path               | Permission | Comments                                                          |
 259 | ------------------ | ---------- |                                                                   |
 260 | /nodes/<your-node> | Sys.Audit  |                                                                   |
 261 | /vms/<id-vm>       | VM.Audit   | You need to have this permission on any VM you want to be counted |
 262
 263 It is highly recommended that you create and API Token with only these permissions on a read-only mode.
 264
 265 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.
 266
 267 Configuration example:
 268
 269 ```yaml
 270 - name: "Proxmox - Node"
 271   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"
 272   type: "Proxmox"
 273   url: "https://your.proxmox.server"
 274   node: "your-node-name"
 275   warning_value: 50
 276   danger_value: 80
 277   api_token: "PVEAPIToken=root@pam!your-api-token-name=your-api-token-key"
 278 ```
 279
 280 ## qBittorrent
 281
 282 This service displays the global upload and download rates, as well as the number of torrents
 283 listed. The service communicates with the qBittorrent API interface which needs
 284 to be accessible from the browser. Please consult
 285 [the instructions](https://github.com/qbittorrent/qBittorrent/pull/12579)
 286 for setting up qBittorrent and make sure the correct CORS-settings are applied. Examples for various
 287 servers can be found at [enable-cors.org](https://enable-cors.org/server.html).
 288
 289 ```yaml
 290 - name: "qBittorrent"
 291   logo: "assets/tools/sample.png"
 292   url: "http://192.168.1.2:8080" # Your rTorrent web UI, f.e. ruTorrent or Flood.
 293   type: "qBittorrent"
 294   rateInterval: 2000 # Interval for updating the download and upload rates.
 295   torrentInterval: 5000 # Interval for updating the torrent count.
 296   target: "_blank" # optional html a tag target attribute
 297 ```