env.example

# Kairix environment configuration
#
# Usage:
#   VM deployment:  cp env.example /opt/kairix/service.env
#                   # Edit values, then source in cron: source /opt/kairix/service.env
#
#   Local testing:  cp env.example .env
#                   # Edit values. .env is gitignored.
#
#   GitHub Actions: Set these as repository secrets in Settings → Secrets and variables → Actions
#
# Auth strategy: either set KAIRIX_KV_NAME (fetch from Key Vault via managed identity)
# OR set KAIRIX_LLM_API_KEY + KAIRIX_LLM_ENDPOINT directly. Key Vault is recommended
# for production; direct env vars are convenient for local dev and CI.

# ── Key Vault (recommended for production) ───────────────────────────────────
# Your Azure Key Vault name. Used by deploy.sh, the embed runner, and the
# benchmark LLM judge to fetch credentials at runtime.
# Both KV_NAME (scripts) and KAIRIX_KV_NAME (Python modules) are supported;
# set both to the same value.
KAIRIX_KV_NAME=your-key-vault-name
KV_NAME=your-key-vault-name

# ── LLM credentials (direct — bypasses Key Vault) ───────────────────────────
# Set these instead of (or in addition to) KAIRIX_KV_NAME.
# When set, these take precedence over Key Vault secrets.
# Useful for local dev and CI where managed identity is unavailable.
KAIRIX_LLM_API_KEY=
KAIRIX_LLM_ENDPOINT=https://your-resource.openai.azure.com
KAIRIX_LLM_MODEL=gpt-4o-mini

# Optional: separate embed provider (falls back to LLM provider if not set)
# KAIRIX_EMBED_API_KEY=
# KAIRIX_EMBED_ENDPOINT=
# KAIRIX_EMBED_MODEL=text-embedding-3-large

# ── Paths ─────────────────────────────────────────────────────────────────────
# Root of your Obsidian vault (kairix indexes this directory)
KAIRIX_VAULT_ROOT=/path/to/your/obsidian-vault

# Root of your agent workspace directories (one subdir per agent)
# Structure: $KAIRIX_WORKSPACE_ROOT/<agent>/memory/
KAIRIX_WORKSPACE_ROOT=/path/to/your/workspaces

# Top-level data directory — entities.db and logs go here by default
KAIRIX_DATA_DIR=/path/to/kairix-data

# Override individual paths if you want them somewhere other than $KAIRIX_DATA_DIR
# KAIRIX_BRIEFING_DIR=/path/to/kairix-data/briefing
# KAIRIX_SEARCH_LOG=/path/to/kairix-data/logs/search.jsonl

# Log directory used by deploy.sh and cron wrappers
LOG_DIR=/path/to/kairix-data/logs

# Path to the usearch index file
# Only needed if auto-discovery fails
# KAIRIX_USEARCH_PATH=~/.cache/kairix/vectors.usearch

# ── Optional toggles ──────────────────────────────────────────────────────────
# Set to 1 to write raw search queries to $KAIRIX_SEARCH_LOG (for analysis)
# KAIRIX_LOG_QUERIES=0

# Set to 1 to enable E2E tests against live Azure API (requires credentials above)
# KAIRIX_E2E=0

# ── Test overrides ────────────────────────────────────────────────────────────