aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/customservices.md40
1 files changed, 39 insertions, 1 deletions
diff --git a/docs/customservices.md b/docs/customservices.md
index cb68e1d..509278f 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -6,7 +6,17 @@ 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)
10 20
11If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. 21If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
12 22
@@ -126,11 +136,23 @@ For Prometheus you need to set the type to Prometheus and provide a url.
126 # subtitle: "Monitor data server" 136 # subtitle: "Monitor data server"
127``` 137```
128 138
139## AdGuard Home
140For 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.
141
142```yaml
143- name: "Adguard"
144 logo: "assets/tools/adguardhome.png"
145 url: "https://adguard.exemple.com"
146 target: "_blank"
147 type: "AdGuardHome"
148```
149
129## Portainer 150## Portainer
130 151
131This service displays info about the total number of containers managed by your Portainer instance. 152This 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 153In 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. 154it to the apikey field.
155By 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 156
135See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens 157See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
136 158
@@ -140,4 +162,20 @@ See https://docs.portainer.io/v/ce-2.11/user/account-settings#access-tokens
140 url: "http://192.168.0.151/" 162 url: "http://192.168.0.151/"
141 type: "Portainer" 163 type: "Portainer"
142 apikey: "MY-SUPER-SECRET-API-KEY" 164 apikey: "MY-SUPER-SECRET-API-KEY"
165 # environments:
166 # - "raspberry"
167 # - "local"
168```
169
170## Emby
171
172You need to set the type to Emby, provide an api key and choose which stats to show if the subtitle is disabled.
173
174```yaml
175- name: "Emby"
176 logo: "assets/tools/sample.png"
177 url: "http://192.168.0.151/"
178 type: "Emby"
179 apikey: "MY-SUPER-SECRET-API-KEY"
180 libraryType: "music" #Choose which stats to show. Can be one of: music, series or movies.
143``` 181```