@@ -21,9 +21,10 @@ ENGRAPHIS_SERVICE_MODE=customer
2121# Behind Traefik, use its LAN hostname instead:
2222# ENGRAPHIS_DASHBOARD_URL=http://engraphis.local
2323
24- # Update reminder. When on (default), the server checks for a newer Engraphis release
25- # once a day and surfaces it in the dashboard banner, the startup log, and over MCP.
26- # The check is fail-silent and cached; set to 0 to disable all update network activity.
24+ # Update reminder. It is OFF by default, so a local installation makes no update-related
25+ # network request. Set this to 1 to check for a newer Engraphis release once a day and
26+ # surface it in the dashboard banner, startup log, and over MCP. The check is cached
27+ # and fail-silent.
2728# ENGRAPHIS_UPDATE_CHECK=1
2829# Override the release source. Default: the GitHub releases/latest API for the project
2930# repo. Accepts any HTTPS endpoint returning a GitHub-release, PyPI, or
@@ -32,6 +33,11 @@ ENGRAPHIS_SERVICE_MODE=customer
3233# Point the default GitHub source at a different owner/repo (ignored when
3334# ENGRAPHIS_UPDATE_URL is set). Default: Coding-Dev-Tools/engraphis.
3435# ENGRAPHIS_UPDATE_REPO=Coding-Dev-Tools/engraphis
36+ # Which extras the self-updater installs on top of the base package. The installer
37+ # cannot see which extras the current install selected, so it defaults to the safe
38+ # superset `engraphis[all]`; set a comma-separated list (e.g. `server,mcp`) to pin
39+ # a smaller surface, or `none` for the base package only.
40+ # ENGRAPHIS_UPDATE_EXTRAS=
3541
3642# Optional local API bearer. If set, supported protected routes accept
3743# Authorization: Bearer <token>. Use a strong, independently revocable value and do not
@@ -70,10 +76,16 @@ ENGRAPHIS_API_TOKEN=
7076ENGRAPHIS_EMBED_MODEL = sentence-transformers/all-MiniLM-L6-v2
7177# Embedding dimension is auto-detected from the model. Override only if needed.
7278# ENGRAPHIS_EMBED_DIM=384
79+ # Vector index backend for the v2 engine: "numpy" (default, deterministic reference
80+ # index), "sqlite-vec" (require the accelerated ANN backend; needs the sqlite-vec
81+ # package), or "auto" (use sqlite-vec when available, fall back to NumPy).
82+ # ENGRAPHIS_VECTOR_BACKEND=numpy
7383
7484# ── LLM (external, you choose the provider) ─────────────────────────────────
7585# Provider: openai | anthropic | google | openrouter | custom
7686# Copy-ready provider setups and endpoint requirements: docs/LLM_PROVIDERS.md
87+ # Codex subscription users: connect Codex to this installation over MCP; the subscription
88+ # path does not use ENGRAPHIS_LLM_PROVIDER or an Engraphis LLM API key.
7789# ── v2 write-path fact extraction (optional) ─────────────────────────────────
7890# "none" (default): store text as given. "chunk": deterministic offline chunks.
7991# "llm": free-form fact extraction. "llm_structured": schema-validated typed facts,
@@ -97,6 +109,9 @@ ENGRAPHIS_GRAPH_EXTRACTOR=regex
97109# "llm" sends a bounded excerpt to the configured provider for an advisory
98110# ephemeral/normal/critical signal. Writes are never discarded.
99111ENGRAPHIS_RETENTION_SUPERVISOR = none
112+ # A remote retention supervisor is advisory: without this opt-in, its "critical"
113+ # recommendations keep normal retention strength. Set 1 to honor critical signals.
114+ # ENGRAPHIS_ALLOW_AUTOMATIC_CRITICAL_RETENTION=0
100115
101116# Optional local resource adapters:
102117# ENGRAPHIS_WHISPER_MODEL=/absolute/path/to/local-whisper-model
@@ -112,6 +127,19 @@ ENGRAPHIS_RETENTION_SUPERVISOR=none
112127# ENGRAPHIS_GRAPH_HOST=127.0.0.1
113128# ENGRAPHIS_GRAPH_PORT=8720
114129
130+ # Standalone MCP-over-HTTP server (`engraphis-mcp-http`). Loopback-only by default;
131+ # any non-loopback bind (via these or ENGRAPHIS_HOST) requires ENGRAPHIS_API_TOKEN.
132+ # ENGRAPHIS_HTTP_HOST=127.0.0.1
133+ # ENGRAPHIS_HTTP_PORT=8080
134+ # ENGRAPHIS_HTTP_TRANSPORT=streamable-http
135+
136+ # When running under Docker (auto-detected via /.dockerenv), the self-updater skips
137+ # in-place pip upgrades and prints a manual reinstall hint instead.
138+ # ENGRAPHIS_DOCKER=0
139+
140+ # Docker Compose host port mapping override for the dashboard (default 8700).
141+ # ENGRAPHIS_COMPOSE_PORT=8700
142+
115143# ── Reverse proxy (TLS termination) ─────────────────────────────────────────
116144# When behind a proxy that terminates TLS (Railway/Fly/nginx), trust its
117145# X-Forwarded-Proto/-For headers so request.url.scheme is https and the session
@@ -135,6 +163,9 @@ ENGRAPHIS_RETENTION_SUPERVISOR=none
135163# ENGRAPHIS_CSP="" # send no CSP at all
136164# ENGRAPHIS_HSTS="max-age=31536000; includeSubDomains"
137165
166+ # Codex subscription users can use the local MCP connection documented in README.md and
167+ # docs/AGENT_CONNECT.md; leave the optional external LLM settings below disabled unless
168+ # Engraphis itself must call a separate provider.
138169ENGRAPHIS_LLM_PROVIDER = openai
139170# Model name (provider-specific):
140171# openai: gpt-4o-mini, gpt-4o, gpt-4.1-mini, o4-mini ...
@@ -143,17 +174,12 @@ ENGRAPHIS_LLM_PROVIDER=openai
143174# openrouter: anthropic/claude-3.5-sonnet, openai/gpt-4o-mini ...
144175# custom: any model name your OpenAI-compatible endpoint accepts
145176ENGRAPHIS_LLM_MODEL = gpt-4o-mini
146- # API key for chat/synthesis, llm/llm_structured extraction, and structured consolidation:
147- ENGRAPHIS_LLM_API_KEY = sk-your-key-here
177+ # API key for chat/synthesis, llm/llm_structured extraction, and structured consolidation.
178+ # Leave unset until you explicitly choose a provider and enable an LLM-backed feature.
179+ # ENGRAPHIS_LLM_API_KEY=<your-api-key>
148180# For openrouter / custom: the base URL of the OpenAI-compatible endpoint.
149181# openrouter: https://openrouter.ai/api/v1
150182# custom: https://your-endpoint/v1
151- # ollama: http://localhost:11434/v1
152- # Ollama example (replace the model with one you have pulled):
153- # ENGRAPHIS_LLM_PROVIDER=custom
154- # ENGRAPHIS_LLM_MODEL=qwen2.5-coder:latest
155- # ENGRAPHIS_LLM_API_KEY=ollama # must be non-empty; default local Ollama ignores it
156- # ENGRAPHIS_LLM_BASE_URL=http://localhost:11434/v1
157183# ENGRAPHIS_LLM_BASE_URL=https://openrouter.ai/api/v1
158184# Optional: extra headers (JSON string) for custom providers.
159185# ENGRAPHIS_LLM_EXTRA_HEADERS={"HTTP-Referer":"https://myapp.com","X-Title":"engraphis"}
@@ -277,6 +303,12 @@ ENGRAPHIS_LLM_API_KEY=sk-your-key-here
277303# ENGRAPHIS_CHUNK_TOKENIZER_REVISION=<immutable model commit>
278304# ENGRAPHIS_LOOP_INTERVAL=60
279305# ENGRAPHIS_LOOP_TOP_K=20
306+ # Automatic local consolidation inside the background loop. OFF by default (0): the
307+ # sweep is a workspace-wide cluster scan, so it should be an explicit operator choice.
308+ # N > 0 runs it at most once every N loop ticks (e.g. 30 with a 60s interval ≈ every
309+ # 30 minutes). The sweep is deterministic/offline (never passes an LLM), archives
310+ # decayed transients, and distills recurring episodic memories into semantic digests.
311+ # ENGRAPHIS_LOOP_CONSOLIDATE=0
280312# ENGRAPHIS_RERANK_MODEL=cross-encoder/ms-marco-MiniLM-L-6-v2
281313
282314# Workspace allow-list: comma-separated names. Empty = all allowed.
@@ -286,6 +318,11 @@ ENGRAPHIS_LLM_API_KEY=sk-your-key-here
286318# ENGRAPHIS_RELAY_URL=https://relay.example.com
287319# ENGRAPHIS_SYNC_TOKEN=
288320# ENGRAPHIS_SYNC_READ_ONLY=0
321+ # End-to-end encryption key for Cloud Sync bundles (relay transport). A single
322+ # immutable 32-byte URL-safe base64 value (43 chars, or 44 with one '=' pad) that
323+ # every authorized device shares; changing it makes previously stored ciphertext
324+ # unreadable. The folder transport does not encrypt at rest — see docs/SYNC.md.
325+ # ENGRAPHIS_SYNC_E2EE_KEY=
289326
290327# Hosted plan upgrade URLs: override the default upgrade landing pages.
291328# ENGRAPHIS_UPGRADE_URL=
0 commit comments