Skip to content

Configuration File

Chronicle Server loads configuration from a chronicle.json file in the application root directory. In containers, this file is typically mounted at /app/chronicle.json.

{
"managementPort": 8080,
"port": 35000,
"healthCheckEndpoint": "/health",
"features": {
"api": true,
"workbench": true,
"changesetStorage": false,
"oAuthAuthority": true
},
"storage": {
"type": "MongoDB",
"connectionDetails": "mongodb://localhost:27017"
},
"observers": {
"subscriberTimeout": 5,
"maxRetryAttempts": 10,
"backoffDelay": 1,
"exponentialBackoffDelayFactor": 2,
"maximumBackoffDelay": 600
},
"readModels": {
"replayedVersionsToKeep": 1
},
"events": {
"queues": 8
},
"authentication": {
"authority": null,
"defaultAdminUsername": "admin",
"defaultAdminPassword": "admin"
},
"identityProvider": {
"certificate": {
"enabled": true,
"certificatePath": "/path/to/identity-provider.pfx",
"certificatePassword": "your-password"
}
}
}

Environment variables can override any of these values. See Configuration Precedence for details.

SectionDescription
managementPort, port, healthCheckEndpointRoot properties for ports and health check path
featuresFeature toggles for API, Workbench, and OAuth authority
storageStorage provider configuration
observersRetry and timeout settings for observers
readModelsReplay retention settings for replay-generated read model versions
eventsEvent queue configuration
authenticationAuthentication and default admin settings
identityProviderOptional internal identity provider certificate settings