diff options
Diffstat (limited to 'docs/customservices.md')
-rw-r--r-- | docs/customservices.md | 41 |
1 files changed, 39 insertions, 2 deletions
diff --git a/docs/customservices.md b/docs/customservices.md index 40f2e3d..4f64ecc 100644 --- a/docs/customservices.md +++ b/docs/customservices.md | |||
@@ -1,6 +1,8 @@ | |||
1 | # Custom Services | 1 | # Custom Services |
2 | 2 | ||
3 | Here is an overview of all custom services that are available within Homer. | 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. | ||
4 | 6 | ||
5 | ## PiHole | 7 | ## PiHole |
6 | 8 | ||
@@ -17,6 +19,7 @@ The following configuration is available for the PiHole service. | |||
17 | type: "PiHole" | 19 | type: "PiHole" |
18 | ``` | 20 | ``` |
19 | 21 | ||
22 | |||
20 | ## OpenWeatherMap | 23 | ## OpenWeatherMap |
21 | 24 | ||
22 | Using the OpenWeatherMap service you can display weather information about a given location. | 25 | Using the OpenWeatherMap service you can display weather information about a given location. |
@@ -35,4 +38,38 @@ items: | |||
35 | ``` | 38 | ``` |
36 | 39 | ||
37 | **Remarks:** | 40 | **Remarks:** |
38 | 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). \ No newline at end of file | 41 | 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). |
42 | |||
43 | |||
44 | ## Medusa | ||
45 | |||
46 | This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. | ||
47 | Two lines are needed in the config.yml : | ||
48 | ``` | ||
49 | type: "Medusa" | ||
50 | apikey: "01234deb70424befb1f4ef6a23456789" | ||
51 | ``` | ||
52 | The url must be the root url of Medusa application. | ||
53 | The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. | ||
54 | |||
55 | |||
56 | ## Sonarr/Radarr | ||
57 | |||
58 | This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. | ||
59 | Two lines are needed in the config.yml : | ||
60 | ``` | ||
61 | type: "Radarr" or "Sonarr" | ||
62 | apikey: "01234deb70424befb1f4ef6a23456789" | ||
63 | ``` | ||
64 | The url must be the root url of Radarr/Sonarr application. | ||
65 | The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. | ||
66 | |||
67 | |||
68 | ## PaperlessNG | ||
69 | |||
70 | For Paperless you need an API-Key which you have to store at the item in the field `apikey`. | ||
71 | |||
72 | |||
73 | ## Ping | ||
74 | |||
75 | For Ping you need an API-Key which you have to store at the item in the field `apikey`. | ||