aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/customservices.md
diff options
context:
space:
mode:
authorBastien Wirtz <bastien.wirtz@gmail.com>2021-07-14 01:52:35 -0700
committerGitHub <noreply@github.com>2021-07-14 01:52:35 -0700
commit9e1b1bd1d251f60e6061fd35a91938ebe02cc72a (patch)
tree84fd744d038bc043bea26ce58aa42a5fac24836b /docs/customservices.md
parent996011956b97566849167ccd6ec470ab38b0ec60 (diff)
parent4399f5fadec678c37fa417e24faf4343615338b3 (diff)
downloadhomer-9e1b1bd1d251f60e6061fd35a91938ebe02cc72a.tar.gz
homer-9e1b1bd1d251f60e6061fd35a91938ebe02cc72a.tar.zst
homer-9e1b1bd1d251f60e6061fd35a91938ebe02cc72a.zip
Merge pull request #178 from twolaw/healthcheck2
Create Radarr, Sonarr & Medusa services
Diffstat (limited to 'docs/customservices.md')
-rw-r--r--docs/customservices.md41
1 files changed, 41 insertions, 0 deletions
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.