X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=docs%2Fconfiguration.md;h=7df565198dcec621190e8fd9fc0789dc76aa9fee;hb=13071ae3d1457bd677665769e83535a3d1f94b14;hp=edcf1ed8592c6bade2184592c3e2483307921f60;hpb=83665e4f48e8db29d74a2e84b8befb6076c08665;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/docs/configuration.md b/docs/configuration.md index edcf1ed..7df5651 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -13,7 +13,8 @@ Title, icons, links, colors, and services can be configured in the `config.yml` title: "App dashboard" subtitle: "Homer" -logo: "assets/homer.png" +# documentTitle: "Welcome" # Customize the browser tab text +logo: "assets/logo.png" # Alternatively a fa icon can be provided: # icon: "fas fa-skull-crossbones" @@ -67,6 +68,7 @@ message: # url: "https://" # Can fetch information from an endpoint to override value below. style: "is-warning" title: "Optional message!" + icon: "fa fa-exclamation-triangle" content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit." # Optional navbar @@ -85,7 +87,7 @@ links: # Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed). services: - name: "Application" - icon: "fa fa-code-fork" + icon: "fas fa-code-branch" items: - name: "Awesome app" logo: "assets/tools/sample.png" @@ -105,12 +107,14 @@ services: - name: "Other group" icon: "fas fa-heartbeat" items: - - name: "Another app" + - name: "Pi-hole" logo: "assets/tools/sample.png" - subtitle: "Another example" + subtitle: "Network-wide Ad Blocking" tag: "other" - url: "https://www.reddit.com/r/selfhosted/" - target: "_blank" # optionnal html a tag target attribute + url: "http://192.168.0.151/admin" + type: "PiHole" # optional, loads a specific component that provides extra features. MUST MATCH a file name (without file extension) available in `src/components/services` + target: "_blank" # optional html a tag target attribute + # class: "green" # optional custom CSS class for card, useful with custom stylesheet ``` If you choose to fetch message information from an endpoint, the output format should be: