configuration.md

description	keywords
This section describes the configuration parameters and their types for INX-Validator.	IOTA Core Node Validator Configuration JSON Customize Config reference

Core Configuration

INX-Validator uses a JSON standard format as a config file. If you are unsure about JSON syntax, you can find more information in the official JSON specs.

You can change the path of the config file by using the -c or --config argument while executing inx-validator executable.

For example:

inx-validator -c config_defaults.json

You can always get the most up-to-date description of the config parameters by running:

inx-validator -h --full

1. Application

Name	Description	Type	Default value
checkForUpdates	Whether to check for updates of the application or not	boolean	true
shutdown	Configuration for shutdown	object

Shutdown

Name	Description	Type	Default value
stopGracePeriod	The maximum time to wait for background processes to finish during shutdown before terminating the app	string	"5m"
log	Configuration for log	object

Log

Name	Description	Type	Default value
enabled	Whether to store self-shutdown events to a log file	boolean	true
filePath	The file path to the self-shutdown log	string	"shutdown.log"

Example:

  {
    "app": {
      "checkForUpdates": true,
      "shutdown": {
        "stopGracePeriod": "5m",
        "log": {
          "enabled": true,
          "filePath": "shutdown.log"
        }
      }
    }
  }

2. Logger

Name	Description	Type	Default value
name	The optional name of the logger instance. All log messages are prefixed with that name.	string	""
level	The minimum enabled logging level	string	"info"
timeFormat	Sets the logger's timestamp format. (options: "rfc3339", "rfc3339nano", "datetime", "timeonly", and "iso8601")	string	"rfc3339"
outputPaths	A list of file paths or stdout/stderr to write logging output to	array	stdout

Example:

  {
    "logger": {
      "name": "",
      "level": "info",
      "timeFormat": "rfc3339",
      "outputPaths": [
        "stdout"
      ]
    }
  }

3. INX

Name	Description	Type	Default value
address	The INX address to which to connect to	string	"localhost:9029"
maxConnectionAttempts	The amount of times the connection to INX will be attempted before it fails (1 attempt per second)	uint	30
targetNetworkName	The network name on which the node should operate on (optional)	string	""

Example:

  {
    "inx": {
      "address": "localhost:9029",
      "maxConnectionAttempts": 30,
      "targetNetworkName": ""
    }
  }

4. Validator

Name	Description	Type	Default value
candidacyRetryInterval	The interval at which broadcast of candidacy announcement block will be retried	string	"10s"
issueCandidacyPayload	Whether the node should issue a candidacy payload	boolean	true
ignoreBootstrapped	Whether the Validator component should start issuing validator blocks before the main engine is bootstrapped	boolean	false
accountAddress	The account address of the validator account that will issue the blocks	string	""

Example:

  {
    "validator": {
      "candidacyRetryInterval": "10s",
      "issueCandidacyPayload": true,
      "ignoreBootstrapped": false,
      "accountAddress": ""
    }
  }

5. Profiling

Name	Description	Type	Default value
enabled	Whether the profiling component is enabled	boolean	false
bindAddress	The bind address on which the profiler listens on	string	"localhost:6060"

Example:

  {
    "profiling": {
      "enabled": false,
      "bindAddress": "localhost:6060"
    }
  }