Configuration

NODES offers configuration options which allow enabling and tuning optional features. These options are specified through its configuration file (nodes.toml) using TOML 1.0 syntax. The default value for all configuration options is included in $PREFIX/share/nodes.toml, and can be directly modified or used to create other user-defined configuration files.

Additionally, individual configuration options can be overridden through the use of the NODES_CONFIG_OVERRIDE environment variable. Multiple comma-separated options can be specified using this method.

While initializing, NODES will search for and parse a single configuration file. The discovery of such file follows the next order of preference:

  1. The file specified in the NODES_CONFIG environment variable.

  2. A file named nodes.toml present in the current directory.

  3. The default configuration file located in $PREFIX/share/nodes.toml.

After a configuration file has been loaded, individual overrides from NODES_CONFIG_OVERRIDE will be applied.

Consider the following example where we specify the ~/nodes-custom.toml file and then override a configuration variable:

NODES_CONFIG="~/nodes-custom.toml" NODES_CONFIG_OVERRIDE="ovni.enabled=true" ./application

Environment Variables

  1. NODES_CONFIG="$CUSTOM_PATH": Allows users to define the path of a specific configuration file.

  2. NODES_CONFIG_OVERRIDE="$OPTIONS": Accepts a comma-separated list of options which will override those defined in the configuration file.

  3. NODES_OVNI="1/0": (Deprecated) Enable or disable ovni instrumentation. Please use the nodes.toml configuration file instead.