X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fconfiguration.md;h=a76ecb3b8fa28eacc89cd913f85856f2b3e11507;hb=92d5b8d424cbd4c227c9c76931930787deec4a2f;hp=3ff49fa85161621fcd5d30db82fae9987e1acd68;hpb=8e0933137919ef7703a6e82fe17f7a258587e18c;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/docs/configuration.md b/docs/configuration.md index 3ff49fa..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 @@ -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. @@ -131,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