docs/customservices.md

   1 # Custom Services
   2
   3 Here is an overview of all custom services that are available within Homer.
   4
   5 ## PiHole
   6
   7 Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
   8
   9 The following configuration is available for the PiHole service.
  10
  11 ```
  12  items:
  13       - name: "Pi-hole"
  14         logo: "assets/tools/sample.png"
  15         # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
  16         url: "http://192.168.0.151/admin"
  17         type: "PiHole"
  18 ```
  19
  20 ## Medusa
  21
  22 This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
  23 Two lines are needed in the config.yml :
  24 ```
  25 type: "Medusa"
  26 apikey: "01234deb70424befb1f4ef6a23456789"
  27 ```
  28 The url must be the root url of Medusa application.
  29 The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
  30
  31
  32 ## Sonarr/Radarr
  33
  34 This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application.
  35 Two lines are needed in the config.yml :
  36 ```
  37 type: "Radarr" or "Sonarr"
  38 apikey: "01234deb70424befb1f4ef6a23456789"
  39 ```
  40 The url must be the root url of Radarr/Sonarr application.
  41 The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.