Skip to content

Configuration

MikroScope resolves API configuration from defaults, JSON config, environment variables, and CLI flags.

Start from:

Terminal window
cp examples/mikroscope.config.json mikroscope.config.json

Common settings:

SettingPurpose
hostBind host.
portAPI port.
dbPathSQLite database file path.
logsPathDirectory containing NDJSON logs.
apiTokenBearer token for query and admin APIs.
ingestProducersToken-to-producer mapping for ingestion.
corsAllowOriginOrigins that may call the API.

Most config values also map to MIKROSCOPE_* environment variables, such as MIKROSCOPE_PORT, MIKROSCOPE_DB_PATH, MIKROSCOPE_LOGS_PATH, and MIKROSCOPE_API_TOKEN.

The static console reads config.json:

{
"apiOrigin": "http://127.0.0.1:3000",
"apiToken": "replace-with-api-token"
}

Keep apiToken out of public deployments unless the console is behind access control.