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. Available services are in `src/components/`. Here is an overview of all custom services that are available
   5 within Homer.
   6
   7 ## PiHole
   8
   9 Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
  10
  11 The following configuration is available for the PiHole service.
  12
  13 ```
  14  items:
  15       - name: "Pi-hole"
  16         logo: "assets/tools/sample.png"
  17         # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
  18         url: "http://192.168.0.151/admin"
  19         type: "PiHole"
  20 ```
  21
  22
  23 ## OpenWeatherMap
  24
  25 Using the OpenWeatherMap service you can display weather information about a given location.
  26
  27 The following configuration is available for the OpenWeatherMap service
  28
  29 ```
  30 items:
  31      - name: "Weather"
  32        location: "Amsterdam" # your location.
  33        locationId: "2759794" # OpenWeatherMap city ID.
  34        apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
  35        units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
  36        background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
  37        type: "OpenWeather"
  38 ```
  39
  40 **Remarks:**
  41 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).
  42
  43
  44 ## Medusa
  45
  46 This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
  47 Two lines are needed in the config.yml :
  48 ```
  49 type: "Medusa"
  50 apikey: "01234deb70424befb1f4ef6a23456789"
  51 ```
  52 The url must be the root url of Medusa application.
  53 The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
  54
  55
  56 ## Sonarr/Radarr
  57
  58 This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application.
  59 Two lines are needed in the config.yml :
  60 ```
  61 type: "Radarr" or "Sonarr"
  62 apikey: "01234deb70424befb1f4ef6a23456789"
  63 ```
  64 The url must be the root url of Radarr/Sonarr application.
  65 The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.
  66
  67
  68 ## PaperlessNG
  69
  70 For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
  71
  72
  73 ## Ping
  74
  75 For Ping you need an API-Key which you have to store at the item in the field `apikey`.