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 If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
   8
   9 ## Common options
  10
  11 ```yaml
  12 - name: 'My Service'
  13   logo: 'assets/tools/sample.png'
  14   url: 'http://my-service-link'
  15   endpoint: 'http://my-service-endpoint' # Optional: alternative base URL used to fetch service data is necessary.
  16   useCredentials: false # Optional: Override global proxy.useCredentials configuration.
  17   type: '<type>'
  18 ```
  19
  20 ⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon).
  21
  22 ## PiHole
  23
  24 Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
  25
  26 The following configuration is available for the PiHole service.
  27
  28 ```yaml
  29 - name: "Pi-hole"
  30   logo: "assets/tools/sample.png"
  31   # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
  32   url: "http://192.168.0.151/admin"
  33   type: "PiHole"
  34 ```
  35
  36 ## OpenWeatherMap
  37
  38 Using the OpenWeatherMap service you can display weather information about a given location.
  39 The following configuration is available for the OpenWeatherMap service:
  40
  41 ```yaml
  42 - name: "Weather"
  43   location: "Amsterdam" # your location.
  44   locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
  45   apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
  46   units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
  47   background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
  48   type: "OpenWeather"
  49 ```
  50
  51 **Remarks:**
  52 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).
  53
  54 ## Medusa
  55
  56 This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
  57 Two lines are needed in the config.yml :
  58
  59 ```yaml
  60   type: "Medusa"
  61   apikey: "01234deb70424befb1f4ef6a23456789"
  62 ```
  63
  64 The url must be the root url of Medusa application.
  65 The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
  66
  67 ## Sonarr/Radarr
  68
  69 This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application.
  70 Two lines are needed in the config.yml :
  71
  72 ```yaml
  73   type: "Radarr" or "Sonarr"
  74   apikey: "01234deb70424befb1f4ef6a23456789"
  75 ```
  76
  77 The url must be the root url of Radarr/Sonarr application.
  78 The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.
  79
  80 ## PaperlessNG
  81
  82 For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
  83
  84 ## Ping
  85
  86 For Ping you need to set the type to Ping and provide a url.
  87
  88 ```yaml
  89 - name: "Awesome app"
  90   type: Ping
  91   logo: "assets/tools/sample.png"
  92   subtitle: "Bookmark example" tag: "app"
  93   url: "https://www.reddit.com/r/selfhosted/"
  94 ```
  95
  96 ## Prometheus
  97
  98 For Prometheus you need to set the type to Prometheus and provide a url.
  99
 100 ```yaml
 101 - name: "Prometheus"
 102   type: Prometheus
 103   logo: "assets/tools/sample.png"
 104   url: "http://192.168.0.151/"
 105   # subtitle: "Monitor data server"
 106 ```