Configuration Reference

This document contains the complete configuration reference for Kodit. All configuration is done through environment variables.

AppContext

Global context for the kodit project. Provides a shared state for the app.

Environment Variable	Type	Default	Description
`DATA_DIR`	Path	`~/.kodit`
`DB_URL`	str	`<lambda>()`
`LOG_LEVEL`	str	`INFO`
`LOG_FORMAT`	LogFormat	`LogFormat.PRETTY`
`DISABLE_TELEMETRY`	bool	`False`
`EMBEDDING_ENDPOINT`	`Endpoint	None`	`None`
`EMBEDDING_ENDPOINT_BASE_URL`	`str	None`	`None`
`EMBEDDING_ENDPOINT_MODEL`	`str	None`	`None`
`EMBEDDING_ENDPOINT_API_KEY`	`str	None`	`None`
`EMBEDDING_ENDPOINT_NUM_PARALLEL_TASKS`	int	`10`	Number of parallel tasks to use for the endpoint
`EMBEDDING_ENDPOINT_SOCKET_PATH`	`str	None`	`None`
`EMBEDDING_ENDPOINT_TIMEOUT`	float	`60`	Request timeout in seconds
`EMBEDDING_ENDPOINT_MAX_RETRIES`	int	`5`	Maximum number of retries for the endpoint
`EMBEDDING_ENDPOINT_INITIAL_DELAY`	float	`2.0`	Initial delay in seconds for the endpoint
`EMBEDDING_ENDPOINT_BACKOFF_FACTOR`	float	`2.0`	Backoff factor for the endpoint
`EMBEDDING_ENDPOINT_EXTRA_PARAMS`	`dict	None`	`None`
`EMBEDDING_ENDPOINT_MAX_TOKENS`	int	`8000`	Conservative token limit for the embedding model
`ENRICHMENT_ENDPOINT`	`Endpoint	None`	`None`
`ENRICHMENT_ENDPOINT_BASE_URL`	`str	None`	`None`
`ENRICHMENT_ENDPOINT_MODEL`	`str	None`	`None`
`ENRICHMENT_ENDPOINT_API_KEY`	`str	None`	`None`
`ENRICHMENT_ENDPOINT_NUM_PARALLEL_TASKS`	int	`10`	Number of parallel tasks to use for the endpoint
`ENRICHMENT_ENDPOINT_SOCKET_PATH`	`str	None`	`None`
`ENRICHMENT_ENDPOINT_TIMEOUT`	float	`60`	Request timeout in seconds
`ENRICHMENT_ENDPOINT_MAX_RETRIES`	int	`5`	Maximum number of retries for the endpoint
`ENRICHMENT_ENDPOINT_INITIAL_DELAY`	float	`2.0`	Initial delay in seconds for the endpoint
`ENRICHMENT_ENDPOINT_BACKOFF_FACTOR`	float	`2.0`	Backoff factor for the endpoint
`ENRICHMENT_ENDPOINT_EXTRA_PARAMS`	`dict	None`	`None`
`ENRICHMENT_ENDPOINT_MAX_TOKENS`	int	`8000`	Conservative token limit for the embedding model
`DEFAULT_SEARCH`	Search	`provider='sqlite'`
`DEFAULT_SEARCH_PROVIDER`	Literal	`sqlite`
`PERIODIC_SYNC`	PeriodicSyncConfig	`enabled=True interval_seconds=1800 retry_attempts=3`	Periodic sync configuration
`PERIODIC_SYNC_ENABLED`	bool	`True`	Enable periodic sync
`PERIODIC_SYNC_INTERVAL_SECONDS`	float	`1800`	Interval between periodic syncs in seconds
`PERIODIC_SYNC_RETRY_ATTEMPTS`	int	`3`	Number of retry attempts for failed syncs
`API_KEYS`	list	`[]`	Comma-separated list of valid API keys (e.g. ‘key1,key2’)
`REMOTE`	RemoteConfig	`server_url=None api_key=None timeout=30.0 max_retries=3 verify_ssl=True`	Remote server configuration
`REMOTE_SERVER_URL`	`str	None`	`None`
`REMOTE_API_KEY`	`str	None`	`None`
`REMOTE_TIMEOUT`	float	`30.0`	Request timeout in seconds
`REMOTE_MAX_RETRIES`	int	`3`	Maximum retry attempts
`REMOTE_VERIFY_SSL`	bool	`True`	Verify SSL certificates
`REPORTING`	ReportingConfig	`log_time_interval=datetime.timedelta(seconds=5)`	Reporting configuration
`REPORTING_LOG_TIME_INTERVAL`	timedelta	`0:00:05`	Time interval to log progress in seconds

Applying Configuration

There are two ways to apply configuration to Kodit:

A local .env file (e.g. kodit --env-file .env serve)
Environment variables (e.g. DATA_DIR=/path/to/kodit/data kodit serve)

How you specify environment variables is dependent on your deployment mechanism.

Docker Compose

For example, in docker compose you can use the environment key:

services:
  kodit:
    environment:
      - DATA_DIR=/path/to/kodit/data

Kubernetes

For example, in Kubernetes you can use the env key:

env:
  - name: DATA_DIR
    value: /path/to/kodit/data

Example Configurations

Enrichment Endpoints

Enrichment is typically the slowest part of the indexing process because it requires calling a remote LLM provider. Ideally you want to maximise the number of parallel tasks but all services have rate limits. Start low and increase over time.

See the configuration reference for full details. The following is a selection of examples.

Helix.ml Enrichment Endpoint

Get your free API key from Helix.ml.

ENRICHMENT_ENDPOINT_BASE_URL=https://app.helix.ml/v1
ENRICHMENT_ENDPOINT_MODEL=hosted_vllm/Qwen/Qwen3-8B
ENRICHMENT_ENDPOINT_NUM_PARALLEL_TASKS=1
ENRICHMENT_ENDPOINT_TIMEOUT=300
ENRICHMENT_ENDPOINT_API_KEY=hl-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Local Ollama Enrichment Endpoint

ENRICHMENT_ENDPOINT_BASE_URL=http://localhost:11434
ENRICHMENT_ENDPOINT_MODEL=ollama_chat/qwen3:1.7b
ENRICHMENT_ENDPOINT_NUM_PARALLEL_TASKS=1
ENRICHMENT_ENDPOINT_EXTRA_PARAMS='{"think": false}'
ENRICHMENT_ENDPOINT_TIMEOUT=300

Azure OpenAI Enrichment Endpoint

ENRICHMENT_ENDPOINT_BASE_URL=https://winderai-openai-test.openai.azure.com/
ENRICHMENT_ENDPOINT_MODEL=azure/gpt-4.1-nano # Must be in the format "azure/azure_deployment_name"
ENRICHMENT_ENDPOINT_API_KEY=XXXX
ENRICHMENT_ENDPOINT_NUM_PARALLEL_TASKS=5 # Azure defaults to 100K TPM
ENRICHMENT_ENDPOINT_EXTRA_PARAMS={"api_version": "2024-12-01-preview"}

Deployment Server API Reference