Struct HttpServerConfig 

pub struct HttpServerConfig {

    pub host: String,
    pub port: u16,
    pub cors_allowed_origins: Vec<String>,
    pub ui_app_url: String,
    pub env: Environment,
    pub require_authentication: bool,
    pub jwt_secret: SecretString,
    pub jwt_lifetime: Duration,
    pub body_limit: usize,
    pub pipeline_registry_max_runs: usize,
    pub pipeline_registry_finished_retention_secs: u64,
    pub pipeline_registry_channel_capacity: usize,
    pub pipeline_registry_abort_writes_errored: bool,
    pub notebook_run_timeout: Duration,
    pub health_probe_llm: bool,
    pub health_probe_timeout_ms: u64,
    pub health_cache_ttl_ms: u64,
    pub data_root_directory: PathBuf,
    pub system_root_directory: PathBuf,
    pub relational_db_url: String,
    pub graph_provider: String,
    pub graph_file_path: PathBuf,
    pub vector_provider: String,
    pub vector_db_url: String,
    pub embedding_provider: String,
    pub embedding_dimensions: u32,
    pub embedding_model_name: String,
    pub embedding_model_path: Option<PathBuf>,
    pub embedding_tokenizer_path: Option<PathBuf>,
    pub embedding_endpoint: String,
    pub embedding_api_key: SecretString,
    pub llm_provider: String,
    pub llm_model: String,
    pub llm_api_key: SecretString,
    pub llm_endpoint: String,
    pub llm_max_retries: u32,
    pub session_store_backend: String,
    pub session_root_directory: PathBuf,
    pub notebook_runner_enabled: bool,
    pub responses_client_enabled: bool,
    pub disable_default_backends: bool,
    pub default_user_email: String,
}

All tuneable server parameters.

Defaults mirror the Python FastAPI server defaults.

Fields

host: String

Bind address. Env: HTTP_API_HOST. Default: "0.0.0.0".

port: u16

Bind port. Env: HTTP_API_PORT. Default: 8000.

cors_allowed_origins: Vec<String>

Explicit CORS allowed origins. Env: CORS_ALLOWED_ORIGINS (comma-sep). Falls back to [ui_app_url] when empty.

ui_app_url: String

Frontend URL used as the CORS fallback. Env: UI_APP_URL. Default: "http://localhost:3000".

env: Environment

Deployment environment. Env: ENV. Default: Prod.

require_authentication: bool

Enforce authentication on every request.

OSS default: false — the slim auth/extractor.rs falls back to default_user_from_state (the uuid5(NAMESPACE_OID, email) default user) when no AuthResolver is wired and the request carries no credential. Closed cloud builds inject an AuthResolver via RouterBuilder::with_auth_resolver(...) and set this to true to require credentials.

Override at runtime with REQUIRE_AUTHENTICATION=true.

jwt_secret: SecretString

JWT signing secret. Env: AUTH_JWT_SECRET. Randomly generated at boot when unset (tokens are invalidated on restart).

jwt_lifetime: Duration

JWT validity window. Env: AUTH_JWT_LIFETIME_SECONDS. Default: 3600 s.

body_limit: usize

Maximum request body size in bytes. Env: HTTP_BODY_LIMIT_BYTES. Default: 100 MiB.

pipeline_registry_max_runs: usize

Max in-memory runs. Env: PIPELINE_REGISTRY_MAX_RUNS. Default: 4096.

pipeline_registry_finished_retention_secs: u64

Finished-run retention in seconds. Env: PIPELINE_REGISTRY_FINISHED_RETENTION_SECS. Default: 3600.

pipeline_registry_channel_capacity: usize

Per-run broadcast channel capacity. Env: PIPELINE_REGISTRY_CHANNEL_CAPACITY. Default: 64.

pipeline_registry_abort_writes_errored: bool

Whether to write ERRORED rows on abort/shutdown. Env: PIPELINE_REGISTRY_ABORT_WRITES_ERRORED. Default: true. Set to false for strict Python parity (Python leaves rows as STARTED on unclean shutdown). See pipelines.md §12.

notebook_run_timeout: Duration

Wall-clock timeout for POST /api/v1/notebooks/{id}/{cell}/run. Env: NOTEBOOK_RUN_TIMEOUT_SECS. Default: 30 s.

health_probe_llm: bool

Whether the /health/detailed probe should test the LLM provider and the embedding engine. Env: COGNEE_HEALTH_PROBE_LLM. Default: false.

LLM probes consume tokens; embedding probes can hit a remote provider, so both are opt-in. When false, the corresponding entries are omitted from the report (mirrors Python’s opt-in behavior).

health_probe_timeout_ms: u64

