Configuration

The following shows an example of a configuration file structure.

General Configuration

The general configuration is represented by the file config.json and contains all the global settings/configurations/datapoints which are shared across all runtimes.

Runtimes Configuration

Each runtime will have it’s own folder inside runtimes, this folder can have an arbitrary name but must contain a file named runtime.json which contains the configuration/metadata for that runtime.

Plugin Instance Configuration

Each runtime contains a plugins_configs folder, which will ultimately contain all the configuration files required for the plugins. Each file can have an arbitrary name and represents a single plugin instance. This means that, the runtime may have a single plugin but contain multiple plugin instances.
Even though each plugin instance can have an arbitrary name, it still adheres to a specification.
It is important that the plugin_name property correctly matches the name of the plugin/dll in the target runtime.

Additionally, each plugin may provide it’s own configuration, this is passed to the plugin instance in the property plugin_specific_config. Head over to the the supported plugins section to see the available plugins and their configuration. For examples on how to provide the plugins configuration, check the examples section (TODO).

User Interface Configuration

It is possible to configure the user interface of the runtime. This is all done through the ui_config.json file.

• Assets: Allows to assign a group of datapoints to a specific asset.
• Dashboard: Responsible for displaying the dashboard view of the UI.
  ⚠️

  Manually changing assets is not recommended as some widgets specific configurations are not documented and are subject to change. In the future a proper UI will be provided to manage the dashboard configuration.
  
  
  

Authentication Configuration

The authentication configuration is represented by the file auth_config.json and contains all the settings related to authentication and authorization. By default, the Gateway starts with no authentication or authorization enabled.

This section is discussed in more detail in the Authentication and Authorization section.