X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fconfiguration.md;h=a472b416d7ed707946b8d615975d96aa64200355;hb=742ae4eb528df6803d6b575b7a60a1e68d8d7e4d;hp=8bff54f7889633b42ba6b423e350c743902d7cef;hpb=1ddf394176ffe7e1c4118ead46b9fa76c6f3c614;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/docs/configuration.md b/docs/configuration.md index 8bff54f..a472b41 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -69,7 +69,7 @@ message: # mapping: # allows to map fields from the remote format to the one expected by Homer # title: 'id' # use value from field 'id' as title # content: 'value' # value from field 'value' as content - # refreshInterval: 10000 # time interval to refresh message + # refreshInterval: 10000 # Optional: time interval to refresh message # # Real example using chucknorris.io for showing Chuck Norris facts as messages: # url: https://api.chucknorris.io/jokes/random @@ -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" @@ -129,7 +136,7 @@ services: # background: red # optional color for card to set color directly without custom stylesheet ``` -If you choose to fetch message information from an endpoint, the output format should be: +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 {