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 + [PiHole](#pihole)
  11 + [OpenWeatherMap](#openweathermap)
  12 + [Medusa](#medusa)
  13 + [Lidarr, Prowlarr, Sonarr and Radarr](#lidarr-prowlarr-sonarr-and-radarr)
  14 + [PaperlessNG](#paperlessng)
  15 + [Ping](#ping)
  16 + [Prometheus](#prometheus)
  17 + [AdGuard Home](#adguard-home)
  18 + [Portainer](#portainer)
  19 + [Emby](#emby)
  20 + [Uptime Kuma](#uptime-kuma)
  21 + [Tautulli](#tautulli)
  22
  23 If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
  24
  25
  26 ## Common options
  27
  28 ```yaml
  29 - name: "My Service"
  30   logo: "assets/tools/sample.png"
  31   url: "http://my-service-link"
  32   endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary.
  33   useCredentials: false # Optional: Override global proxy.useCredentials configuration.
  34   type: "<type>"
  35 ```
  36
  37 ## PiHole
  38
  39 Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
  40
  41 The following configuration is available for the PiHole service.
  42
  43 ```yaml
  44 - name: "Pi-hole"
  45   logo: "assets/tools/sample.png"
  46   # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
  47   url: "http://192.168.0.151/admin"
  48   type: "PiHole"
  49 ```
  50
  51 ## OpenWeatherMap
  52
  53 Using the OpenWeatherMap service you can display weather information about a given location.
  54 The following configuration is available for the OpenWeatherMap service:
  55
  56 ```yaml
  57 - name: "Weather"
  58   location: "Amsterdam" # your location.
  59   locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
  60   apikey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
  61   units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
  62   background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
  63   type: "OpenWeather"
  64 ```
  65
  66 **Remarks:**
  67 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).
  68
  69 ## Medusa
  70
  71 This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
  72 Two lines are needed in the config.yml :
  73
  74 ```yaml
  75   type: "Medusa"
  76   apikey: "01234deb70424befb1f4ef6a23456789"
  77 ```
  78
  79 The url must be the root url of Medusa application.
  80 The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
  81
  82 ## Lidarr, Prowlarr, Sonarr and Radarr
  83
  84 This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Lidarr, Radarr or Sonarr application.
  85 Two lines are needed in the config.yml :
  86
  87 ```yaml
  88   type: "Lidarr", "Prowlarr", "Radarr" or "Sonarr"
  89   apikey: "01234deb70424befb1f4ef6a23456789"
  90 ```
  91
  92 The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application.
  93 The Lidarr, Prowlarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API.
  94 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:
  95
  96 ```yaml
  97 - name: "Radarr"
  98   type: "Radarr"
  99   url: "http://localhost:7878/"
 100   apikey: "MY-SUPER-SECRET-API-KEY"
 101   target: "_blank"
 102   legacyApi: true
 103 ```
 104
 105 ## PaperlessNG
 106
 107 This service displays total number of documents stored. Two lines are required:
 108
 109 ```yaml
 110   type: "PaperlessNG"
 111   apikey: "0123456789abcdef123456789abcdef"
 112 ```
 113
 114 API key can be generated in Settings > Administration > Auth Tokens
 115
 116 ## Ping
 117
 118 For Ping you need to set the type to Ping and provide a url.
 119
 120 ```yaml
 121 - name: "Awesome app"
 122   type: Ping
 123   logo: "assets/tools/sample.png"
 124   subtitle: "Bookmark example"
 125   tag: "app"
 126   url: "https://www.reddit.com/r/selfhosted/"
 127 ```
 128
 129 ## Prometheus
 130
 131 For Prometheus you need to set the type to Prometheus and provide a url.
 132
 133 ```yaml
 134 - name: "Prometheus"
 135   type: Prometheus
 136   logo: "assets/tools/sample.png"
 137   url: "http://192.168.0.151/"
 138   # subtitle: "Monitor data server"
 139 ```
 140
 141 ## AdGuard Home
 142 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.
 143
 144 ```yaml
 145 - name: "Adguard"
 146   logo: "assets/tools/adguardhome.png"
 147   url: "https://adguard.exemple.com"
 148   target: "_blank"
 149   type: "AdGuardHome"
 150 ```
 151
 152 ## Portainer
 153
 154 This service displays info about the total number of containers managed by your Portainer instance.
 155 In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass
 156 it to the apikey field.
 157 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.
 158
 159 See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
 160
 161 ```yaml
 162 - name: "Portainer"
 163   logo: "assets/tools/sample.png"
 164   url: "http://192.168.0.151/"
 165   type: "Portainer"
 166   apikey: "MY-SUPER-SECRET-API-KEY"
 167   # environments:
 168   #   - "raspberry"
 169   #   - "local"
 170 ```
 171
 172 ## Emby
 173
 174 You need to set the type to Emby, provide an api key and choose which stats to show if the subtitle is disabled.
 175
 176 ```yaml
 177 - name: "Emby"
 178   logo: "assets/tools/sample.png"
 179   url: "http://192.168.0.151/"
 180   type: "Emby"
 181   apikey: "MY-SUPER-SECRET-API-KEY"
 182   libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies.
 183 ```
 184
 185 ## Uptime Kuma
 186
 187 Using the Uptime Kuma service you can display info about your instance uptime right on your Homer dashboard.
 188
 189 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).
 190
 191 ```yaml
 192 - name: "Uptime Kuma"
 193   logo: "assets/tools/sample.png"
 194   # subtitle: "A fancy self-hosted monitoring tool" # optional, if no subtitle is defined, Uptime Kuma incidents, if any, will be shown
 195   url: "http://192.168.0.151:3001"
 196   slug: "myCustomDashboard" # Defaults to "default" if not provided.
 197   type: "UptimeKuma"
 198 ```
 199
 200 ## Tautulli
 201
 202 The Tautulli service can allow you to show the number of currently active
 203 streams on you Plex instance. An API key is required, and can be obtained from
 204 the "Web Interface" section of settings on the Tautulli web UI.
 205
 206 ```yaml
 207 - name: "Tautulli"
 208   logo: "assets/tools/sample.png"
 209   url: "http://192.168.0.151:8181"
 210   type: "Tautulli"
 211   apikey: "MY-SUPER-SECRET-API-KEY"
 212 ```
 213
 214 Because the service type and link don't necessarily have to match, you could
 215 even make the service type Tautulli on your Plex card and provide a separate
 216 endpoint pointing to Tautulli!
 217
 218 ```yaml
 219 - name: "Plex"
 220   logo: "assets/tools/sample.png"
 221   url: "http://192.168.0.151:32400/web" # Plex
 222   endpoint: "http://192.168.0.151:8181" # Tautulli
 223   type: "Tautulli"
 224   apikey: "MY-SUPER-SECRET-API-KEY"
 225 ```