aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/customservices.md
diff options
context:
space:
mode:
authorBastien Wirtz <bastien.wirtz@gmail.com>2021-09-25 12:12:22 +0200
committerBastien Wirtz <bastien.wirtz@gmail.com>2021-09-25 12:18:13 +0200
commit1d3287dcca801a000dbdb40ef20fd26a97ebb2e3 (patch)
tree1d686bb1ddc88becccd25a4e7f1f34453561b711 /docs/customservices.md
parent6173d7df609bc3ab071d5d9e34ce1eb1cb05d99e (diff)
downloadhomer-1d3287dcca801a000dbdb40ef20fd26a97ebb2e3.tar.gz
homer-1d3287dcca801a000dbdb40ef20fd26a97ebb2e3.tar.zst
homer-1d3287dcca801a000dbdb40ef20fd26a97ebb2e3.zip
Apply linters
Diffstat (limited to 'docs/customservices.md')
-rw-r--r--docs/customservices.md19
1 files changed, 9 insertions, 10 deletions
diff --git a/docs/customservices.md b/docs/customservices.md
index 150e232..83d5f3e 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -1,7 +1,7 @@
1# Custom Services 1# Custom Services
2 2
3Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml 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 4configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available
5within Homer. 5within Homer.
6 6
7## PiHole 7## PiHole
@@ -10,7 +10,7 @@ Using the PiHole service you can display info about your local PiHole instance r
10 10
11The following configuration is available for the PiHole service. 11The following configuration is available for the PiHole service.
12 12
13``` 13```yaml
14 items: 14 items:
15 - name: "Pi-hole" 15 - name: "Pi-hole"
16 logo: "assets/tools/sample.png" 16 logo: "assets/tools/sample.png"
@@ -19,13 +19,12 @@ The following configuration is available for the PiHole service.
19 type: "PiHole" 19 type: "PiHole"
20``` 20```
21 21
22
23## OpenWeatherMap 22## OpenWeatherMap
24 23
25Using the OpenWeatherMap service you can display weather information about a given location. 24Using the OpenWeatherMap service you can display weather information about a given location.
26The following configuration is available for the OpenWeatherMap service: 25The following configuration is available for the OpenWeatherMap service:
27 26
28``` 27```yaml
29items: 28items:
30 - name: "Weather" 29 - name: "Weather"
31 location: "Amsterdam" # your location. 30 location: "Amsterdam" # your location.
@@ -39,36 +38,36 @@ items:
39**Remarks:** 38**Remarks:**
40If for some reason your city can't be found by entering the name in the `location` property, you could also try to configure the OWM city ID in the `locationId` property. To retrieve your specific City ID, go to the [OWM website](https://openweathermap.org), search for your city and retrieve the ID from the URL (for example, the City ID of Amsterdam is 2759794). 39If for some reason your city can't be found by entering the name in the `location` property, you could also try to configure the OWM city ID in the `locationId` property. To retrieve your specific City ID, go to the [OWM website](https://openweathermap.org), search for your city and retrieve the ID from the URL (for example, the City ID of Amsterdam is 2759794).
41 40
42
43## Medusa 41## Medusa
44 42
45This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. 43This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
46Two lines are needed in the config.yml : 44Two lines are needed in the config.yml :
47``` 45
46```yaml
48type: "Medusa" 47type: "Medusa"
49apikey: "01234deb70424befb1f4ef6a23456789" 48apikey: "01234deb70424befb1f4ef6a23456789"
50``` 49```
50
51The url must be the root url of Medusa application. 51The url must be the root url of Medusa application.
52The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. 52The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API.
53 53
54
55## Sonarr/Radarr 54## Sonarr/Radarr
56 55
57This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. 56This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application.
58Two lines are needed in the config.yml : 57Two lines are needed in the config.yml :
59``` 58
59```yaml
60type: "Radarr" or "Sonarr" 60type: "Radarr" or "Sonarr"
61apikey: "01234deb70424befb1f4ef6a23456789" 61apikey: "01234deb70424befb1f4ef6a23456789"
62``` 62```
63
63The url must be the root url of Radarr/Sonarr application. 64The url must be the root url of Radarr/Sonarr application.
64The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. 65The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.
65 66
66
67## PaperlessNG 67## PaperlessNG
68 68
69For Paperless you need an API-Key which you have to store at the item in the field `apikey`. 69For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
70 70
71
72## Ping 71## Ping
73 72
74For Ping you need an API-Key which you have to store at the item in the field `apikey`. 73For Ping you need an API-Key which you have to store at the item in the field `apikey`.