From 1d3287dcca801a000dbdb40ef20fd26a97ebb2e3 Mon Sep 17 00:00:00 2001 From: Bastien Wirtz Date: Sat, 25 Sep 2021 12:12:22 +0200 Subject: Apply linters --- docs/customservices.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) (limited to 'docs/customservices.md') 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 @@ # Custom Services Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml -configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available +configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available within Homer. ## PiHole @@ -10,7 +10,7 @@ Using the PiHole service you can display info about your local PiHole instance r The following configuration is available for the PiHole service. -``` +```yaml items: - name: "Pi-hole" logo: "assets/tools/sample.png" @@ -19,13 +19,12 @@ The following configuration is available for the PiHole service. type: "PiHole" ``` - ## OpenWeatherMap Using the OpenWeatherMap service you can display weather information about a given location. The following configuration is available for the OpenWeatherMap service: -``` +```yaml items: - name: "Weather" location: "Amsterdam" # your location. @@ -39,36 +38,36 @@ items: **Remarks:** 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). - ## Medusa This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. Two lines are needed in the config.yml : -``` + +```yaml type: "Medusa" apikey: "01234deb70424befb1f4ef6a23456789" ``` + The url must be the root url of Medusa application. The Medusa API key can be found in General configuration > Interface. It is needed to access Medusa API. - ## Sonarr/Radarr This service displays Activity (blue), Warning (orange) or Error (red) notifications bubbles from the Radarr/Sonarr application. Two lines are needed in the config.yml : -``` + +```yaml type: "Radarr" or "Sonarr" apikey: "01234deb70424befb1f4ef6a23456789" ``` + The url must be the root url of Radarr/Sonarr application. The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API. - ## PaperlessNG For Paperless you need an API-Key which you have to store at the item in the field `apikey`. - ## Ping For Ping you need an API-Key which you have to store at the item in the field `apikey`. -- cgit v1.2.3