diff options
Diffstat (limited to 'docs/customservices.md')
-rw-r--r-- | docs/customservices.md | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/customservices.md b/docs/customservices.md new file mode 100644 index 0000000..5778fad --- /dev/null +++ b/docs/customservices.md | |||
@@ -0,0 +1,53 @@ | |||
1 | # Custom Services | ||
2 | |||
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. Available services are in `src/components/`. Here is an overview of all custom services that are available | ||
5 | within Homer. | ||
6 | |||
7 | ## PiHole | ||
8 | |||
9 | Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. | ||
10 | |||
11 | The following configuration is available for the PiHole service. | ||
12 | |||
13 | ``` | ||
14 | items: | ||
15 | - name: "Pi-hole" | ||
16 | logo: "assets/tools/sample.png" | ||
17 | # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown | ||
18 | url: "http://192.168.0.151/admin" | ||
19 | type: "PiHole" | ||
20 | ``` | ||
21 | |||
22 | ## Medusa | ||
23 | |||
24 | This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. | ||
25 | Two lines are needed in the config.yml : | ||
26 | ``` | ||
27 | type: "Medusa" | ||
28 | apikey: "01234deb70424befb1f4ef6a23456789" | ||
29 | ``` | ||
30 | The url must be the root url of Medusa application. | ||
31 | The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. | ||
32 | |||
33 | |||
34 | ## Sonarr/Radarr | ||
35 | |||
36 | This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. | ||
37 | Two lines are needed in the config.yml : | ||
38 | ``` | ||
39 | type: "Radarr" or "Sonarr" | ||
40 | apikey: "01234deb70424befb1f4ef6a23456789" | ||
41 | ``` | ||
42 | The url must be the root url of Radarr/Sonarr application. | ||
43 | The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. | ||
44 | |||
45 | |||
46 | ## PaperlessNG | ||
47 | |||
48 | For Paperless you need an API-Key which you have to store at the item in the field `apikey`. | ||
49 | |||
50 | |||
51 | ## Ping | ||
52 | |||
53 | For Ping you need an API-Key which you have to store at the item in the field `apikey`. | ||