aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/configuration.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration.md')
-rw-r--r--docs/configuration.md29
1 files changed, 25 insertions, 4 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index 93abadb..807fa68 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -1,4 +1,4 @@
1## Configuration 1# Configuration
2 2
3Title, icons, links, colors, and services can be configured in the `config.yml` file (located in `/assets` directory once built, or in the `public/assets` directory in development mode), using [yaml](http://yaml.org/) format. 3Title, icons, links, colors, and services can be configured in the `config.yml` file (located in `/assets` directory once built, or in the `public/assets` directory in development mode), using [yaml](http://yaml.org/) format.
4 4
@@ -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
@@ -138,6 +138,8 @@ services:
138 # background: red # optional color for card to set color directly without custom stylesheet 138 # background: red # optional color for card to set color directly without custom stylesheet
139``` 139```
140 140
141View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them.
142
141If 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)): 143If 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 144
143```json 145```json
@@ -151,7 +153,7 @@ If you choose to fetch message information from an endpoint, the output format s
151`null` value or missing keys will be ignored and value from the `config.yml` will be used if available. 153`null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
152Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar). 154Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
153 155
154### Style Options 156## Style Options
155 157
156Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll notice in the config there is a `tagstyle` option. It can be set to any of the bulma modifiers. You'll probably want to use one of these 4 main colors: 158Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll notice in the config there is a `tagstyle` option. It can be set to any of the bulma modifiers. You'll probably want to use one of these 4 main colors:
157 159
@@ -162,10 +164,29 @@ Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](h
162 164
163You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state. 165You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
164 166
165### PWA Icons 167## PWA Icons
166 168
167In order to easily generate all required icon preset for the PWA to work, a tool like [vue-pwa-asset-generator](https://www.npmjs.com/package/vue-pwa-asset-generator) can be used: 169In order to easily generate all required icon preset for the PWA to work, a tool like [vue-pwa-asset-generator](https://www.npmjs.com/package/vue-pwa-asset-generator) can be used:
168 170
169```bash 171```bash
170npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder} 172npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
171``` 173```
174
175## Supported services
176
177Currently the following services are supported for showing quick infos on the card. They can be used by setting the type to one of the following values at the item.
178
179- PiHole
180- AdGuardHome
181- PaperlessNG
182- Mealie
183
184## Additional configuration
185
186### Paperless
187
188For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
189
190### Mealie
191
192First off make sure to remove an existing `subtitle` as it will take precedence if set. Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized or the planned meal for today if one is planned. You will have to set an API key in the field `apikey` which can be created in your Mealie installation.