Environment Variables

The following table lists all primary configuration options available for UDMG. Each option can be set either as an HCL argument in the configuration file or overridden by an environment variable at runtime.

While environment variables take precedence over HCL arguments when both are provided, it is generally recommended to configure settings using HCL files to maintain clarity, consistency, and ease of management. Overriding with environment variables should be used sparingly, typically for temporary adjustments or in containerized deployment scenarios.

Environment Variable Name	HCL Argument Name
`UDMG_INSTANCE_NAME`	`instanceName`
`UDMG_DASHBOARD_ENABLE`	`dashboard`
`UDMG_DATABASE_AUTO_MIGRATE`	`autoMigrate`
`UDMG_DASHBOARD_PATH`	`dashboard_path`
`UDMG_WORKDIR_PATH`	`workDirectoryPath`
`UDMG_PERMISSIONS`	`permissions`
`UDMG_LOG_LEVEL`	`log.level`
`UDMG_LOG_FORMAT`	`log.format`
`UDMG_LOG_PATH`	`log.file`
`UDMG_LOG_ROTATE`	`log.rotate.enable`
`UDMG_LOG_ROTATE_FREQUENCY`	`log.rotate.frequency`
`UDMG_LOG_ROTATE_SIZE`	`log.rotate.size`
`UDMG_LOG_ROTATE_FORMAT`	`log.rotate.file_format`
`UDMG_SIGNING_KEY`	`jwt.signingKey`
`UDMG_JWT_ACCESS_DURATION`	`jwt.access_token.duration`
`UDMG_JWT_REFRESH_DURATION`	`jwt.refreshToken.duration`
`UDMG_API_LISTEN_ADDR`	`api.inet`
`UDMG_API_LISTEN_PORT`	`api.port`
`UDMG_API_SPEC_ENABLE`	`api.spec`
`UDMG_API_CSRF_ENABLE`	`api.csrf`
`UDMG_API_CORS_ENABLE`	`api.cors`
`UDMG_API_CORS_DOMAIN`	`api.corsDomain`
`UDMG_API_CORS_DOMAIN`	`api.verbose`
`UDMG_API_SECURE`	`api.secure.enable`
`UDMG_API_PUB_KEY_PATH`	`api.secure.pubKey`
`UDMG_API_PRIV_PATH`	`api.secure.privKey`
`UDMG_TRANSFER_RETRY_DELAY`	`transfer.retryDelay`
`UDMG_TRANSFER_MAX_RETRY_DELAY`	`transfer.maxRetryDelay`
`UDMG_TRANSFER_RETRY_BACKOFF`	`transfer.retryBackoff`
`UDMG_TRANSFER_MAX_RETRIES`	`transfer.maxRetries`
`UDMG_TRANSFER_CHECK_INTERVAL`	`transfer.checkInterval`
`UDMG_OBSERVABILITY_API_LISTEN_ADDR`	`observability.api.inet`
`UDMG_OBSERVABILITY_API_LISTEN_PORT`	`observability.api.port`
`UDMG_OBSERVABILITY_API_SPEC`	`observability.api.spec`
`UDMG_OBSERVABILITY_API_ENABLE`	`observability.api.enable`
`UDMG_OBSERVABILITY_DEBUG_ENABLE`	`observability.api.debug.enable`
`UDMG_OBSERVABILITY_DEBUG_USER`	`observability.api.debug.user`
`UDMG_OBSERVABILITY_DEBUG_PASSWORD`	`observability.api.debug.password`
`UDMG_PROMETHEUS_ENABLE`	`observability.prometheus.enable`
`UDMG_OPENTELEMETRY_ENABLE`	`observability.opentelemetry.enable`
`UDMG_OPENTELEMETRY_HOST`	`observability.opentelemetry.host`
`UDMG_OPENTELEMETRY_PORT`	`observability.opentelemetry.port`
`UDMG_DATABASE_ENGINE`	`database.engine`
`UDMG_DATABASE_NAME`	`database.instance`
`UDMG_DATABASE_HOSTNAME`	`database.hostname`
`UDMG_DATABASE_PORT`	`database.port`
`UDMG_DATABASE_USER`	`database.user`
`UDMG_DATABASE_PASSWORD`	`database.password`
`UDMG_DATABASE_MAX_CONNECTIONS`	`database.options.maxConnections`
`UDMG_DATABASE_IDLE_CONNECTIONS`	`database.options.idleConnections`
`UDMG_DATABASE_MAX_RETRIES`	`database.options.maxRetries`
`UDMG_DATABASE_INITIAL_INTERVAL`	`database.options.initialInterval`
`UDMG_DATABASE_MAX_INTERVAL`	`database.options.maxInterval`
`UDMG_DATABASE_SECURE_ENABLE`	`database.secure.enable`
`UDMG_DATABASE_SECURE_MODE`	`database.secure.mode`
`UDMG_DATABASE_PUB_KEY`	`database.secure.pubKey`
`UDMG_DATABASE_PRIV_PATH`	`database.secure.privKey`
`UDMG_SECURITY_PASSWORD_POLICY_MIN_LEN`	`security.password.minLength`
`UDMG_SECURITY_PASSWORD_POLICY_MIN_UPPER`	`security.password.minUpperCase`
`UDMG_SECURITY_PASSWORD_POLICY_MIN_LOWER`	`security.password.minLowerCase`
`UDMG_SECURITY_PASSWORD_POLICY_MIN_NUMBERS`	`security.password.minNumbers`
`UDMG_SECURITY_PASSWORD_POLICY_MIN_SYMBOLS`	`security.password.minSymbols`
`UDMG_LDAP_ACCOUNT_SYNC_INTERVAL`	`ldap.ldapAccountSyncInterval`
`UDMG_LDAP_USER_SYNC_INTERVAL`	`ldap.ldapUserSyncInterval`
`UDMG_ICAP_ENABLE`	`icap.enable`
`UDMG_ICAP_DELETE_INFECTED_FILES`	`icap.deleteFiles`
`UDMG_ICAP_HOSTNAME`	`icap.hostname`
`UDMG_ICAP_PORT`	`icap.port`
`UDMG_ICAP_SERVICE`	`icap.service`
`UDMG_ICAP_TIMEOUT`	`icap.timeout`
`UDMG_ICAP_PREVIEW_SIZE`	`icap.previewSize`
`UDMG_ICAP_RETRY`	`icap.retry`
`UDMG_ICAP_SECURE`	`icap.secure`
	`icap.vendor.name`
	`icap.vendor.headers`
`UDMG_UAC_REST_ENABLE`	`uac.enable`
`UDMG_UAC_REST_URLS`	`uac.urls`
`UDMG_UAC_REST_USERNAME`	`uac.username`
`UDMG_UAC_REST_PASSWORD`	`uac.password`
`UDMG_UAC_REST_EVENT_NAME`	`uac.eventName`
`UDMG_UAC_REST_EVENT_TTL`	`uac.eventTTL`
`UDMG_PROTOCOL_SESSION_TIMEOUT`	`protocol.sessionIdleTimeout`
`UDMG_CLUSTER_MODE`	`cluster.mode`
`UDMG_CLUSTER_HEARTBEAT`	`cluster.heartbeat`
`UDMG_CLUSTER_DEADLINE`	`cluster.deadline`
`UDMG_CLUSTER_CLIENT_PORT`	`cluster.client_port`
`UDMG_CLUSTER_CLUSTER_PORT`	`cluster.cluster_port`