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.
8 Available services are in `src/components/`. Here is an overview of all custom services that are available
11 + [OpenWeatherMap](#openweathermap)
13 + [Lidarr, Prowlarr, Sonarr and Radarr](#lidarr-prowlarr-sonarr-and-radarr)
14 + [PaperlessNG](#paperlessng)
16 + [Prometheus](#prometheus)
17 + [AdGuard Home](#adguard-home)
18 + [Portainer](#portainer)
20 + [Uptime Kuma](#uptime-kuma)
22 If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
29 logo: "assets/tools/sample.png"
30 url: "http://my-service-link"
31 endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary.
32 useCredentials: false # Optional: Override global proxy.useCredentials configuration.
38 Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
40 The following configuration is available for the PiHole service.
44 logo: "assets/tools/sample.png"
45 # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
46 url: "http://192.168.0.151/admin"
52 Using the OpenWeatherMap service you can display weather information about a given location.
53 The following configuration is available for the OpenWeatherMap service:
57 location: "Amsterdam" # your location.
58 locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
59 apikey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
60 units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
61 background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
66 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).
70 This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
71 Two lines are needed in the config.yml :
75 apikey: "01234deb70424befb1f4ef6a23456789"
78 The url must be the root url of Medusa application.
79 The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
81 ## Lidarr, Prowlarr, Sonarr and Radarr
83 This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Lidarr, Radarr or Sonarr application.
84 Two lines are needed in the config.yml :
87 type: "Lidarr", "Prowlarr", "Radarr" or "Sonarr"
88 apikey: "01234deb70424befb1f4ef6a23456789"
91 The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application.
92 The Lidarr, Prowlarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API.
93 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:
98 url: "http://localhost:7878/"
99 apikey: "MY-SUPER-SECRET-API-KEY"
106 This service displays total number of documents stored. Two lines are required:
110 apikey: "0123456789abcdef123456789abcdef"
113 API key can be generated in Settings > Administration > Auth Tokens
117 For Ping you need to set the type to Ping and provide a url.
120 - name: "Awesome app"
122 logo: "assets/tools/sample.png"
123 subtitle: "Bookmark example"
125 url: "https://www.reddit.com/r/selfhosted/"
130 For Prometheus you need to set the type to Prometheus and provide a url.
135 logo: "assets/tools/sample.png"
136 url: "http://192.168.0.151/"
137 # subtitle: "Monitor data server"
141 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.
145 logo: "assets/tools/adguardhome.png"
146 url: "https://adguard.exemple.com"
153 This service displays info about the total number of containers managed by your Portainer instance.
154 In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass
155 it to the apikey field.
156 By default, every connected environments will be checked. To select specific ones,add an "environments" entry which can be a simple string or an array containing all the selected environments name.
158 See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
162 logo: "assets/tools/sample.png"
163 url: "http://192.168.0.151/"
165 apikey: "MY-SUPER-SECRET-API-KEY"
173 You need to set the type to Emby, provide an api key and choose which stats to show if the subtitle is disabled.
177 logo: "assets/tools/sample.png"
178 url: "http://192.168.0.151/"
180 apikey: "MY-SUPER-SECRET-API-KEY"
181 libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies.
186 Using the Uptime Kuma service you can display info about your instance uptime right on your Homer dashboard.
188 The following configuration is available for the UptimeKuma service. Needs v1.13.1 or later because of the change in APIs due to [multiple status pages support](https://github.com/louislam/uptime-kuma/releases/tag/1.13.1).
191 - name: "Uptime Kuma"
192 logo: "assets/tools/sample.png"
193 # subtitle: "A fancy self-hosted monitoring tool" # optional, if no subtitle is defined, Uptime Kuma incidents, if any, will be shown
194 url: "http://192.168.0.151:3001"
195 slug: "myCustomDashboard" # Defaults to "default" if not provided.
201 The Tautulli service can allow you to show the number of currently active
202 streams on you Plex instance. An API key is required, and can be obtained from
203 the "Web Interface" section of settings on the Tautulli web UI.
207 logo: "assets/tools/sample.png"
208 url: "http://192.168.0.151:8181"
210 apikey: "MY-SUPER-SECRET-API-KEY"
213 Because the service type and link don't necessarily have to match, you could
214 even make the service type Tautulli on your Plex card and provide a separate
215 endpoint pointing to Tautulli!
219 logo: "assets/tools/sample.png"
220 url: "http://192.168.0.151:32400/web" # Plex
221 endpoint: "http://192.168.0.151:8181" # Tautulli
223 apikey: "MY-SUPER-SECRET-API-KEY"