Quarkus Dashbuilder

Dashbuilder is a tool for running client side dashboards defined in declarative languages, such as YAML. This extension aims to bring Dashbuilder bundle to your application.

Installation

If you want to use this extension, you need to add the io.quarkiverse.dashbuilder:quarkus-dashbuilder extension first to your build file.

For instance, with Maven, add the following dependency to your POM file:

<dependency>
    <groupId>io.quarkiverse.dashbuilder</groupId>
    <artifactId>quarkus-dashbuilder</artifactId>
    <version>0.32.0</version>
</dependency>

Extension Configuration Reference

Property Type Default Description

quarkus.dashbuilder.path

string

dashboards

Web context for dashbuilder

quarkus.dashbuilder.dashboards

list of strings

comma separated list of paths to dashboards files. If empty dashbuilder scans for *.dash.yaml files.

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

quarkus.dashbuilder.path

The web path where Dashbuilder dashboards will be available. By default, this value will be resolved as a path relative to ${quarkus.http.non-application-root-path}.

Environment variable: QUARKUS_DASHBUILDER_PATH

string

/dashboards

quarkus.dashbuilder.dashboards

Comma separated list of dashboards to be rendered by Dashbuilder. If not used then Dashbuilder scan all *.dash.(yaml|yml|json) files

Environment variable: QUARKUS_DASHBUILDER_DASHBOARDS

list of string

quarkus.dashbuilder.include-samples

If true samples will also be included in the final JAR

Environment variable: QUARKUS_DASHBUILDER_INCLUDE_SAMPLES

boolean

false

quarkus.dashbuilder.properties

Dashboards properties

Environment variable: QUARKUS_DASHBUILDER_PROPERTIES

Map<String,Map<String,String>>