X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=docs%2Fconfiguration.md;h=ce36c51604ac991afd12f9adf70737e120176d54;hb=f5b467f93349b326e832bcd92b29a854bb737c57;hp=5785e560f645d9269642bcc8380da403a52ec81b;hpb=cc7ff885527283d97f32347210b0370e8477c4ff;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/docs/configuration.md b/docs/configuration.md index 5785e56..ce36c51 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -92,6 +92,11 @@ links: - name: "link 2" icon: "fas fa-book" url: "https://github.com/bastienwirtz/homer" + # this will link to a second homer page that will load config from page2.yml and keep default config values as in config.yml file + # see url field and assets/page.yml used in this example: + - name: "Second Page" + icon: "fas fa-file-alt" + url: "#page2" # Services # First level array represents a group. @@ -99,6 +104,8 @@ links: services: - name: "Application" icon: "fas fa-code-branch" + # A path to an image can also be provided. Note that icon take precedence if both icon and logo are set. + # logo: "path/to/logo" items: - name: "Awesome app" logo: "assets/tools/sample.png" @@ -160,3 +167,16 @@ 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 + +### Additional configuration + +#### Paperless +For Paperless you need an API-Key which you have to store at the item in the field `apikey`. \ No newline at end of file