3 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.
7 # Homepage configuration
8 # See https://fontawesome.com/v5/search for icons options
10 # Optional: Use external configuration file.
11 # Using this will ignore remaining config in this file
12 # externalConfig: https://example.com/server-luci/config.yaml
14 title: "App dashboard"
16 # documentTitle: "Welcome" # Customize the browser tab text
17 logo: "assets/logo.png"
18 # Alternatively a fa icon can be provided:
19 # icon: "fas fa-skull-crossbones"
21 header: true # Set to false to hide the header
22 # Optional: Different hotkey for search, defaults to "/"
25 footer: '<p>Created with <span class="has-text-danger">❤️</span> with <a href="https://bulma.io/">bulma</a>, <a href="https://vuejs.org/">vuejs</a> & <a href="https://fontawesome.com/">font awesome</a> // Fork me on <a href="https://github.com/bastienwirtz/homer"><i class="fab fa-github-alt"></i></a></p>' # set false if you want to hide it.
27 columns: "3" # "auto" or number (must be a factor of 12: 1, 2, 3, 4, 6, 12)
28 connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example).
29 # You should set it to true when using an authentication proxy, it also reloads the page when a redirection is detected when checking connectivity.
31 # Optional: Proxy / hosting option
33 useCredentials: false # send cookies & authorization headers when fetching service specific data. Set to `true` if you use an authentication proxy. Can be overrided on service level.
35 # Set the default layout and color scheme
37 layout: columns # Either 'columns', or 'list'
38 colorTheme: auto # One of 'auto', 'light', or 'dark'
41 theme: default # 'default' or one of the themes available in 'src/assets/themes'.
43 # Optional custom stylesheet
44 # Will load custom CSS files. Especially useful for custom icon sets.
46 # - "assets/custom.css"
48 # Here is the exhaustive list of customization parameters
49 # However all value are optional and will fallback to default if not set.
50 # if you want to change only some of the colors, feel free to remove all unused key.
53 highlight-primary: "#3367d6"
54 highlight-secondary: "#4285f4"
55 highlight-hover: "#5a95f5"
57 card-background: "#ffffff"
59 text-header: "#424242"
61 text-subtitle: "#424242"
62 card-shadow: rgba(0, 0, 0, 0.1)
65 background-image: "assets/your/light/bg.png"
67 highlight-primary: "#3367d6"
68 highlight-secondary: "#4285f4"
69 highlight-hover: "#5a95f5"
71 card-background: "#2b2b2b"
73 text-header: "#ffffff"
75 text-subtitle: "#f5f5f5"
76 card-shadow: rgba(0, 0, 0, 0.4)
79 background-image: "assets/your/dark/bg.png"
83 # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
84 # mapping: # allows to map fields from the remote format to the one expected by Homer
85 # title: 'id' # use value from field 'id' as title
86 # content: 'value' # value from field 'value' as content
87 # refreshInterval: 10000 # Optional: time interval to refresh message
89 # Real example using chucknorris.io for showing Chuck Norris facts as messages:
90 # url: https://api.chucknorris.io/jokes/random
94 # refreshInterval: 10000
96 title: "Optional message!"
97 icon: "fa fa-exclamation-triangle"
98 content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
101 # links: [] # Allows for navbar (dark mode, layout, and search) without any links
104 icon: "fab fa-github"
105 url: "https://github.com/bastienwirtz/homer"
106 target: "_blank" # optional html tag target attribute
109 url: "https://github.com/bastienwirtz/homer"
110 # 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
111 # see url field and assets/page.yml used in this example:
112 - name: "Second Page"
113 icon: "fas fa-file-alt"
117 # First level array represents a group.
118 # Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
120 - name: "Application"
121 icon: "fas fa-code-branch"
122 # A path to an image can also be provided. Note that icon take precedence if both icon and logo are set.
123 # logo: "path/to/logo"
125 - name: "Awesome app"
126 logo: "assets/tools/sample.png"
127 # Alternatively a fa icon can be provided:
128 # icon: "fab fa-jenkins"
129 subtitle: "Bookmark example"
131 keywords: "self hosted reddit" # optional keyword used for searching purpose
132 url: "https://www.reddit.com/r/selfhosted/"
133 target: "_blank" # optional html tag target attribute
134 - name: "Another one"
135 logo: "assets/tools/sample2.png"
136 subtitle: "Another application"
139 tagstyle: "is-success"
141 - name: "Other group"
142 icon: "fas fa-heartbeat"
145 logo: "assets/tools/sample.png"
146 # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
148 url: "http://192.168.0.151/admin"
149 type: "PiHole" # optional, loads a specific component that provides extra features. MUST MATCH a file name (without file extension) available in `src/components/services`
150 target: "_blank" # optional html a tag target attribute
151 # class: "green" # optional custom CSS class for card, useful with custom stylesheet
152 # background: red # optional color for card to set color directly without custom stylesheet
155 View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them.
157 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)):
162 "title": "Lorem ipsum 42",
163 "content": "LA LA LA Lorem ipsum dolor sit amet, ....."
167 `null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
168 Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
172 Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll notice in the config there is a `tagstyle` option. It can be set to any of the bulma modifiers. You'll probably want to use one of these 4 main colors:
175 - `is-success` (green)
176 - `is-warning` (yellow)
179 You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
183 In order to easily generate all required icon preset for the PWA to work, a tool like [vue-pwa-asset-generator](https://www.npmjs.com/package/vue-pwa-asset-generator) can be used:
186 npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
189 ## Supported services
191 Currently the following services are supported for showing quick infos on the card. They can be used by setting the type to one of the following values at the item.
198 ## Additional configuration
202 For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
206 First off make sure to remove an existing `subtitle` as it will take precedence if set. Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized or the planned meal for today if one is planned. You will have to set an API key in the field `apikey` which can be created in your Mealie installation.