aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md13
-rw-r--r--docs/customservices.md41
2 files changed, 54 insertions, 0 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index a472b41..ce36c51 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -167,3 +167,16 @@ In order to easily generate all required icon preset for the PWA to work, a tool
167```bash 167```bash
168npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder} 168npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
169``` 169```
170
171### Supported services
172
173Currently the following services are supported for showing quick infos on the card. They can be used by setting the type to one of the following values at the item.
174
175- PiHole
176- AdGuardHome
177- PaperlessNG
178
179### Additional configuration
180
181#### Paperless
182For Paperless you need an API-Key which you have to store at the item in the field `apikey`. \ No newline at end of file
diff --git a/docs/customservices.md b/docs/customservices.md
new file mode 100644
index 0000000..d2deff4
--- /dev/null
+++ b/docs/customservices.md
@@ -0,0 +1,41 @@
1# Custom Services
2
3Here is an overview of all custom services that are available within Homer.
4
5## PiHole
6
7Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
8
9The following configuration is available for the PiHole service.
10
11```
12 items:
13 - name: "Pi-hole"
14 logo: "assets/tools/sample.png"
15 # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
16 url: "http://192.168.0.151/admin"
17 type: "PiHole"
18```
19
20## Medusa
21
22This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
23Two lines are needed in the config.yml :
24```
25type: "Medusa"
26apikey: "01234deb70424befb1f4ef6a23456789"
27```
28The url must be the root url of Medusa application.
29The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
30
31
32## Sonarr/Radarr
33
34This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application.
35Two lines are needed in the config.yml :
36```
37type: "Radarr" or "Sonarr"
38apikey: "01234deb70424befb1f4ef6a23456789"
39```
40The url must be the root url of Radarr/Sonarr application.
41The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.