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