X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fconfiguration.md;h=a76ecb3b8fa28eacc89cd913f85856f2b3e11507;hb=92d5b8d424cbd4c227c9c76931930787deec4a2f;hp=ce36c51604ac991afd12f9adf70737e120176d54;hpb=f5b467f93349b326e832bcd92b29a854bb737c57;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/docs/configuration.md b/docs/configuration.md index ce36c51..a76ecb3 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -7,7 +7,7 @@ Title, icons, links, colors, and services can be configured in the `config.yml` # Homepage configuration # See https://fontawesome.com/icons for icons options -# Optional: Use external configuration file. +# Optional: Use external configuration file. # Using this will ignore remaining config in this file # externalConfig: https://example.com/server-luci/config.yaml @@ -136,6 +136,9 @@ services: # background: red # optional color for card to set color directly without custom stylesheet ``` + +View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them. + 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)): ```json @@ -167,16 +170,3 @@ 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