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 - [Custom Services](#custom-services)
12 - [Common options](#common-options)
14 - [OpenWeatherMap](#openweathermap)
16 - [Lidarr, Prowlarr, Sonarr and Radarr](#lidarr-prowlarr-sonarr-and-radarr)
17 - [PaperlessNG](#paperlessng)
19 - [Prometheus](#prometheus)
20 - [AdGuard Home](#adguard-home)
21 - [Portainer](#portainer)
22 - [Emby / Jellyfin](#emby--jellyfin)
23 - [Uptime Kuma](#uptime-kuma)
24 - [Tautulli](#tautulli)
26 - [Healthchecks](#healthchecks)
28 - [rTorrent](#rtorrent)
29 - [qBittorrent](#qbittorrent)
30 - [CopyToClipboard](#copy-to-clipboard)
31 - [Speedtest Tracker](#SpeedtestTracker)
32 - [What's Up Docker](#whats-up-docker)
34 - [OctoPrint](#octoprint)
39 If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
45 logo: "assets/tools/sample.png"
46 url: "http://my-service-link"
47 endpoint: "http://my-service-endpoint" # Optional: alternative base URL used to fetch service data is necessary.
48 useCredentials: false # Optional: Override global proxy.useCredentials configuration.
54 Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
56 The following configuration is available for the PiHole service.
60 logo: "assets/tools/sample.png"
61 # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
62 url: "http://192.168.0.151/admin"
63 apikey: "<---insert-api-key-here--->" # optional, needed if web interface is password protected
68 If PiHole web interface is password protected, obtain the `apikey` from Settings > API/Web interface > Show API token.
72 Using the OpenWeatherMap service you can display weather information about a given location.
73 The following configuration is available for the OpenWeatherMap service:
77 location: "Amsterdam" # your location.
78 locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
79 apikey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
80 units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
81 background: "square" # choose which type of background you want behind the image. Can be one of: square, circle, none. Defaults to none.
86 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).
90 This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
91 Two lines are needed in the config.yml :
95 apikey: "<---insert-api-key-here--->"
98 The url must be the root url of Medusa application.
99 The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
101 ## Lidarr, Prowlarr, Sonarr and Radarr
103 This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Lidarr, Radarr or Sonarr application.
104 Two lines are needed in the config.yml :
107 type: "Lidarr", "Prowlarr", "Radarr" or "Sonarr"
108 apikey: "<---insert-api-key-here--->"
111 The url must be the root url of Lidarr, Prowlarr, Radarr or Sonarr application.
112 The Lidarr, Prowlarr, Radarr or Sonarr API key can be found in Settings > General. It is needed to access the API.
113 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:
118 url: "http://localhost:7878/"
119 apikey: "<---insert-api-key-here--->"
126 This service displays total number of documents stored. Two lines are required:
130 apikey: "<---insert-api-key-here--->"
133 API key can be generated in Settings > Administration > Auth Tokens
137 For Ping you need to set the type to Ping and provide a url. By default the HEAD method is used but it can be configured to use GET using the optional `method` property.
140 - name: "Awesome app"
142 logo: "assets/tools/sample.png"
143 subtitle: "Bookmark example"
145 url: "https://www.reddit.com/r/selfhosted/"
151 For Prometheus you need to set the type to Prometheus and provide a url.
156 logo: "assets/tools/sample.png"
157 url: "http://192.168.0.151/"
158 # subtitle: "Monitor data server"
162 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.
166 logo: "assets/tools/adguardhome.png"
167 url: "https://adguard.exemple.com"
174 This service displays info about the total number of containers managed by your Portainer instance.
175 In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass
176 it to the apikey field.
177 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.
179 See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
183 logo: "assets/tools/sample.png"
184 url: "http://192.168.0.151/"
186 apikey: "<---insert-api-key-here--->"
194 You need to set the type to Emby, provide an api key and choose which stats to show if the subtitle is disabled.
198 logo: "assets/tools/sample.png"
199 url: "http://192.168.0.151/"
201 apikey: "<---insert-api-key-here--->"
202 libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies.
207 Using the Uptime Kuma service you can display info about your instance uptime right on your Homer dashboard.
209 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).
212 - name: "Uptime Kuma"
213 logo: "assets/tools/sample.png"
214 # subtitle: "A fancy self-hosted monitoring tool" # optional, if no subtitle is defined, Uptime Kuma incidents, if any, will be shown
215 url: "http://192.168.0.151:3001"
216 slug: "myCustomDashboard" # Defaults to "default" if not provided.
222 The Tautulli service can allow you to show the number of currently active
223 streams on you Plex instance. An API key is required, and can be obtained from
224 the "Web Interface" section of settings on the Tautulli web UI.
228 logo: "assets/tools/sample.png"
229 url: "http://192.168.0.151:8181"
231 apikey: "<---insert-api-key-here--->"
234 Because the service type and link don't necessarily have to match, you could
235 even make the service type Tautulli on your Plex card and provide a separate
236 endpoint pointing to Tautulli!
240 logo: "assets/tools/sample.png"
241 url: "http://192.168.0.151:32400/web" # Plex
242 endpoint: "http://192.168.0.151:8181" # Tautulli
244 apikey: "<---insert-api-key-here--->"
249 First off make sure to remove an existing `subtitle` as it will take precedence if set.
250 Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized or the planned meal for today if one is planned. You will have to set an API key in the field `apikey` which can be created in your Mealie installation.
254 This service displays information about the configured status checks from the Healthchecks application.
255 Two lines are needed in the config.yml :
259 apikey: "<---insert-api-key-here--->"
262 The url must be the root url of the Healthchecks application.
263 The Healthchecks API key can be found in Settings > API Access > API key (read-only). The key is needed to access Healthchecks API.
267 This service displays the global upload and download rates, as well as the number of torrents
268 listed in rTorrent. The service communicates with the rTorrent XML-RPC interface which needs
269 to be accessible from the browser. Please consult
270 [the instructions](https://github.com/rakshasa/rtorrent-doc/blob/master/RPC-Setup-XMLRPC.md)
271 for setting up rTorrent and make sure the correct CORS-settings are applied. Examples for various
272 servers can be found at https://enable-cors.org/server.html.
276 logo: "assets/tools/sample.png"
277 url: "http://192.168.0.151" # Your rTorrent web UI, f.e. ruTorrent or Flood.
278 xmlrpc: "http://192.168.0.151:8081" # Reverse proxy for rTorrent's XML-RPC.
280 rateInterval: 5000 # Interval for updating the download and upload rates.
281 torrentInterval: 60000 # Interval for updating the torrent count.
282 username: "username" # Username for logging into rTorrent (if applicable).
283 password: "password" # Password for logging into rTorrent (if applicable).
289 This service displays status information of a Proxmox node (VMs running and disk, memory and cpu used). It uses the proxmox API and [API Tokens](https://pve.proxmox.com/pve-docs/pveum-plain.html) for authorization so you need to generate one to set in the yaml config. You can set it up in Proxmox under Permissions > API Tokens. You also need to know the realm the user of the API Token is assigned to (by default pam).
291 The API Token (or the user asigned to that token if not separated permissions is checked) are this:
293 | Path | Permission | Comments |
294 |--------------------|------------|-------------------------------------------------------------------|
295 | /nodes/<your-node> | Sys.Audit | |
296 | /vms/<id-vm> | VM.Audit | You need to have this permission on any VM you want to be counted |
298 It is highly recommended that you create and API Token with only these permissions on a read-only mode.
300 If you get errors, they will be shown on browser's dev console. Main issues tend to be CORS related as Proxmox does not include CORS headers and you have to deploy it behind a reverse proxy and make the proxy add this headers.
302 Configuration example:
305 - name: "Proxmox - Node"
306 logo: "https://www.google.com/url?sa=i&url=https%3A%2F%2Fgithub.com%2FandOTP%2FandOTP%2Fissues%2F337&psig=AOvVaw2YKVuEUIBeTUikr7kAjm8D&ust=1665323538747000&source=images&cd=vfe&ved=0CAkQjRxqFwoTCPCTruLj0PoCFQAAAAAdAAAAABAN"
308 url: "https://your.proxmox.server"
309 node: "your-node-name"
312 api_token: "PVEAPIToken=root@pam!your-api-token-name=your-api-token-key"
313 # values below this line are optional (default value are false/empty):
314 hide_decimals: true # removes decimals from stats values.
315 hide: [] # hides information. Possible values are "vms", "vms_total", "lxcs", "lxcs_total", "disk", "mem" and "cpu".
316 small_font_on_small_screens: true # uses small font on small screens (like mobile)
317 small_font_on_desktop: true # uses small font on desktops (just in case you're showing much info)
322 This service displays the global upload and download rates, as well as the number of torrents
323 listed. The service communicates with the qBittorrent API interface which needs
324 to be accessible from the browser. Please consult
325 [the instructions](https://github.com/qbittorrent/qBittorrent/pull/12579)
326 for setting up qBittorrent and make sure the correct CORS-settings are applied. Examples for various
327 servers can be found at [enable-cors.org](https://enable-cors.org/server.html).
330 - name: "qBittorrent"
331 logo: "assets/tools/sample.png"
332 url: "http://192.168.1.2:8080" # Your rTorrent web UI, f.e. ruTorrent or Flood.
334 rateInterval: 2000 # Interval for updating the download and upload rates.
335 torrentInterval: 5000 # Interval for updating the torrent count.
336 target: "_blank" # optional html a tag target attribute
341 This service displays the same information of a generic one, but shows an icon button on the indicator place (right side) you can click to get the content of the `clipboard` field copied to your clipboard.
343 You can still provide an `url` that would be open when clicked anywhere but on the icon button.
345 Configuration example:
349 logo: "assets/tools/sample.png"
350 subtitle: "Subtitle text goes here"
352 type: "CopyToClipboard"
353 clipboard: "this text will be copied to your clipboard"
358 For the SpeedtestTracker service you just need to define a entry with type `SpeedtestTracker`.
362 What's up Docker allow to display info about the number of container running and the number for which an update is available on your Homer dashboard.
364 The following configuration is available for the WUD service.
367 - name: "What's Up Docker"
368 logo: "assets/tools/sample.png"
369 subtitle: "Docker image update notifier"
370 url: "http://192.168.1.12:3001"
376 The SABnzbd service can allow you to show the number of currently active
377 downloads on your SABnzbd instance. An API key is required, and can be obtained from
378 the "Config" > "General" section of the SABnzbd config in the SABnzbd web UI.
382 logo: "assets/tools/sample.png"
383 url: "http://192.168.0.151:8080"
385 apikey: "MY-SUPER-SECRET-API-KEY"
386 downloadInterval: 5000 # (Optional) Interval (in ms) for updating the download count
389 ## OctoPrint/Moonraker
391 The OctoPrint/Moonraker service only needs an `apikey` & `endpoint` and optionally a `display` or `url` option. `url` can be used when you click on the service it will launch the `url`
393 Moonraker's API mimmicks a few of OctoPrint's endpoints which makes these services compatible. See https://moonraker.readthedocs.io/en/latest/web_api/#octoprint-api-emulation for details.
397 logo: "https://cdn-icons-png.flaticon.com/512/3112/3112529.png"
398 apikey: "xxxxxxxxxxxx" # insert your own API key here.
399 endpoint: "http://192.168.0.151:8080"
400 display: "text" # 'text' or 'bar'. Default to `text`.
406 The Tdarr service can allow you to show the number of currently queued items
407 for transcoding on your Tdarr instance as well as the number of errored items.
411 logo: "assets/tools/sample.png"
412 url: "http://192.168.0.151:8265"
414 checkInterval: 5000 # (Optional) Interval (in ms) for updating the queue & error counts
419 The PiAlert service displays stats from your PiAlert server.
424 updateInterval: 5000 # (Optional) Interval (in ms) for updating the stats
429 The Immich service displays stats from your Immich server.
434 apikey: "<--- Your api key --->" # administrator user
435 updateInterval: 5000 # (Optional) Interval (in ms) for updating the stats