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 developement mode), using [yaml](http://yaml.org/) format.
7 # Homepage configuration
8 # See https://fontawesome.com/icons 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 logo: "assets/homer.png"
17 # Alternatively a fa icon can be provided:
18 # icon: "fas fa-skull-crossbones"
20 header: true # Set to false to hide the header
21 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.
23 columns: "3" # "auto" or number (must be a factor of 12: 1, 2, 3, 4, 6, 12)
24 connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example)
27 theme: default # 'default' or one of the theme available in 'src/assets/themes'.
29 # Optional custom stylesheet
30 # Will load custom CSS files. Especially useful for custom icon sets.
32 # - "assets/custom.css"
34 # Here is the exaustive list of customization parameters
35 # However all value are optional and will fallback to default if not set.
36 # if you want to change only some of the colors, feel free to remove all unused key.
39 highlight-primary: "#3367d6"
40 highlight-secondary: "#4285f4"
41 highlight-hover: "#5a95f5"
43 card-background: "#ffffff"
45 text-header: "#424242"
47 text-subtitle: "#424242"
48 card-shadow: rgba(0, 0, 0, 0.1)
50 background-image: "assets/your/light/bg.png"
52 highlight-primary: "#3367d6"
53 highlight-secondary: "#4285f4"
54 highlight-hover: "#5a95f5"
56 card-background: "#2b2b2b"
58 text-header: "#ffffff"
60 text-subtitle: "#f5f5f5"
61 card-shadow: rgba(0, 0, 0, 0.4)
63 background-image: "assets/your/dark/bg.png"
67 # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
69 title: "Optional message!"
70 content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
73 # links: [] # Allows for navbar (dark mode, layout, and search) without any links
77 url: "https://github.com/bastienwirtz/homer"
78 target: "_blank" # optional html tag target attribute
81 url: "https://github.com/bastienwirtz/homer"
84 # First level array represent a group.
85 # Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
88 icon: "fa fa-code-fork"
91 logo: "assets/tools/sample.png"
92 # Alternatively a fa icon can be provided:
93 # icon: "fab fa-jenkins"
94 subtitle: "Bookmark example"
96 url: "https://www.reddit.com/r/selfhosted/"
97 target: "_blank" # optional html tag target attribute
99 logo: "assets/tools/sample2.png"
100 subtitle: "Another application"
103 tagstyle: "is-success"
105 - name: "Other group"
106 icon: "fas fa-heartbeat"
108 - name: "Another app"
109 logo: "assets/tools/sample.png"
110 subtitle: "Another example"
112 url: "https://www.reddit.com/r/selfhosted/"
113 target: "_blank" # optionnal html a tag target attribute
116 If you choose to fetch message information from an endpoint, the output format should be:
121 "title": "Lorem ipsum 42",
122 "content": "LA LA LA Lorem ipsum dolor sit amet, ....."
126 `null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
127 Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
131 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:
134 - `is-success` (green)
135 - `is-warning` (yellow)
138 You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
142 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:
145 npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}