Skip to main content

Core Configuration

INX-Dashboard 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-dashboard executable.

For example:

inx-dashboard -c config_defaults.json

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

inx-dashboard -h --full

1. Application

NameDescriptionTypeDefault value
checkForUpdatesWhether to check for updates of the application or notbooleantrue
shutdownConfiguration for shutdownobject


NameDescriptionTypeDefault value
stopGracePeriodThe maximum time to wait for background processes to finish during shutdown before terminating the appstring"5m"
logConfiguration for logobject


NameDescriptionTypeDefault value
enabledWhether to store self-shutdown events to a log filebooleantrue
filePathThe file path to the self-shutdown logstring"shutdown.log"


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

2. Logger

NameDescriptionTypeDefault value
levelThe minimum enabled logging levelstring"info"
disableCallerStops annotating logs with the calling function's file name and line numberbooleantrue
disableStacktraceDisables automatic stacktrace capturingbooleanfalse
stacktraceLevelThe level stacktraces are captured and abovestring"panic"
encodingThe logger's encoding (options: "json", "console")string"console"
encodingConfigConfiguration for encodingConfigobject
outputPathsA list of URLs, file paths or stdout/stderr to write logging output toarraystdout
disableEventsPrevents log messages from being raced as eventsbooleantrue


NameDescriptionTypeDefault value
timeEncoderSets the logger's timestamp encoding. (options: "nanos", "millis", "iso8601", "rfc3339" and "rfc3339nano")string"rfc3339"


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

3. INX

NameDescriptionTypeDefault value
addressThe INX address to which to connect tostring"localhost:9029"
maxConnectionAttemptsThe amount of times the connection to INX will be attempted before it fails (1 attempt per second)uint30
targetNetworkNameThe network name on which the node should operate on (optional)string""


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

4. Dashboard

NameDescriptionTypeDefault value
bindAddressThe bind address on which the dashboard can be accessed fromstring"localhost:8081"
developerModeWhether to run the dashboard in dev modebooleanfalse
developerModeURLThe URL to use for dev modestring""
authConfiguration for authobject
debugRequestLoggerEnabledWhether the debug logging for requests should be enabledbooleanfalse


NameDescriptionTypeDefault value
sessionTimeoutHow long the auth session should last before expiringstring"72h"
usernameThe auth username (max 25 chars)string"admin"
passwordHashThe auth password+salt as a scrypt hashstring"0000000000000000000000000000000000000000000000000000000000000000"
passwordSaltThe auth salt used for hashing the passwordstring"0000000000000000000000000000000000000000000000000000000000000000"
identityFilePathThe path to the identity file used for JWTstring"identity.key"
identityPrivateKeyPrivate key used to sign the JWT tokens (optional)string""
rateLimitConfiguration for rateLimitobject


NameDescriptionTypeDefault value
enabledWhether the rate limiting should be enabledbooleantrue
periodThe period for rate limitingstring"1m"
maxRequestsThe maximum number of requests per periodint20
maxBurstAdditional requests allowed in the burst periodint30


"dashboard": {
"bindAddress": "localhost:8081",
"developerMode": false,
"developerModeURL": "",
"auth": {
"sessionTimeout": "72h",
"username": "admin",
"passwordHash": "0000000000000000000000000000000000000000000000000000000000000000",
"passwordSalt": "0000000000000000000000000000000000000000000000000000000000000000",
"identityFilePath": "identity.key",
"identityPrivateKey": "",
"rateLimit": {
"enabled": true,
"period": "1m",
"maxRequests": 20,
"maxBurst": 30
"debugRequestLoggerEnabled": false

5. Profiling

NameDescriptionTypeDefault value
enabledWhether the profiling plugin is enabledbooleanfalse
bindAddressThe bind address on which the profiler listens onstring"localhost:6060"


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

6. Prometheus

NameDescriptionTypeDefault value
enabledWhether the prometheus plugin is enabledbooleanfalse
bindAddressThe bind address on which the Prometheus HTTP server listens onstring"localhost:9312"
goMetricsWhether to include go metricsbooleanfalse
processMetricsWhether to include process metricsbooleanfalse
promhttpMetricsWhether to include promhttp metricsbooleanfalse


"prometheus": {
"enabled": false,
"bindAddress": "localhost:9312",
"goMetrics": false,
"processMetrics": false,
"promhttpMetrics": false
  • 1. Application
    • Shutdown
    • Log
  • 2. Logger
    • EncodingConfig
  • 3. INX
  • 4. Dashboard
    • Auth
    • RateLimit
  • 5. Profiling
  • 6. Prometheus