Skip to main content

Configuration Variables

info

When using environment vars, the var name must be prefixed with NUMARY_. As an example, DEBUG could either be passed as numary server start --debug or NUMARY_DEBUG=true numary server start.

FlagEnv varDefault valueDescription
--auth-basic-credentialsAUTH_BASIC_CREDENTIALS[]HTTP basic auth credentials (<username>:<password>)
--auth-basic-enabledAUTH_BASIC_ENABLEDfalseEnable basic auth
--auth-bearer-audienceAUTH_BEARER_AUDIENCE[]Allowed audiences
--auth-bearer-audiences-wildcardAUTH_BEARER_AUDIENCES_WILDCARDfalseDon't check audience
--auth-bearer-enabledAUTH_BEARER_ENABLEDfalseEnable bearer auth
--auth-bearer-introspect-urlAUTH_BEARER_INTROSPECT_URLOAuth2 introspect URL
--auth-bearer-use-scopesAUTH_BEARER_USE_SCOPESfalseUse scopes as defined by rfc https://datatracker.ietf.org/doc/html/rfc8693
--commit-policyCOMMIT_POLICYTransaction commit policy (default or allow-past-timestamps)
--debugDEBUGfalseDebug mode
--lock-strategyLOCK_STRATEGYmemoryLock strategy (memory, none, redis)
--lock-strategy-redis-durationLOCK_STRATEGY_REDIS_DURATION1m0sLock duration
--lock-strategy-redis-retryLOCK_STRATEGY_REDIS_RETRY1sRetry lock period
--lock-strategy-redis-tls-enabledLOCK_STRATEGY_REDIS_TLS_ENABLEDfalseUse tls on redis
--lock-strategy-redis-tls-insecureLOCK_STRATEGY_REDIS_TLS_INSECUREfalseWhether redis is trusted or not
--lock-strategy-redis-urlLOCK_STRATEGY_REDIS_URLRedis url when using redis locking strategy
--otel-metricsOTEL_METRICSfalseEnable OpenTelemetry metrics support
--otel-metrics-exporterOTEL_METRICS_EXPORTERstdoutOpenTelemetry metrics exporter
--otel-metrics-exporter-otlp-endpointOTEL_METRICS_EXPORTER_OTLP_ENDPOINTOpenTelemetry metrics grpc endpoint
--otel-metrics-exporter-otlp-insecureOTEL_METRICS_EXPORTER_OTLP_INSECUREfalseOpenTelemetry metrics grpc insecure
--otel-metrics-exporter-otlp-modeOTEL_METRICS_EXPORTER_OTLP_MODEgrpcOpenTelemetry metrics OTLP exporter mode (grpc
--otel-tracesOTEL_TRACESfalseEnable OpenTelemetry traces support
--otel-traces-batchOTEL_TRACES_BATCHfalseUse OpenTelemetry batching
--otel-traces-exporterOTEL_TRACES_EXPORTERstdoutOpenTelemetry traces exporter
--otel-traces-exporter-jaeger-endpointOTEL_TRACES_EXPORTER_JAEGER_ENDPOINTOpenTelemetry traces Jaeger exporter endpoint
--otel-traces-exporter-jaeger-passwordOTEL_TRACES_EXPORTER_JAEGER_PASSWORDOpenTelemetry traces Jaeger exporter password
--otel-traces-exporter-jaeger-userOTEL_TRACES_EXPORTER_JAEGER_USEROpenTelemetry traces Jaeger exporter user
--otel-traces-exporter-otlp-endpointOTEL_TRACES_EXPORTER_OTLP_ENDPOINTOpenTelemetry traces grpc endpoint
--otel-traces-exporter-otlp-insecureOTEL_TRACES_EXPORTER_OTLP_INSECUREfalseOpenTelemetry traces grpc insecure
--otel-traces-exporter-otlp-modeOTEL_TRACES_EXPORTER_OTLP_MODEgrpcOpenTelemetry traces OTLP exporter mode (grpc
--publisher-http-enabledPUBLISHER_HTTP_ENABLEDfalseSent write event to http endpoint
--publisher-kafka-brokerPUBLISHER_KAFKA_BROKER[]Kafka address is kafka enabled
--publisher-kafka-enabledPUBLISHER_KAFKA_ENABLEDfalsePublish write events to kafka
--publisher-kafka-sasl-enabledPUBLISHER_KAFKA_SASL_ENABLEDfalseEnable SASL authentication on kafka publisher
--publisher-kafka-sasl-mechanismPUBLISHER_KAFKA_SASL_MECHANISMSASL authentication mechanism
--publisher-kafka-sasl-passwordPUBLISHER_KAFKA_SASL_PASSWORDSASL password
--publisher-kafka-sasl-scram-sha-sizePUBLISHER_KAFKA_SASL_SCRAM_SHA_SIZE512SASL SCRAM SHA size
--publisher-kafka-sasl-usernamePUBLISHER_KAFKA_SASL_USERNAMESASL username
--publisher-kafka-tls-enabledPUBLISHER_KAFKA_TLS_ENABLEDfalseEnable TLS to connect on kafka
--publisher-topic-mappingPUBLISHER_TOPIC_MAPPING[]Define mapping between internal event types and topics
--segment-application-idSEGMENT_APPLICATION_IDSegment application id
--segment-enabledSEGMENT_ENABLEDtrueIs segment enabled
--segment-heartbeat-intervalSEGMENT_HEARTBEAT_INTERVAL24h0m0sSegment heartbeat interval
--segment-write-keySEGMENT_WRITE_KEYlAVEcNA5tKkhkQGp2CvTBSsbGqFsbCIFSegment write key
--server.http.basic_authSERVER_HTTP_BASIC_AUTHHttp basic auth
--server.http.bind_addressSERVER_HTTP_BIND_ADDRESSlocalhost:3068API bind address
--storage.cacheSTORAGE_CACHEtrueStorage cache
--storage.dirSTORAGE_DIR/Users/clement/.numary/dataStorage directory (for sqlite)
--storage.driverSTORAGE_DRIVERsqliteStorage driver
--storage.postgres.conn_stringSTORAGE_POSTGRES_CONN_STRINGpostgresql://localhost/postgresPostgre connection string
--storage.sqlite.db_nameSTORAGE_SQLITE_DB_NAMEnumarySQLite database name
--ui.http.bind_addressUI_HTTP_BIND_ADDRESSlocalhost:3068UI bind address