Project-Basira/.env.example at main · MoTechSys/Project-Basira · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# Basira — environment reference. Every setting is optional: the defaults run fully offline
# with deterministic mock providers. Copy to `.env` (never commit it). Production notes: docs/DEPLOYMENT.md.

# ---- extraction / OCR providers (ADR-005) ------------------------------------------------------------
# The model only proposes quote positions; every proposal is re-located verbatim or dropped.
LLM_PROVIDER=mock                 # mock | openai-compatible
# LLM_BASE_URL=https://api.openai.com/v1
# LLM_API_KEY=
# LLM_MODEL=gpt-4o-mini
# LLM_PICKER_MODEL=               # English-gate picker; defaults to LLM_MODEL. Rules only when unset.
# LLM_REASONING_EFFORT=none       # reasoning models only; accepted values depend on the model
VISION_PROVIDER=mock              # mock | openai-compatible
# VISION_BASE_URL= / VISION_API_KEY= / VISION_MODEL=   (default to the LLM_* values)
# BASIRA_MODEL_CONFIG=backend/.runtime/model.json   # written once from /settings (mode 0600)

# ---- sources and matching -----------------------------------------------------------------------------
HADEETHENC_MODE=link              # link | embed — show HadeethEnc grade + link, or the full text
OHD_MODE=display                  # display | off — kill-switch for Open-Hadith-Data text display
RETRIEVAL_VECTORS=off             # dense retrieval channel (not shipped; keep off)
ANCHOR_DETECT=1                   # detect unmarked verbatim Quran runs (ARCHITECTURE §2 stage 1)
# BASIRA_INDEX_DIR=corpus/index
# BASIRA_MANIFEST=corpus/manifest.json
# BASIRA_MESSAGES_DIR=messages
BASIRA_SNAPSHOT_WRITE=1           # write the mmap boot snapshot after the first index load

# ---- HTTP service ---------------------------------------------------------------------------------------
BASIRA_MAX_TEXT_CHARS=5000
BASIRA_RATE_LIMIT_PER_MIN=30
BASIRA_EVAL_KEY=                  # requests carrying this X-Eval-Key bypass the rate limit (evaluation only)
# X-Forwarded-For is trusted for the rate-limit key only from these peers (comma-separated IPs/CIDRs).
# Set BOTH to the load balancer's address; never '*'.
BASIRA_TRUSTED_PROXIES=
FORWARDED_ALLOW_IPS=127.0.0.1
BASIRA_CORS_ORIGINS=http://localhost:5173
BASIRA_DOCS=1                     # 1 → interactive API docs at /docs
BASIRA_MCP=0                      # 1 → MCP server at /mcp (needs `pip install -e "backend[mcp]"`)
# BASIRA_STATIC_DIR=frontend/dist # built SPA served at /
BUILD_SHA=dev