.env.example

# OpenRouter API key
# Optional if users provide their own key via frontend input.
OPENROUTER_API_KEY=your_key_here

# Shared session auth for protected API routes
# Root .env (Docker Compose): escape each `$` as `$$`.
# frontend/.env.local (npm run dev): escape each `$` as `\$` instead.
APP_SHARED_PASSWORD_HASH=$$2b$$12$$replace_with_bcrypt_hash_suffix
APP_SESSION_SECRET=change_me_to_a_32_char_min_random_secret

# Optional: markdown directory used by scripts
MARKDOWN_DIR=documents

# Optional: output directory for run artifacts
RUNS_DIR=output

# Optional MLflow observability sink. Disabled by default; when enabled, each
# finalized run mirrors the full output/<run_id>/ directory and raw LLM call
# artifacts into one MLflow run.
MLFLOW_ENABLED=false
MLFLOW_TRACKING_URI=
# Non-admin MLflow service account credentials; never commit real values.
MLFLOW_TRACKING_USERNAME=
MLFLOW_TRACKING_PASSWORD=
MLFLOW_EXPERIMENT_NAME=URBIND
MLFLOW_ENVIRONMENT=local_<xy>
MLFLOW_ARTIFACT_PATH=run_artifacts
MLFLOW_TRACE_MODE=consolidated
MLFLOW_FAIL_ON_ERROR=false

# Optional: log verbosity (DEBUG, INFO, WARNING, ERROR)
LOG_LEVEL=INFO

# Optional: OpenRouter base URL override
OPENROUTER_BASE_URL=https://openrouter.ai/api/v1

# Comma-separated allowed CORS origins for the API.
# Must be set in production to the exact frontend URL(s) because wildcard (*)
# is not compatible with credentialed browser requests.
# Example production value:
# API_CORS_ORIGINS=https://urbind-query-mechanism.openearth.dev
# Example local dev value:
API_CORS_ORIGINS=http://127.0.0.1:3000,http://localhost:3000

# Optional config path used by API for model setup
LLM_CONFIG_PATH=llm_config.yaml

# Optional predefined city groups JSON path for API /api/v1/city-groups
CITY_GROUPS_PATH=backend/api/assets/city_groups.json

# Optional dedicated worker count for split-mode chat background jobs
API_CHAT_JOB_WORKERS=1

# Enrichment layer toggle (gap analysis + assumptions modelling)
ENRICHMENT_ENABLED=false

# Governed local Markdown source library toggle. Uses documents/source_library by default.
EXTERNAL_SOURCE_SEARCH_ENABLED=true
EXTERNAL_SOURCE_DIR=documents/source_library

# Web research toggle (requires enrichment enabled + API keys below)
WEB_RESEARCH_ENABLED=false

# Serper.dev API key for full web search (required for web research)
# Get a free key at https://serper.dev (2,500 free queries)
SERPER_API_KEY=

# Firecrawl API key for JS-rendered scraping (required for web research)
FIRECRAWL_API_KEY=

# Vector store indexing toggle (safe default false)
VECTOR_STORE_ENABLED=false

# Do not auto-refresh the vector index in deployment. Use the maintenance
# script when the backend reports a stale vector store.
VECTOR_STORE_AUTO_UPDATE_ON_RUN=false

# local_process updates inside the API process for local development when
# automatic refresh is enabled.
VECTOR_STORE_UPDATE_MODE=local_process

# Optional: disable Chroma telemetry (recommended for local/dev)
ANONYMIZED_TELEMETRY=FALSE

# Chroma persistence path and collection settings. The distance metric for this
# store is controlled by vector_store.distance_metric in llm_config.yaml.
CHROMA_PERSIST_PATH=.chroma
#CHROMA_PERSIST_PATH=.chroma_cosine
# Optional local Docker Compose host folder mounted into /data/chroma
CHROMA_HOST_PATH=.chroma
#CHROMA_HOST_PATH=.chroma_cosine
CHROMA_COLLECTION_NAME=markdown_chunks

# Optional vector-store embedding provider overrides. Defaults live in
# llm_config.yaml under vector_store.* and currently use OpenRouter explicitly.
VECTOR_STORE_EMBEDDING_BASE_URL=https://openrouter.ai/api/v1
VECTOR_STORE_EMBEDDING_API_KEY_ENV=OPENROUTER_API_KEY

# Vector-store retrieval/embedding tuning lives in llm_config.yaml under:
# vector_store.*

# Local-only overrides not present in runtime config
APP_SHARED_PASSWORD=
WRITER_ENABLED=false