diff options
author | Bastien Wirtz <bastien.wirtz@gmail.com> | 2021-09-13 13:09:40 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-09-13 13:09:40 -0700 |
commit | 92d5b8d424cbd4c227c9c76931930787deec4a2f (patch) | |
tree | aa52c1955c9cf210bd95ad32e20f1b4286f7c0a7 /docs/configuration.md | |
parent | 97f0c43ccc724ec4502e55f73874a89f822f0a81 (diff) | |
parent | 55c3ea4d92b0c5628ead4475ae7359bbf2cc59c4 (diff) | |
download | homer-92d5b8d424cbd4c227c9c76931930787deec4a2f.tar.gz homer-92d5b8d424cbd4c227c9c76931930787deec4a2f.tar.zst homer-92d5b8d424cbd4c227c9c76931930787deec4a2f.zip |
Merge branch 'main' into main
Diffstat (limited to 'docs/configuration.md')
-rw-r--r-- | docs/configuration.md | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/docs/configuration.md b/docs/configuration.md index c88069e..a76ecb3 100644 --- a/docs/configuration.md +++ b/docs/configuration.md | |||
@@ -66,6 +66,17 @@ colors: | |||
66 | # Optional message | 66 | # Optional message |
67 | message: | 67 | message: |
68 | # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below. | 68 | # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below. |
69 | # mapping: # allows to map fields from the remote format to the one expected by Homer | ||
70 | # title: 'id' # use value from field 'id' as title | ||
71 | # content: 'value' # value from field 'value' as content | ||
72 | # refreshInterval: 10000 # Optional: time interval to refresh message | ||
73 | # | ||
74 | # Real example using chucknorris.io for showing Chuck Norris facts as messages: | ||
75 | # url: https://api.chucknorris.io/jokes/random | ||
76 | # mapping: | ||
77 | # title: 'id' | ||
78 | # content: 'value' | ||
79 | # refreshInterval: 10000 | ||
69 | style: "is-warning" | 80 | style: "is-warning" |
70 | title: "Optional message!" | 81 | title: "Optional message!" |
71 | icon: "fa fa-exclamation-triangle" | 82 | icon: "fa fa-exclamation-triangle" |
@@ -81,6 +92,11 @@ links: | |||
81 | - name: "link 2" | 92 | - name: "link 2" |
82 | icon: "fas fa-book" | 93 | icon: "fas fa-book" |
83 | url: "https://github.com/bastienwirtz/homer" | 94 | url: "https://github.com/bastienwirtz/homer" |
95 | # 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 | ||
96 | # see url field and assets/page.yml used in this example: | ||
97 | - name: "Second Page" | ||
98 | icon: "fas fa-file-alt" | ||
99 | url: "#page2" | ||
84 | 100 | ||
85 | # Services | 101 | # Services |
86 | # First level array represents a group. | 102 | # First level array represents a group. |
@@ -88,6 +104,8 @@ links: | |||
88 | services: | 104 | services: |
89 | - name: "Application" | 105 | - name: "Application" |
90 | icon: "fas fa-code-branch" | 106 | icon: "fas fa-code-branch" |
107 | # A path to an image can also be provided. Note that icon take precedence if both icon and logo are set. | ||
108 | # logo: "path/to/logo" | ||
91 | items: | 109 | items: |
92 | - name: "Awesome app" | 110 | - name: "Awesome app" |
93 | logo: "assets/tools/sample.png" | 111 | logo: "assets/tools/sample.png" |
@@ -118,9 +136,10 @@ services: | |||
118 | # background: red # optional color for card to set color directly without custom stylesheet | 136 | # background: red # optional color for card to set color directly without custom stylesheet |
119 | ``` | 137 | ``` |
120 | 138 | ||
139 | |||
121 | View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them. | 140 | View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them. |
122 | 141 | ||
123 | If you choose to fetch message information from an endpoint, the output format should be: | 142 | 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)): |
124 | 143 | ||
125 | ```json | 144 | ```json |
126 | { | 145 | { |