diff options
Diffstat (limited to 'docs/customservices.md')
-rw-r--r-- | docs/customservices.md | 19 |
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 | ||
3 | Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml | 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 | 4 | configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available |
5 | within Homer. | 5 | within 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 | ||
11 | The following configuration is available for the PiHole service. | 11 | The 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 | ||
25 | Using the OpenWeatherMap service you can display weather information about a given location. | 24 | Using the OpenWeatherMap service you can display weather information about a given location. |
26 | The following configuration is available for the OpenWeatherMap service: | 25 | The following configuration is available for the OpenWeatherMap service: |
27 | 26 | ||
28 | ``` | 27 | ```yaml |
29 | items: | 28 | items: |
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:** |
40 | If 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). | 39 | If 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 | ||
45 | This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. | 43 | This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. |
46 | Two lines are needed in the config.yml : | 44 | Two lines are needed in the config.yml : |
47 | ``` | 45 | |
46 | ```yaml | ||
48 | type: "Medusa" | 47 | type: "Medusa" |
49 | apikey: "01234deb70424befb1f4ef6a23456789" | 48 | apikey: "01234deb70424befb1f4ef6a23456789" |
50 | ``` | 49 | ``` |
50 | |||
51 | The url must be the root url of Medusa application. | 51 | The url must be the root url of Medusa application. |
52 | The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. | 52 | The 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 | ||
57 | This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. | 56 | This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. |
58 | Two lines are needed in the config.yml : | 57 | Two lines are needed in the config.yml : |
59 | ``` | 58 | |
59 | ```yaml | ||
60 | type: "Radarr" or "Sonarr" | 60 | type: "Radarr" or "Sonarr" |
61 | apikey: "01234deb70424befb1f4ef6a23456789" | 61 | apikey: "01234deb70424befb1f4ef6a23456789" |
62 | ``` | 62 | ``` |
63 | |||
63 | The url must be the root url of Radarr/Sonarr application. | 64 | The url must be the root url of Radarr/Sonarr application. |
64 | The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. | 65 | The 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 | ||
69 | For Paperless you need an API-Key which you have to store at the item in the field `apikey`. | 69 | For 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 | ||
74 | For Ping you need an API-Key which you have to store at the item in the field `apikey`. | 73 | For Ping you need an API-Key which you have to store at the item in the field `apikey`. |