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