aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorAndreas Waschinski <25221082+waschinski@users.noreply.github.com>2021-08-08 11:18:46 +0200
committerGitHub <noreply@github.com>2021-08-08 11:18:46 +0200
commita74fa3830232f761bb66c7509e088f7468d5b619 (patch)
tree3d74723467a10a194b481a2d7cf6c1b84bf921c1 /docs
parentbebb6953cb1e5b61be000b3f2d76a27256bff3d9 (diff)
parent35926e1e6e4669e881b8f69003f97752172eb922 (diff)
downloadhomer-a74fa3830232f761bb66c7509e088f7468d5b619.tar.gz
homer-a74fa3830232f761bb66c7509e088f7468d5b619.tar.zst
homer-a74fa3830232f761bb66c7509e088f7468d5b619.zip
Merge branch 'main' into patch-1
Diffstat (limited to 'docs')
-rw-r--r--docs/customservices.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/customservices.md b/docs/customservices.md
new file mode 100644
index 0000000..43f45f4
--- /dev/null
+++ b/docs/customservices.md
@@ -0,0 +1,53 @@
1# Custom Services
2
3Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml
4configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available
5within Homer.
6
7## PiHole
8
9Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
10
11The 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
24This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
25Two lines are needed in the config.yml :
26```
27type: "Medusa"
28apikey: "01234deb70424befb1f4ef6a23456789"
29```
30The url must be the root url of Medusa application.
31The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
32
33
34## Sonarr/Radarr
35
36This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application.
37Two lines are needed in the config.yml :
38```
39type: "Radarr" or "Sonarr"
40apikey: "01234deb70424befb1f4ef6a23456789"
41```
42The url must be the root url of Radarr/Sonarr application.
43The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.
44
45
46## PaperlessNG
47
48For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
49
50
51## Ping
52
53For Paperless you need an API-Key which you have to store at the item in the field `apikey`.