Skip to main content

Crate ucotron_config

Crate ucotron_config 

Source
Expand description

§Ucotron Config

Configuration system for the Ucotron cognitive memory framework.

Provides TOML-based configuration parsing and validation for the server, storage backends, model pipelines, consolidation settings, namespaces, and auth.

§Configuration Schema

The configuration file (ucotron.toml) supports the following sections:

  • [server] — HTTP server settings (host, port, workers, log_level)
  • [storage] — Storage backend selection and settings
  • [models] — Embedding, NER, and LLM model configuration
  • [consolidation] — Background consolidation worker settings
  • [namespaces] — Multi-tenancy namespace configuration
  • [auth] — Authentication settings (API key, JWT)
  • [mcp] — MCP (Model Context Protocol) server settings
  • [telemetry] — OpenTelemetry tracing and metrics export

§Environment Variable Overrides

Every config field can be overridden via environment variables using the UCOTRON_ prefix and _ as section separator:

  • UCOTRON_SERVER_HOSTserver.host
  • UCOTRON_SERVER_PORTserver.port
  • UCOTRON_SERVER_WORKERSserver.workers
  • UCOTRON_SERVER_LOG_LEVELserver.log_level
  • UCOTRON_SERVER_LOG_FORMATserver.log_format
  • UCOTRON_STORAGE_MODEstorage.mode
  • UCOTRON_MODELS_DIRmodels.models_dir
  • UCOTRON_CONSOLIDATION_TRIGGER_INTERVALconsolidation.trigger_interval
  • UCOTRON_AUTH_API_KEYauth.api_key
  • etc.

Structs§

ApiKeyEntry
A named API key with role and optional namespace scope.
AuditConfig
Audit logging configuration.
AuthConfig
Authentication configuration.
ConnectorScheduleEntry
A single connector schedule entry in the configuration file.
ConnectorsConfig
Connector scheduling configuration.
ConsolidationConfig
Background consolidation worker configuration.
GdprConfig
GDPR compliance configuration.
GdprRetentionPolicyConfig
A single retention policy entry in configuration.
GraphBackendConfig
Graph backend settings.
HnswConfig
HNSW vector index parameters.
InstanceConfig
Multi-instance configuration.
McpConfig
MCP (Model Context Protocol) server configuration.
MindsetDetectorConfig
Mindset auto-detection configuration.
ModelsConfig
ML model configuration.
NamespacesConfig
Multi-tenancy namespace configuration.
ServerConfig
HTTP server configuration.
StorageConfig
Storage backend configuration.
TelemetryConfig
OpenTelemetry configuration.
UcotronConfig
Top-level Ucotron configuration.
VectorBackendConfig
Vector backend settings.

Enums§

AuthRole
RBAC role with ordered privilege levels.