X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fcustomservices.md;h=00d3288c348f9b4b0243eeb21a5abfbded843aa1;hb=7e48e099aa968307d2b99720a076b4bdc706b5fd;hp=509278f3481e2224dcc4b2c9f293b5eac6f564bb;hpb=9c370d3c5e25d1a5e3e04f6e146e35883e4ac2e3;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/docs/customservices.md b/docs/customservices.md index 509278f..00d3288 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -17,6 +17,8 @@ within Homer: + [AdGuard Home](#adguard-home) + [Portainer](#portainer) + [Emby](#emby) ++ [Uptime Kuma](#uptime-kuma) ++ [Tautulli](#tautulli) If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. @@ -179,3 +181,45 @@ You need to set the type to Emby, provide an api key and choose which stats to s apikey: "MY-SUPER-SECRET-API-KEY" libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies. ``` + +## Uptime Kuma + +Using the Uptime Kuma service you can display info about your instance uptime right on your Homer dashboard. + +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). + +```yaml +- name: "Uptime Kuma" + logo: "assets/tools/sample.png" + # subtitle: "A fancy self-hosted monitoring tool" # optional, if no subtitle is defined, Uptime Kuma incidents, if any, will be shown + url: "http://192.168.0.151:3001" + slug: "myCustomDashboard" # Defaults to "default" if not provided. + type: "UptimeKuma" +``` + +## Tautulli + +The Tautulli service can allow you to show the number of currently active +streams on you Plex instance. An API key is required, and can be obtained from +the "Web Interface" section of settings on the Tautulli web UI. + +```yaml +- name: "Tautulli" + logo: "assets/tools/sample.png" + url: "http://192.168.0.151:8181" + type: "Tautulli" + apikey: "MY-SUPER-SECRET-API-KEY" +``` + +Because the service type and link don't necessarily have to match, you could +even make the service type Tautulli on your Plex card and provide a separate +endpoint pointing to Tautulli! + +```yaml +- name: "Plex" + logo: "assets/tools/sample.png" + url: "http://192.168.0.151:32400/web" # Plex + endpoint: "http://192.168.0.151:8181" # Tautulli + type: "Tautulli" + apikey: "MY-SUPER-SECRET-API-KEY" +```