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
  10 ## Common options
  11
  12 ```yaml
  13 - name: "My Service"
  14   logo: "assets/tools/sample.png"
  15   url: "http://my-service-link"
  16   endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary.
  17   useCredentials: false # Optional: Override global proxy.useCredentials configuration.
  18   type: "<type>"
  19 ```
  20
  21 ⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon).
  22
  23 ## PiHole
  24
  25 Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
  26
  27 The following configuration is available for the PiHole service.
  28
  29 ```yaml
  30 - name: "Pi-hole"
  31   logo: "assets/tools/sample.png"
  32   # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
  33   url: "http://192.168.0.151/admin"
  34   type: "PiHole"
  35 ```
  36
  37 ## OpenWeatherMap
  38
  39 Using the OpenWeatherMap service you can display weather information about a given location.
  40 The following configuration is available for the OpenWeatherMap service:
  41
  42 ```yaml
  43 - name: "Weather"
  44   location: "Amsterdam" # your location.
  45   locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
  46   apikey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
  47   units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
  48   background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
  49   type: "OpenWeather"
  50 ```
  51
  52 **Remarks:**
  53 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).
  54
  55 ## Medusa
  56
  57 This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
  58 Two lines are needed in the config.yml :
  59
  60 ```yaml
  61   type: "Medusa"
  62   apikey: "01234deb70424befb1f4ef6a23456789"
  63 ```
  64
  65 The url must be the root url of Medusa application.
  66 The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
  67
  68 ## Sonarr/Radarr
  69
  70 This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application.
  71 Two lines are needed in the config.yml :
  72
  73 ```yaml
  74   type: "Radarr" or "Sonarr"
  75   apikey: "01234deb70424befb1f4ef6a23456789"
  76 ```
  77
  78 The url must be the root url of Radarr/Sonarr application.
  79 The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.
  80
  81 ## PaperlessNG
  82
  83 This service displays total number of documents stored. Two lines are required:
  84
  85 ```yaml
  86   type: "PaperlessNG"
  87   apikey: "0123456789abcdef123456789abcdef"
  88 ```
  89
  90 API key can be generated in Settings > Administration > Auth Tokens
  91
  92 ## Ping
  93
  94 For Ping you need to set the type to Ping and provide a url.
  95
  96 ```yaml
  97 - name: "Awesome app"
  98   type: Ping
  99   logo: "assets/tools/sample.png"
 100   subtitle: "Bookmark example"
 101   tag: "app"
 102   url: "https://www.reddit.com/r/selfhosted/"
 103 ```
 104
 105 ## Prometheus
 106
 107 For Prometheus you need to set the type to Prometheus and provide a url.
 108
 109 ```yaml
 110 - name: "Prometheus"
 111   type: Prometheus
 112   logo: "assets/tools/sample.png"
 113   url: "http://192.168.0.151/"
 114   # subtitle: "Monitor data server"
 115 ```
 116
 117 ## AdGuard Home
 118 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.
 119 In `config.yml`
 120 ```yaml
 121 - name: "Adguard"
 122   logo: "assets/tools/adguardhome.png"
 123   url: "https://adguard.exemple.com"
 124   target: "_blank"
 125   type: "AdGuardHome"
 126 ```
 127 In your conf files for your AdGuard Home instance
 128 ```
 129 location /control/stats {
 130   proxy_set_header Authorization "Basic [admin:password in Base64]";
 131 }
 132
 133 location /control/status {
 134   proxy_set_header Authorization "Basic [admin:password in Base64]";
 135 }
 136 ```