aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--docs/custom_services.md56
1 files changed, 55 insertions, 1 deletions
diff --git a/docs/custom_services.md b/docs/custom_services.md
index cb68e1d..be9d6cb 100644
--- a/docs/custom_services.md
+++ b/docs/custom_services.md
@@ -6,7 +6,18 @@ apikey included in the configuration file is exposed to anyone who can access th
6if your homer instance is secured behind some form of authentication or access restriction. 6if your homer instance is secured behind some form of authentication or access restriction.
7 7
8Available services are in `src/components/`. Here is an overview of all custom services that are available 8Available services are in `src/components/`. Here is an overview of all custom services that are available
9within Homer. 9within Homer:
10+ [PiHole](#pihole)
11+ [OpenWeatherMap](#openweathermap)
12+ [Medusa](#medusa)
13+ [Lidarr, Prowlarr, Sonarr and Radarr](#lidarr-prowlarr-sonarr-and-radarr)
14+ [PaperlessNG](#paperlessng)
15+ [Ping](#ping)
16+ [Prometheus](#prometheus)
17+ [AdGuard Home](#adguard-home)
18+ [Portainer](#portainer)
19+ [Emby](#emby)
20+ [Uptime Kuma](#uptime-kuma)
10 21
11If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. 22If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
12 23
@@ -126,11 +137,23 @@ For Prometheus you need to set the type to Prometheus and provide a url.
126 # subtitle: "Monitor data server" 137 # subtitle: "Monitor data server"
127``` 138```
128 139
140## AdGuard Home
141For 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.
142
143```yaml
144- name: "Adguard"
145 logo: "assets/tools/adguardhome.png"
146 url: "https://adguard.exemple.com"
147 target: "_blank"
148 type: "AdGuardHome"
149```
150
129## Portainer 151## Portainer
130 152
131This service displays info about the total number of containers managed by your Portainer instance. 153This service displays info about the total number of containers managed by your Portainer instance.
132In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass 154In order to use it, you must be using Portainer version 1.11 or later. Generate an access token from the UI and pass
133it to the apikey field. 155it to the apikey field.
156By 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.
134 157
135See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens 158See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
136 159
@@ -140,4 +163,35 @@ See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
140 url: "http://192.168.0.151/" 163 url: "http://192.168.0.151/"
141 type: "Portainer" 164 type: "Portainer"
142 apikey: "MY-SUPER-SECRET-API-KEY" 165 apikey: "MY-SUPER-SECRET-API-KEY"
166 # environments:
167 # - "raspberry"
168 # - "local"
169```
170
171## Emby
172
173You need to set the type to Emby, provide an api key and choose which stats to show if the subtitle is disabled.
174
175```yaml
176- name: "Emby"
177 logo: "assets/tools/sample.png"
178 url: "http://192.168.0.151/"
179 type: "Emby"
180 apikey: "MY-SUPER-SECRET-API-KEY"
181 libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies.
182```
183
184## Uptime Kuma
185
186Using the Uptime Kuma service you can display info about your instance uptime right on your Homer dashboard.
187
188The 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).
189
190```yaml
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.
196 type: "UptimeKuma"
143``` 197```