The YAML Configuration File

The yaml file is used to configure the parameters for the installation of the Node. To view the different options available, please refer to the script below. The script output all available options with their default values and save them to a file called inmation-config.yaml. The file can then be modified as needed to configure the installation of the Node.

inmation.exe --help-cfg > inmation-config.yaml

An example of the inmation-config.yaml file is provided below. This example includes some available options with their default values. The options can be modified as needed to configure the installation of the Node.

Example inmation-config.yaml

# Enables verbose logging.
verbose: false

# Specifies OS environment variable overrides. Individual overrides must be specified as key=value pairs, separated by spaces.
environment:
  []

startup:
# The hostname or IP address set on the HostnameOrIP property of a newly created Node object during initialization. "0.0.0.0" listens on all local interfaces. An empty string defaults to computer name.
  initListenHost: ""
# The port set on the NodeListenerPort property of a newly created Node object during initialization. A zero value disables inter-Node communication.
  initListenPort: 6512
# Loads the JSON file at the specified path when the Node process is initialized for the first time.
  initJsonFile: ""
# Executes the Lua script file at the specified path during process startup.
  luaFile: ""
# Executes the Lua chunk provided as the option value during process startup.
  luaChunk: ""
# Terminate after startup operations (installation or command line script execution) instead of continuing to run the Node process.
  exit: false
# Delay Node start-up for the specified amount of seconds.
  wait: 0

system:
# The Node's data folder for storing persistent data.
  dataFolder: ""
# Disable specific system functionality or checks. Accepted values: PASSWORD_POLICIES, LUA
  disable:
    []
# Disable all access permission checks if set to 'false'.
  security: true

winsvc:
# Specifies the Node service instance name.
  instance: ""
# Execute service operations silently (to be used with '--winsvc-install' or '--winsvc-remove' options only).
  silent: false
# Adjust Windows Firewall settings during service installation automatically (with '--winsvc-install' option only).
  firewall: true
# Specifies the custom action delay (in seconds) after a service failure (default = 30).
  failureActionsDelay: 30
# Specifies if the service failure action configuration should be performed.
  failureActions: true

lmdb:
# Controls LMDB sync flags: 0 = full sync (default), 1 = MDB_NOMETASYNC (skip meta page flush), 2 = MDB_NOSYNC (skip all sync).
  syncMode: 0
# Compact the LMDB database file on startup. This reclaims space from deleted records by rewriting the file without free pages. Implies '--exit'.
  compactOnStartup: false
# Maximum number of simultaneous read-only transactions (LMDB reader slots). Corresponds to mdb_env_set_maxreaders().Can only be increased from the previous value and not decreased. Default is 1024.
  maxReaders: 1024

restore:
# The GUID of the Node being restored. The recovery connection objects should be created using startup scripts. Requires '--reset=RESTORE' to be specified.
  nodeGuid: ""
# The GUID of the passive UplinkConnection object owned by the Node being restored. The recovery connection objects should be created using startup scripts. Requires '--reset=RESTORE' to be specified.
  connectionGuid: ""

saf:
  {}

networkTest:
  {}