Merge pull request #246 from waschinski/mealie-service

[github/bastienwirtz/homer.git] / docs / configuration.md

diff --git a/docs/configuration.md b/docs/configuration.md
index a76ecb3b8fa28eacc89cd913f85856f2b3e11507..68711ec4325795dfffeb992a82fe28429e70ede0 100644 (file)
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -170,3 +170,20 @@ In order to easily generate all required icon preset for the PWA to work, a tool
 ```bash
 npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
 ```
+
+### Supported services
+
+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.
+
+- PiHole
+- AdGuardHome
+- PaperlessNG
+- Mealie
+
+### Additional configuration
+
+#### Paperless
+For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
+
+#### Mealie
+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.