#EDIT YML FILE CODE#

The 2 (or 4-digit) ISO 639-1 code for your language, e.g. ⬆️ Back to Top appConfig (optional) # Field

#EDIT YML FILE FULL#

The path (local or remote) to the config file to use.įor files located within /public, you only need to specify filename, for externally hosted files you must include the full URL Can be either newtab, sametab, top or parent. The opening method (external links only). ⬆️ Back to Top pageInfo.navLinks (optional) # Field It's recommended to scale your image down, so that it doesn't impact load times This can be either local, where / is the root of. The path to an image to display in the header (to the right of the title).

This can also include HTML and inline CSS Text to display in the footer (note that this will override the default footer content).

Optional list of a maximum of 6 links, which will be displayed in the navigation bar. Your dashboard title, displayed in the header and browser tabĭescription of your dashboard, also displayed as a subtitle See sectionĪn array additional config files, used for multi-page dashboards. See appConfigĪn array of sections, each containing an array of items, which will be displayed as links. Settings related to how the app functions, including API keys and global styles.

show/hideForKeycloakUsers - Set user controlsīasic meta data like title, description, nav bar links, footer text.

users - List or users (for simple auth).

hideComponents - Show/ hide page components.

webSearch - Configure web search engine options.

pages - List of additional config files, for multi-page dashboards.

navLinks - Links to display in the navigation bar.

pageInfo - Header text, footer, title, navigation, etc.

The following file provides a reference of all supported configuration options.

All fields are optional, unless otherwise stated.

Once you have finished configuring your dashboard, you can choose to disable UI config if you wish.

You can make use of YAML features, like anchors, comments, multi-line strings, etc to reuse attributes and keep your config file readable.

#EDIT YML FILE DOWNLOAD#

You can download it under Config menu, or use the Cloud Backup feature. It is recommended to keep a backup of your config file.After modifying your config, the app needs to be recompiled, by running yarn build - this happens automatically if you're using Docker.You can check that your config file fits the schema, by running yarn validate-config.

You may find it helpful to look at some sample config files to get you started, a collection of which can be found here.

Programmatically edit config either through the command line, using a script or a third-party application.

Changes are previewed live, and then saved to disk

From the UI, enter the Interactive Edit Mode, then click any part of the page to edit.

UI Visual Editor (3/5 reliability, 5/5 usability).

From the UI, under the config menu there is a JSON editor, with built-in validation, documentation and advanced options.

UI JSON Editor (4/5 reliability, 4/5 usability).

This can be done in your favorite editor and uploading to your server, or directly editing the file via SSH, but the easiest method would be to use Code Server

Write changes directly to the conf.yml file, optionally using one of the templates provided.

Directly in the YAML file (5/5 reliability, 3/5 usability).

There are three ways to edit the config # From the UI you can also export, backup, reset, validate and download your configuration file. Changes can either be made directly to this file, or done through the UI. If you're using Docker, this file can be passed in as a volume. All app configuration is specified in /public/conf.yml which is in YAML Format format.