configuration.md

description	keywords
This section describes the configuration parameters and their types for INX-POI.	IOTA Node Hornet Node POI Proof-Of-Inclusion Proof Inclusion Configuration JSON Customize Config reference

Core Configuration

INX-POI 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-poi executable.

For example:

inx-poi -c config_defaults.json

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

inx-poi -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
level	The minimum enabled logging level	string	"info"
disableCaller	Stops annotating logs with the calling function's file name and line number	boolean	true
disableStacktrace	Disables automatic stacktrace capturing	boolean	false
stacktraceLevel	The level stacktraces are captured and above	string	"panic"
encoding	The logger's encoding (options: "json", "console")	string	"console"
encodingConfig	Configuration for encodingConfig	object
outputPaths	A list of URLs, file paths or stdout/stderr to write logging output to	array	stdout
disableEvents	Prevents log messages from being raced as events	boolean	true

EncodingConfig

Name	Description	Type	Default value
timeEncoder	Sets the logger's timestamp encoding. (options: "nanos", "millis", "iso8601", "rfc3339" and "rfc3339nano")	string	"rfc3339"

Example:

  {
    "logger": {
      "level": "info",
      "disableCaller": true,
      "disableStacktrace": false,
      "stacktraceLevel": "panic",
      "encoding": "console",
      "encodingConfig": {
        "timeEncoder": "rfc3339"
      },
      "outputPaths": [
        "stdout"
      ],
      "disableEvents": true
    }
  }

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. RestAPI

Name	Description	Type	Default value
bindAddress	The bind address on which the POI HTTP server listens	string	"localhost:9687"
advertiseAddress	The address of the POI HTTP server which is advertised to the INX Server (optional)	string	""
debugRequestLoggerEnabled	Whether the debug logging for requests should be enabled	boolean	false

Example:

  {
    "restAPI": {
      "bindAddress": "localhost:9687",
      "advertiseAddress": "",
      "debugRequestLoggerEnabled": false
    }
  }

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"
    }
  }