## Configuration
-Title, icons, links, colors, and services can be configured in the `config.yml` file (located in `/assets` directory once built, or in the `public/assets` directory in developement mode), using [yaml](http://yaml.org/) format.
+Title, icons, links, colors, and services can be configured in the `config.yml` file (located in `/assets` directory once built, or in the `public/assets` directory in development mode), using [yaml](http://yaml.org/) format.
```yaml
---
connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example)
# Optional theming
-theme: default # 'default' or one of the theme available in 'src/assets/themes'.
+theme: default # 'default' or one of the themes available in 'src/assets/themes'.
# Optional custom stylesheet
# Will load custom CSS files. Especially useful for custom icon sets.
# stylesheet:
# - "assets/custom.css"
-# Here is the exaustive list of customization parameters
+# Here is the exhaustive list of customization parameters
# However all value are optional and will fallback to default if not set.
# if you want to change only some of the colors, feel free to remove all unused key.
colors:
# Optional message
message:
# url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
+ # 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 # 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
+ # mapping:
+ # title: 'id'
+ # content: 'value'
+ # refreshInterval: 10000
style: "is-warning"
title: "Optional message!"
icon: "fa fa-exclamation-triangle"
- 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 represent a group.
+# First level array represents a group.
# 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: "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"
- 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" # optional, if no subtitle is defined, PiHole statistics will be shown
tag: "other"
- url: "https://www.reddit.com/r/selfhosted/"
+ 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
+ # 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
{