settings.yaml file allows you to define application level options. For changes made to this file to take effect, you will need to regenerate the static HTML, this can be done by clicking the refresh icon in the bottom right of the page.
You can customize the title of the page if you'd like.
You can customize the start_url as required for installable apps. The default is "/".
You will need to restart the container any time you add new images, this is a limitation of the Next.js static site server.
Do not create a bind mount to the entire
If you'd like to use a background image instead of the solid theme color, you may provide a full URL to an image of your choice.
Or you may pass the path to a local image relative to e.g.
For example, inside of your Docker Compose file, mount a path to where your images are kept:
and then reference that image:
Background Opacity & Filters
You can specify filters to apply over your background image for blur, saturation and brightness as well as opacity to blend with the background color. The first three filter settings use tailwind CSS classes, see notes below regarding the options for each. You do not need to specify all options.
background: image: /images/background.png blur: sm # sm, "", md, xl... see https://tailwindcss.com/docs/backdrop-blur saturate: 50 # 0, 50, 100... see https://tailwindcss.com/docs/backdrop-saturate brightness: 50 # 0, 50, 75... see https://tailwindcss.com/docs/backdrop-brightness opacity: 50 # 0-100
Card Background Blur
You can apply a blur filter to the service & bookmark cards. Note this option is incompatible with the background blur, saturate and brightness filters.
If you'd like to use a custom favicon instead of the included one, you may provide a full URL to an image of your choice.
Or you may pass the path to a local image relative to the
/app/public directory. See Background Image for more detailed information on how to provide your own files.
You can configure a fixed them (and disable the theme switcher) by passing the
theme option, like so:
You can configured a fixed color palette (and disable the palette switcher) by passing the
color option, like so:
Supported colors are:
You can configure service and bookmarks sections to be either "column" or "row" based layouts, like so:
Assuming you have a group named
Media in your
As an example, this would produce the following layout:
Service groups and bookmark groups can be mixed in order, but should use different group names. If you do not specify any bookmark groups they will all show at the bottom of the page.
Using the same name for a service and bookmark group can cause unexpected behavior like a bookmark group being hidden
Groups will sort based on the order in the layout block. You can also mix in groups defined by docker labels, e.g.
You can hide headers for each section in the layout as well by passing
header as false, like so:
You can also add an icon to a category under the
layout setting similar to the options for service icons, e.g.
The default style for icons (e.g.
icon: mdi-XXXX) is a gradient, or you can specify that prefixed icons match your theme with a 'flat' style using the setting below.
More information about prefixed icons can be found in options for service icons.
Version 0.6.30 introduced a tabbed view to layouts which can be optionally specified in the layout. Tabs is only active if you set the
tab field on at least one layout group.
Tabs are sorted based on the order in the layout block. If a group has no tab specified (and tabs are set on other groups), services and bookmarks will be shown on all tabs.
Every tab can be accessed directly by visiting Homepage URL with
#Group (name lowercase and URI-encoded) at the end of the URL.
For example, the following would create four tabs:
You can add a fifth column (when
style: columns which is default) by adding:
By default homepage will max out at 4 columns for column style
You can disable the collapsible feature of services & bookmarks by adding:
By default the feature is enabled.
There are currently 4 options for header styles, you can see each one below.
In some proxy configurations, it may be necessary to set the documents base URL. You can do this by providing a
base value, like so:
The URL must be a full, absolute URL, or it will be ignored by the browser.
Set your desired language using:
Currently supported languages: ca, de, en, es, fr, he, hr, hu, it, nb-NO, nl, pt, ru, sv, vi, zh-CN, zh-Hant
You can also specify locales e.g. for the DateTime widget, e.g. en-AU, en-GB, etc.
Changes the behaviour of links on the homepage,
_blank to open links in a new tab,
_self to open links in the same tab, and
_top to open links in a new window.
This can also be set for individual services. Note setting this at the service level overrides any setting in settings.json, e.g.:
providers section allows you to define shared API provider options and secrets. Currently this allows you to define your weather API keys in secret and is also the location of the Longhorn URL and credentials.
You can then pass
provider instead of
apiKey in your widget configuration.
You can use the 'Quick Launch' feature to search services, perform a web search or open a URL. To use Quick Launch, just start typing while on your homepage (as long as the search widget doesn't have focus).
There are a few optional settings for the Quick Launch feature:
searchDescriptions: which lets you control whether item descriptions are included in searches. This is off by default. When enabled, results that match the item name will be placed above those that only match the description.
hideInternetSearch: disable automatically including the currently-selected web search (e.g. from the widget) as a Quick Launch option. This is false by default, enabling the feature.
hideVisitURL: disable detecting and offering an option to open URLs. This is false by default, enabling the feature.
By default the release version is displayed at the bottom of the page. To hide this, use the
hideVersion setting, like so:
By default the homepage logfile is written to the a
logs subdirectory of the
config folder. In order to customize this path, you can set the
logpath setting. A
logs folder will be created in that location where the logfile will be written.
Show Docker Stats
You can show all docker stats expanded in
or per-service (
If you have both set the per-service settings take precedence.
You can choose from the following styles for docker or k8s status, site monitor and ping:
- The default is no value, and displays the montior and ping response time in ms and the docker / k8s container status
dotshows a green dot for a successful monitor ping or healthy status.
basicshows either UP or DOWN for monitor & ping
or per-service (
If you have both set, the per-service settings take precedence.
Hide Widget Error Messages
Hide the visible API error messages either globally in
or per service widget (
If either value is set to true, the error message will be hidden.