diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/configuration.md | 5 | ||||
-rw-r--r-- | docs/customservices.md | 23 |
2 files changed, 26 insertions, 2 deletions
diff --git a/docs/configuration.md b/docs/configuration.md index a472b41..a76ecb3 100644 --- a/docs/configuration.md +++ b/docs/configuration.md | |||
@@ -7,7 +7,7 @@ Title, icons, links, colors, and services can be configured in the `config.yml` | |||
7 | # Homepage configuration | 7 | # Homepage configuration |
8 | # See https://fontawesome.com/icons for icons options | 8 | # See https://fontawesome.com/icons for icons options |
9 | 9 | ||
10 | # Optional: Use external configuration file. | 10 | # Optional: Use external configuration file. |
11 | # Using this will ignore remaining config in this file | 11 | # Using this will ignore remaining config in this file |
12 | # externalConfig: https://example.com/server-luci/config.yaml | 12 | # externalConfig: https://example.com/server-luci/config.yaml |
13 | 13 | ||
@@ -136,6 +136,9 @@ services: | |||
136 | # background: red # optional color for card to set color directly without custom stylesheet | 136 | # background: red # optional color for card to set color directly without custom stylesheet |
137 | ``` | 137 | ``` |
138 | 138 | ||
139 | |||
140 | View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them. | ||
141 | |||
139 | If you choose to fetch message information from an endpoint, the output format should be as follows (or you can [custom map fields as shown in tips-and-tricks](./tips-and-tricks.md#mapping-fields)): | 142 | If you choose to fetch message information from an endpoint, the output format should be as follows (or you can [custom map fields as shown in tips-and-tricks](./tips-and-tricks.md#mapping-fields)): |
140 | 143 | ||
141 | ```json | 144 | ```json |
diff --git a/docs/customservices.md b/docs/customservices.md index 43f45f4..150e232 100644 --- a/docs/customservices.md +++ b/docs/customservices.md | |||
@@ -19,6 +19,27 @@ The following configuration is available for the PiHole service. | |||
19 | type: "PiHole" | 19 | type: "PiHole" |
20 | ``` | 20 | ``` |
21 | 21 | ||
22 | |||
23 | ## OpenWeatherMap | ||
24 | |||
25 | Using the OpenWeatherMap service you can display weather information about a given location. | ||
26 | The following configuration is available for the OpenWeatherMap service: | ||
27 | |||
28 | ``` | ||
29 | items: | ||
30 | - name: "Weather" | ||
31 | location: "Amsterdam" # your location. | ||
32 | locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy | ||
33 | apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. | ||
34 | units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. | ||
35 | background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. | ||
36 | type: "OpenWeather" | ||
37 | ``` | ||
38 | |||
39 | **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). | ||
41 | |||
42 | |||
22 | ## Medusa | 43 | ## Medusa |
23 | 44 | ||
24 | This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. | 45 | This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. |
@@ -50,4 +71,4 @@ For Paperless you need an API-Key which you have to store at the item in the fie | |||
50 | 71 | ||
51 | ## Ping | 72 | ## Ping |
52 | 73 | ||
53 | For Paperless you need an API-Key which you have to store at the item in the field `apikey`. | 74 | For Ping you need an API-Key which you have to store at the item in the field `apikey`. |