Custom Configuration

Documentation Index

Fetch the complete documentation index at: https://docs.canton.network/llms.txt Use this file to discover all available pages before exploring further.

Custom Configuration

Key configuration parameters for Canton Network validator nodes

All the apps have an extended set of configuration options which might need tuning based on different scenarios. These configurations are accepted in the HOCON format.

Adding ad-hoc configuration

Every app accepts extra configuration through environment variables. All the environment variables passed to the apps, that start with ADDITIONAL_CONFIG will be processed and the configuration will be applied when the app starts.

Example env: ADDITIONAL\_CONFIG\_EXAMPLE="canton.example.key=value"

The full configuration for each app can be observed in the scala code, with the configuration key being kebab case compared to the camel case in the scala code:

Furthermore, the participant and other synchronizer components can be configured independently as well. Further information on such configurations can be found in the Canton docs.

Examples in the Canton docs might have different root configuration keys for the configured nodes; Splice participants/mediators/sequencers are always configured under `canton.participants.participant {`/`canton.mediators.mediator {`/`canton.sequencers.sequencer {`, respectively.

point to the release that these docs are built from; or inline the source code or Scaladoc to avoid confusion

Custom bootstrap scripts

Both Canton and splice support bootstrap scripts during initialization. While this usually should not be needed as the validator app takes care of initializing the node, in some scenarios it can be useful. To do so, you need to set the OVERRIDE_BOOTSTRAP_SCRIPT environment variable to the content of your bootstrap script. Note that the script must be wrapped in a main function, e.g.,

def main() {
  logger.info(s"Participant id from bootstrap script: ${participant.id}")
}

You can set this environment variable through additionalEnvVars as described below.

Note that this overwrites any bootstrap scripts baked into the container image. So if you added custom functionality there, you will need to replicate this in the overwrite.

Helm charts support

The helm charts can be configured through the value additionalEnvVars, which passes the values as environment variables to the apps.

additionalEnvVars:
    - name: ADDITIONAL_CONFIG_EXAMPLE
      value: canton.example.key=value

Mirrored from Canton Network official documentation (CC-BY-4.0) by CC Privacy Club for learning purposes.