diff options
Diffstat (limited to 'docs/configuration.md')
| -rw-r--r-- | docs/configuration.md | 29 |
1 files changed, 25 insertions, 4 deletions
diff --git a/docs/configuration.md b/docs/configuration.md index a472b41..d90981a 100644 --- a/docs/configuration.md +++ b/docs/configuration.md | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | ## Configuration | 1 | # Configuration |
| 2 | 2 | ||
| 3 | Title, 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. | 3 | Title, 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 | ||
| @@ -136,6 +136,8 @@ 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 | View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them. | ||
| 140 | |||
| 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)): | 141 | 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 | 142 | ||
| 141 | ```json | 143 | ```json |
| @@ -149,7 +151,7 @@ If you choose to fetch message information from an endpoint, the output format s | |||
| 149 | `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. |
| 150 | Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar). | 152 | Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar). |
| 151 | 153 | ||
| 152 | ### Style Options | 154 | ## Style Options |
| 153 | 155 | ||
| 154 | Homer 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: | 156 | Homer 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: |
| 155 | 157 | ||
| @@ -160,10 +162,29 @@ Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](h | |||
| 160 | 162 | ||
| 161 | You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state. | 163 | You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state. |
| 162 | 164 | ||
| 163 | ### PWA Icons | 165 | ## PWA Icons |
| 164 | 166 | ||
| 165 | In 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: | 167 | In 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: |
| 166 | 168 | ||
| 167 | ```bash | 169 | ```bash |
| 168 | npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder} | 170 | npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder} |
| 169 | ``` | 171 | ``` |
| 172 | |||
| 173 | ## Supported services | ||
| 174 | |||
| 175 | Currently 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. | ||
| 176 | |||
| 177 | - PiHole | ||
| 178 | - AdGuardHome | ||
| 179 | - PaperlessNG | ||
| 180 | - Mealie | ||
| 181 | |||
| 182 | ## Additional configuration | ||
| 183 | |||
| 184 | ### Paperless | ||
| 185 | |||
| 186 | For Paperless you need an API-Key which you have to store at the item in the field `apikey`. | ||
| 187 | |||
| 188 | ### Mealie | ||
| 189 | |||
| 190 | First 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. | ||