Configuration Modes

A Cadenza configuration involves the following steps:

  1. Activating the desired plugins (and their associated functionality)

  2. Optionally defining named variables for reuse throughout the configuration

  3. Configuring all required settings based on the activated plugins

  4. Optionally configuring any additional settings

These steps can be accomplished using different approaches, referred to as configuration modes:

  • multi-file: Configures settings via multiple XML files stored in the Cadenza configuration directory

  • single-file: Configures settings via a single YAML configuration file

  • env: Allows settings to be configured or overridden via environment variables

Setting the Configuration Mode

By default, the multi-file and env modes are active. You can change this by setting the CADENZA_CONFIGURATION_MODE environment variable or system property.

Combining Configuration Modes

You can combine configuration modes if needed. The following combinations are supported:

multi-file, env (default)

Configuration is performed using multiple XML files located in the Cadenza configuration directory (see CADENZA_CONFIG_PATH) and can be overridden via environment variables or system properties.

multi-file

Configuration is performed exclusively using XML files in the configuration directory (see CADENZA_CONFIG_PATH). Overriding via environment variables or system properties is disabled.

single-file, env

Configuration is performed using a single unified YAML configuration file (see CADENZA_CONFIG_FILE) and can be overridden via environment variables or system properties.

single-file

Configuration is performed exclusively using a single YAML file (see CADENZA_CONFIG_FILE). Overriding via environment variables or system properties is disabled.