Configuration

Chronicle Server can be configured using a chronicle.json file or environment variables. Environment variables take precedence over file-based configuration, which is useful for containerized deployments.

Example configuration

{
  "managementPort": 8080,
  "port": 35000,
  "storage": {
    "type": "MongoDB",
    "connectionDetails": "mongodb://localhost:27017"
  }
}

Section	Description
Root properties	Ports and health check endpoint
Features	API, Workbench, and OAuth authority toggles
Storage	Storage provider configuration
Observers	Retry and timeout settings
Events	Event queue configuration
Authentication	External authority and default admin settings
TLS	gRPC TLS certificate configuration
Workbench TLS	Dedicated Workbench TLS and certificate configuration
Identity Provider Certificate	Dedicated certificate configuration for internal OAuth authority

Topics

• Configuration File - Structure and location of chronicle.json.
• Root Properties - Ports and health check settings.
• Features - Toggle API, Workbench, and OAuth authority.
• Storage - Configure the storage provider and connection details.
• Observers - Retry and timeout settings for observer subscriptions.
• Events - Configure event queues.
• Authentication - External authority and default admin settings.
• TLS - Configure top-level gRPC TLS certificates.
• Workbench TLS - Configure Workbench TLS and certificates.
• Identity Provider Certificate - Configure internal OAuth authority certificates.
• Environment Variables - Configure with Cratis__Chronicle__ settings.
• Open Telemetry - Export metrics, traces, and logs via OTLP.
• Docker Configuration - Configure Chronicle in Docker.
• Configuration Precedence - How sources override each other.
• Best Practices - Recommended configuration guidelines.
• Port Reference - Ports exposed by Chronicle Server.
• Job Throttling - Limit parallel job steps to control CPU usage.