Per-probe timeout in milliseconds. Each component probe is wrapped in tokio::time::timeout(..) with this value; expiry yields an Unhealthy (critical) or Degraded (non-critical) entry. Env: COGNEE_HEALTH_PROBE_TIMEOUT_MS. Default: 2000.

health_cache_ttl_ms: u64

In-process cache TTL for the aggregated HealthCheckReport. Back-to-back /health requests within this window are served from cache to avoid hammering all backends from k8s liveness probes. Env: COGNEE_HEALTH_CACHE_TTL_MS. Default: 5000. Set to 0 to disable caching.

data_root_directory: PathBuf

Root directory for ingested data files (LocalStorage). Env: DATA_ROOT_DIRECTORY.

system_root_directory: PathBuf

Root directory for system state (graph/vector/sqlite files). Env: SYSTEM_ROOT_DIRECTORY.

relational_db_url: String

Relational DB URL. Env: RELATIONAL_DB_URL (fallback DATABASE_URL).

graph_provider: String

Graph provider name. Env: GRAPH_DATABASE_PROVIDER. Default: ladybug.

graph_file_path: PathBuf

Graph file path (for embedded ladybug graph DB). Env: GRAPH_FILE_PATH.

vector_provider: String

Vector provider name. Env: VECTOR_DB_PROVIDER. Default: pgvector. Note: the qdrant adapter has been extracted to the closed cognee-vector-qdrant crate as part of the OSS/closed split. The OSS http-server now defaults to pgvector and supports mock only when built with the dev-mock cargo feature.

vector_db_url: String

Vector DB URL/path. Env: VECTOR_DB_URL. For pgvector this is a Postgres connection string.

embedding_provider: String

Embedding provider name. Env: EMBEDDING_PROVIDER.

embedding_dimensions: u32

Embedding vector dimensions. Env: EMBEDDING_DIMENSIONS.

embedding_model_name: String

Embedding model identifier. Env: EMBEDDING_MODEL_NAME (fallback EMBEDDING_MODEL).

embedding_model_path: Option<PathBuf>

Embedding model file path (ONNX). Env: EMBEDDING_MODEL_PATH.

embedding_tokenizer_path: Option<PathBuf>

Embedding tokenizer file path (ONNX). Env: EMBEDDING_TOKENIZER_PATH.

embedding_endpoint: String

Embedding endpoint for remote providers. Env: EMBEDDING_ENDPOINT.

embedding_api_key: SecretString

Embedding API key. Env: EMBEDDING_API_KEY (fallbacks: LLM_API_KEY, OPENAI_TOKEN).

llm_provider: String

LLM provider name. Env: LLM_PROVIDER.

llm_model: String

LLM model name. Env: LLM_MODEL (fallback OPENAI_MODEL).

llm_api_key: SecretString

LLM API key. Env: LLM_API_KEY (fallback OPENAI_TOKEN).

llm_endpoint: String

LLM endpoint. Env: LLM_ENDPOINT (fallback OPENAI_URL).

llm_max_retries: u32

LLM retry count for both structured-output and network retries. Env: LLM_MAX_RETRIES.

session_store_backend: String

Session store backend selector. Env: COGNEE_SESSION_STORE.

session_root_directory: PathBuf

Session root directory (for fs-based stores). Env: COGNEE_SESSION_DIR.

notebook_runner_enabled: bool

Whether notebook code execution backend is enabled. Env: COGNEE_NOTEBOOK_RUNNER_ENABLED.

responses_client_enabled: bool

Whether Responses API client should be wired. Env: COGNEE_RESPONSES_CLIENT_ENABLED.

disable_default_backends: bool

Disable standalone default backend wiring in main. Env: COGNEE_DISABLE_DEFAULT_BACKENDS.

default_user_email: String

Email address used to derive the synthetic default user when require_authentication=false and no AuthResolver is wired.

The resulting owner id is Uuid::new_v5(&Uuid::NAMESPACE_OID, default_user_email.as_bytes()) — the same derivation used by [cognee_lib::api::user::get_or_create_default_user] and the Python reference SDK (uuid5(NAMESPACE_OID, email)).

Mirrors Settings::default_user_email in cognee-lib so the HTTP server and the bindings/CLI agree on owner ids for the same configured email. Env: DEFAULT_USER_EMAIL. Default: "default_user@example.com".

Implementations

impl HttpServerConfig

pub fn from_env() -> Result<Self, ServerError>

Build config by overlaying environment variables on top of the defaults.

Called only by the standalone binary entry point; library embedders construct HttpServerConfig directly.

impl HttpServerConfig

pub fn to_registry_config(&self) -> RegistryConfig

Build a RegistryConfig from the matching HttpServerConfig fields.

Trait Implementations

impl Clone for HttpServerConfig

fn clone(&self) -> HttpServerConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HttpServerConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HttpServerConfig

fn default() -> Self

Returns the “default value” for a type.