Homer dashboard configuration

Home dashboard configuration file. Documentation: https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md

Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/homer-dashboard-configuration/latest.json
Source https://raw.githubusercontent.com/bastienwirtz/homer/main/.schema/config-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md

Properties

externalConfig string

Use external configuration file. Using this will ignore remaining config in this file externalConfig: https://example.com/server-luci/config.yaml

title string

Title of the dashboard

subtitle string

Subtitle of the dashboard

documentTitle string

Title of the document. When not filled, title (and subtitle will be used)

icon string

Dashboard icon

header boolean

Show header, default is true

hotkey object
1 nested properties
search string required

hotkey for search, e.g. Shift

columns string

'auto' or number (must be a factor of 12: 1, 2, 3, 4, 6, 12)

format=integer
connectivityCheck boolean

whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example). You should set it to true when using an authentication proxy, it also reloads the page when a redirection is detected when checking connectivity.

proxy object
2 nested properties
useCredentials boolean

send cookies & authorization headers when fetching service specific data. Set to true if you use an authentication proxy. Can be overrided on service level.

headers object
defaults object
2 nested properties
layout enum

Layout of the dashboard, either 'columns' or 'list'

Values: "columns" "list"
colorTheme enum

One of 'auto', 'light', or 'dark'

Values: "auto" "light" "dark"
theme string

'default' or one of the themes available in 'src/assets/themes'

stylesheet string[]

Will load custom CSS files. Especially useful for custom icon sets. Entries are paths to the stylesheets

colors object
2 nested properties
light object
13 nested properties
highlight-primary string
highlight-secondary string
highlight-hover string
background string
card-background string
text string
text-header string
text-title string
text-subtitle string
card-shadow string
link string
link-hover string
background-image string
dark object
13 nested properties
highlight-primary string
highlight-secondary string
highlight-hover string
background string
card-background string
text string
text-header string
text-title string
text-subtitle string
card-shadow string
link string
link-hover string
background-image string
message object
7 nested properties
url string
format=uri
mapping object
refreshInterval integer

The refresh interval in milliseconds for reloading the message url

style string

See https://bulma.io/documentation/components/message/#colors for styling options

title string

Title of the message box

icon string

Fontawesome icon for the message box

content string

HTML content for the message box

services Service[]

Services

Definitions

Colors object
light object
13 nested properties
highlight-primary string
highlight-secondary string
highlight-hover string
background string
card-background string
text string
text-header string
text-title string
text-subtitle string
card-shadow string
link string
link-hover string
background-image string
dark object
13 nested properties
highlight-primary string
highlight-secondary string
highlight-hover string
background string
card-background string
text string
text-header string
text-title string
text-subtitle string
card-shadow string
link string
link-hover string
background-image string
ColorSet object
highlight-primary string
highlight-secondary string
highlight-hover string
background string
card-background string
text string
text-header string
text-title string
text-subtitle string
card-shadow string
link string
link-hover string
background-image string
Defaults object
layout enum

Layout of the dashboard, either 'columns' or 'list'

Values: "columns" "list"
colorTheme enum

One of 'auto', 'light', or 'dark'

Values: "auto" "light" "dark"
Hotkey object
search string required

hotkey for search, e.g. Shift

Message object
url string
format=uri
mapping object
refreshInterval integer

The refresh interval in milliseconds for reloading the message url

style string

See https://bulma.io/documentation/components/message/#colors for styling options

title string

Title of the message box

icon string

Fontawesome icon for the message box

content string

HTML content for the message box

Mapping object
Proxy object
useCredentials boolean

send cookies & authorization headers when fetching service specific data. Set to true if you use an authentication proxy. Can be overrided on service level.

headers object
Headers object
Service object
items Item[] required
name string

Service name

icon string

Fontawesome icon for the service

logo string

A path to an image can also be provided. Note that icon take precedence if both icon and logo are set.

class string

Optional css class to add on the service group. Example 'highlight-purple'

Item object
name string
logo string

Path to a logo. Alternatively a fa icon can be provided

icon string

Fontawesome icon for the item, alternative for logo

subtitle string
tag string

Show tag

keywords string

Optional keyword used for searching purpose

url string

Url of this item

target string

html tag target attribute like _blank for a new page

tagstyle string

Styleclass for the tag

type string

Optional, loads a specific component that provides extra features. MUST MATCH a file name (without file extension) available in src/components/services