aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/configuration.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration.md')
-rw-r--r--docs/configuration.md43
1 files changed, 17 insertions, 26 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index 4f97192..584ee79 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -185,9 +185,12 @@ services:
185 # background: red 185 # background: red
186``` 186```
187 187
188View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them. 188View [Custom Services](customservices.md) for details about all available custom
189services (like PiHole) and how to configure them.
189 190
190If 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)): 191If you choose to fetch message information from an endpoint, the output format
192should be as follows (or you can
193[custom map fields as shown in tips-and-tricks](./tips-and-tricks.md#mapping-fields)):
191 194
192```json 195```json
193{ 196{
@@ -197,43 +200,31 @@ If you choose to fetch message information from an endpoint, the output format s
197} 200}
198``` 201```
199 202
200`null` value or missing keys will be ignored and value from the `config.yml` will be used if available. 203`null` value or missing keys will be ignored and value from the `config.yml`
201Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar). 204will be used if available. Empty values (either in `config.yml` or the endpoint
205data) will hide the element (ex: set `"title": ""` to hide the title bar).
202 206
203## Style Options 207## Style Options
204 208
205Homer 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: 209Homer uses [Bulma CSS](https://bulma.io/), which provides a
210[modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll
211notice in the config there is a `tagstyle` option. It can be set to any of the
212bulma modifiers. You'll probably want to use one of these 4 main colors:
206 213
207- `is-info` (blue) 214- `is-info` (blue)
208- `is-success` (green) 215- `is-success` (green)
209- `is-warning` (yellow) 216- `is-warning` (yellow)
210- `is-danger` (red) 217- `is-danger` (red)
211 218
212You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state. 219You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/)
220for other options regarding size, style, or state.
213 221
214## PWA Icons 222## PWA Icons
215 223
216In 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: 224In order to easily generate all required icon preset for the PWA to work, a tool
225like [vue-pwa-asset-generator](https://www.npmjs.com/package/vue-pwa-asset-generator)
226can be used:
217 227
218```bash 228```bash
219npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder} 229npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
220``` 230```
221
222## Supported services
223
224Currently 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.
225
226- PiHole
227- AdGuardHome
228- PaperlessNG
229- Mealie
230
231## Additional configuration
232
233### Paperless
234
235For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
236
237### Mealie
238
239First 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.