aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/configuration.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration.md')
-rw-r--r--docs/configuration.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index 68711ec..d90981a 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
@@ -136,7 +136,6 @@ 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
140View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them. 139View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them.
141 140
142If 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)): 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)):
@@ -152,7 +151,7 @@ If you choose to fetch message information from an endpoint, the output format s
152`null` value or missing keys will be ignored and value from the `config.yml` will be used if available. 151`null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
153Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar). 152Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
154 153
155### Style Options 154## Style Options
156 155
157Homer 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: 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:
158 157
@@ -163,7 +162,7 @@ Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](h
163 162
164You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state. 163You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
165 164
166### PWA Icons 165## PWA Icons
167 166
168In 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: 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:
169 168
@@ -171,7 +170,7 @@ In order to easily generate all required icon preset for the PWA to work, a tool
171npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder} 170npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
172``` 171```
173 172
174### Supported services 173## Supported services
175 174
176Currently 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. 175Currently 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.
177 176
@@ -180,10 +179,12 @@ Currently the following services are supported for showing quick infos on the ca
180- PaperlessNG 179- PaperlessNG
181- Mealie 180- Mealie
182 181
183### Additional configuration 182## Additional configuration
183
184### Paperless
184 185
185#### Paperless
186For Paperless you need an API-Key which you have to store at the item in the field `apikey`. 186For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
187 187
188#### Mealie 188### Mealie
189
189First 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. 190First 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.