aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md4
-rw-r--r--docs/customservices.md35
2 files changed, 38 insertions, 1 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index a43d7f1..6c6a444 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
@@ -118,6 +118,8 @@ services:
118 # background: red # optional color for card to set color directly without custom stylesheet 118 # background: red # optional color for card to set color directly without custom stylesheet
119``` 119```
120 120
121View the (Custom Services)[customservices.md] file for details about all available custom services (like PiHole).
122
121If you choose to fetch message information from an endpoint, the output format should be: 123If you choose to fetch message information from an endpoint, the output format should be:
122 124
123```json 125```json
diff --git a/docs/customservices.md b/docs/customservices.md
new file mode 100644
index 0000000..42bd87d
--- /dev/null
+++ b/docs/customservices.md
@@ -0,0 +1,35 @@
1# Tips & Tricks
2
3Here is an overview of all custom services that are avaiable within Homer.
4
5## PiHole
6
7Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard.
8
9The following configuration is available for the PiHole service.
10
11```
12 items:
13 - name: "Pi-hole"
14 logo: "assets/tools/sample.png"
15 # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
16 url: "http://192.168.0.151/admin"
17 type: "PiHole"
18```
19
20## OpenWeatherMap
21
22Using the OpenWeatherMap service you can display weather information about a given location.
23
24The following configuration is available for the OpenWeatherMap service
25
26```
27items:
28 - name: "Weather"
29 url: "https://api.openweathermap.org/data/2.5/weather"
30 location: "Amsterdam" # your location.
31 apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
32 units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
33 background: "square" choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
34 type: "OpenWeather"
35```