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