How to read these schemas?

Configuration files in OrangeQS Juice are stored as TOML files. Each schema page documents the available keys and value types for one *.toml file.

Each generated schema page also includes a copy-pastable default configuration block. You can copy that block into <schema>.toml and adjust values for your deployment.

The example below shows how different key patterns map to TOML syntax.

dummy.toml

An example configuration file. The header dummy.toml means that the contents of this file are stored in dummy.toml or dummy.d/<descriptive name>.toml. See How configurations are stored and loaded for more information.

Copy-paste default configuration

Use this as a starting point in dummy.toml.

option_a = "some_value"
list_c = [1, 2, 3]

[category_b]
option_b = 3

option_a

Type: string. Default: 'some_value'

An example option of type string, including a default value. The header option_a corresponds to the key of this configuration option. To configure this option in TOML, you would add the following:

option_a = "my_own_value"

category_b.option_b

Type: int

The header category_b.option_b corresponds to the key of this configuration option. This means that this option is key option_b of the table category_b, as seen below:

[category_b]
option_b = 3

list_c

Type: list[integer]

A list of integers. This means that this option should be a list under the key list_c:

list_c = [1, 2, 3]

mapping_d

Type: dict[string, string]

A dictionary that maps from strings to strings. This corresponds to the following TOML:

[mapping_d]
from = "to"
another_from = "another_to"
arbitrary = "value"

mapping_e.{key}.option_e

Type: int

A mapping from strings to a dictionary. The dictionary has a single option option_e. This corresponds to the following TOML:

[mapping_e.my_key]
option_e = 5

[mapping_e.another_key]
option_e = 3

list_f[].option_f

Type: int

A list of dictionaries. The dictionary has a single option option_f. This corresponds to the following TOML:

[[list_f]]
option_f = 2

[[list_f]]
option_f = 1

Example: Dashboard settings

The Dashboard Settings schema combines nested categories and per-page options. The following example is based on the bundled dashboard configuration.

[categories.core]
order = 10
url = "core/home"
name = "Juice"
entry_point = "orangeqs.juice.dashboard.pages.home:create_home_doc"

[categories.core.pages.system-overview]
order = 10
name = "System Overview"
description = "CPU, memory and disk usage and service resource usage."
entry_point = "orangeqs.juice.dashboard.pages.system_overview:create_system_overview_doc"

[categories.tools]
order = 30
name = "Tools"

[categories.tools.pages.jupyterlab]
order = 10
name = "JupyterLab"
url = "{jupyterlab_base_url}"
new_tab = true

Use dashboard.toml for the full list of available options and field-level descriptions.