@@ -53,7 +53,7 @@ ENGRAPHIS_API_TOKEN=
5353# A 64-hex value is used as a raw 32-byte key; anything else is treated as a passphrase.
5454# WARNING: lose this key = lose the data (no recovery). In production, inject it from a
5555# secrets manager (or ENGRAPHIS_DB_KEY_FILE), NOT from this file. An existing PLAINTEXT
56- # db cannot just be keyed — migrate it (dump → import into a fresh keyed db).
56+ # db cannot just be keyed. Migrate it (dump → import into a fresh keyed db).
5757# ENGRAPHIS_DB_KEY=
5858# ...or read the key from a file (e.g. a mounted docker/k8s secret):
5959# ENGRAPHIS_DB_KEY_FILE=/run/secrets/engraphis_db_key
@@ -66,6 +66,7 @@ ENGRAPHIS_EMBED_MODEL=sentence-transformers/all-MiniLM-L6-v2
6666
6767# ── LLM (external, you choose the provider) ─────────────────────────────────
6868# Provider: openai | anthropic | google | openrouter | custom
69+ # Copy-ready provider setups and endpoint requirements: docs/LLM_PROVIDERS.md
6970# ── v2 write-path fact extraction (optional) ─────────────────────────────────
7071# "none" (default): store text as given. "chunk": deterministic offline chunks.
7172# "llm": free-form fact extraction. "llm_structured": schema-validated typed facts,
@@ -80,7 +81,7 @@ ENGRAPHIS_LLM_AUTO_EXTRACT=0
8081
8182# ── Knowledge-graph extraction (powers the dashboard Graph tab) ──────────────
8283# "regex" (default): dependency-free heuristic NER runs on every ingest so the Graph tab
83- # has nodes — no API key, safe offline. "none": disable heuristic text extraction.
84+ # has nodes: no API key, safe offline. "none": disable heuristic text extraction.
8485# Validated entity/relation metadata from "llm_structured" still feeds the graph
8586# automatically. Existing memories are backfilled when a workspace graph first opens.
8687ENGRAPHIS_GRAPH_EXTRACTOR = regex
@@ -122,7 +123,7 @@ ENGRAPHIS_RETENTION_SUPERVISOR=none
122123# header entirely, which is what you want when a fronting proxy sets its own.
123124# The default CSP is strict same-origin and contains no unsafe-inline; dashboard CSS,
124125# JavaScript, and vendored libraries are served under /static.
125- # Quote the values — both contain characters a shell would otherwise split on.
126+ # Quote the values because both contain characters a shell would otherwise split on.
126127# ENGRAPHIS_CSP="default-src 'self'; frame-ancestors 'none'" # replace the policy
127128# ENGRAPHIS_CSP="" # send no CSP at all
128129# ENGRAPHIS_HSTS="max-age=31536000; includeSubDomains"
@@ -140,6 +141,12 @@ ENGRAPHIS_LLM_API_KEY=sk-your-key-here
140141# For openrouter / custom: the base URL of the OpenAI-compatible endpoint.
141142# openrouter: https://openrouter.ai/api/v1
142143# custom: https://your-endpoint/v1
144+ # ollama: http://localhost:11434/v1
145+ # Ollama example (replace the model with one you have pulled):
146+ # ENGRAPHIS_LLM_PROVIDER=custom
147+ # ENGRAPHIS_LLM_MODEL=qwen2.5-coder:latest
148+ # ENGRAPHIS_LLM_API_KEY=ollama # must be non-empty; default local Ollama ignores it
149+ # ENGRAPHIS_LLM_BASE_URL=http://localhost:11434/v1
143150# ENGRAPHIS_LLM_BASE_URL=https://openrouter.ai/api/v1
144151# Optional: extra headers (JSON string) for custom providers.
145152# ENGRAPHIS_LLM_EXTRA_HEADERS={"HTTP-Referer":"https://myapp.com","X-Title":"engraphis"}
@@ -179,15 +186,15 @@ ENGRAPHIS_LLM_API_KEY=sk-your-key-here
179186# The plan is resolved automatically: once this installation has reached the control plane
180187# it reads the authoritative entitlement (plan and feature list) and caches it beside the
181188# cloud session, so a Pro or Team badge is correct on every later boot including offline
182- # ones. The refresh is opportunistic and runs on a background thread — it never blocks or
189+ # ones. The refresh is opportunistic and runs on a background thread. It never blocks or
183190# delays startup, and it never fails the dashboard when the cloud is unreachable. Before
184191# the very first successful contact a connected installation is presented as Pro, the
185192# smallest paid plan, so a paying customer is never shown the free local core.
186193#
187194# ENGRAPHIS_CLOUD_PLAN is an override for the cases automatic resolution cannot cover: an
188195# air-gapped deployment, or one pinned to a short-lived ENGRAPHIS_CLOUD_ACCESS_TOKEN that
189196# cannot refresh. It takes precedence over the cached entitlement. Accepts pro, team, or
190- # free. It is presentation only — setting it grants nothing, because Engraphis Cloud
197+ # free. It is presentation only. Setting it grants nothing, because Engraphis Cloud
191198# authorizes every paid call regardless of what this client displays.
192199# ENGRAPHIS_CLOUD_PLAN=team
193200#
@@ -208,7 +215,7 @@ ENGRAPHIS_LLM_API_KEY=sk-your-key-here
208215# snapshots, while an installation connected to Engraphis Cloud is allowed by default,
209216# because connecting already accepts the terms covering managed analytics, dreaming, and
210217# consolidation. This variable is an explicit operator override, not a customer-facing
211- # setting — set it to 0 to opt a connected installation back out, or to 1 to force
218+ # setting: set it to 0 to opt a connected installation back out, or to 1 to force
212219# managed compute on regardless of session state. The cloud service remains authoritative
213220# for all paid computation.
214221# ENGRAPHIS_MANAGED_COMPUTE_CONSENT=0
@@ -220,36 +227,36 @@ ENGRAPHIS_LLM_API_KEY=sk-your-key-here
220227# These settings are used by advanced deployments, operators, and internal
221228# subsystems. Leave commented unless your deployment needs them.
222229
223- # Logging — defaults to INFO, text format.
230+ # Logging: defaults to INFO, text format.
224231# ENGRAPHIS_LOG_LEVEL=INFO
225232# ENGRAPHIS_LOG_FORMAT=text
226233# ENGRAPHIS_LOG_JSON=0
227234
228- # CORS — comma-separated origins allowed to call the dashboard REST API.
235+ # CORS: comma-separated origins allowed to call the dashboard REST API.
229236# Default: http://127.0.0.1:<ENGRAPHIS_PORT> and
230237# http://localhost:<ENGRAPHIS_PORT>. Explicit values replace both loopback origins.
231238# ENGRAPHIS_CORS_ORIGINS=https://myapp.example.com
232239
233- # Rate limiting — requests per window. Default: 0 (disabled), with a 60s window
240+ # Rate limiting: requests per window. Default: 0 (disabled), with a 60s window
234241# used when ENGRAPHIS_RATE_LIMIT is set above zero.
235242# ENGRAPHIS_RATE_LIMIT=0
236243# ENGRAPHIS_RATE_WINDOW=60
237244
238- # HTTPS security origin — used for HTTP-to-HTTPS redirects and security headers.
245+ # HTTPS security origin: used for HTTP-to-HTTPS redirects and security headers.
239246# ENGRAPHIS_PUBLIC_URL wins; when unset, security falls back to
240247# ENGRAPHIS_DASHBOARD_URL, then the legacy ENGRAPHIS_RELAY_PUBLIC_URL setting.
241248# These settings do not change CORS; configure ENGRAPHIS_CORS_ORIGINS separately.
242249# ENGRAPHIS_PUBLIC_URL=https://engraphis.example.com
243250# ENGRAPHIS_RELAY_PUBLIC_URL=https://relay.example.com
244251
245- # Trusted local peers — comma-separated addresses exempt from rate limiting.
252+ # Trusted local peers: comma-separated addresses exempt from rate limiting.
246253# ENGRAPHIS_LOCAL_TRUSTED_PEERS=127.0.0.1,::1
247254
248- # Import roots — semicolon-separated (Windows) or colon-separated (POSIX)
255+ # Import roots: semicolon-separated (Windows) or colon-separated (POSIX)
249256# directories allowed as import sources.
250257# ENGRAPHIS_IMPORT_ROOTS=/srv/docs:/home/user/notes
251258
252- # Memory engine tuning — decay halflife (days), chunk sizing (tokens),
259+ # Memory engine tuning: decay halflife (days), chunk sizing (tokens),
253260# proactive context loop, and reranker model.
254261# ENGRAPHIS_DECAY_HALFLIFE_DAYS=30
255262# ENGRAPHIS_CHUNK_TOKENS=512
@@ -263,15 +270,15 @@ ENGRAPHIS_LLM_API_KEY=sk-your-key-here
263270# ENGRAPHIS_LOOP_TOP_K=10
264271# ENGRAPHIS_RERANK_MODEL=cross-encoder/ms-marco-MiniLM-L-6-v2
265272
266- # Workspace allow-list — comma-separated names. Empty = all allowed.
273+ # Workspace allow-list: comma-separated names. Empty = all allowed.
267274# ENGRAPHIS_WORKSPACES=acme,personal
268275
269- # Cloud Sync relay — endpoint and optional token for self-hosted relay.
276+ # Cloud Sync relay: endpoint and optional token for self-hosted relay.
270277# ENGRAPHIS_RELAY_URL=https://relay.example.com
271278# ENGRAPHIS_SYNC_TOKEN=
272279# ENGRAPHIS_SYNC_READ_ONLY=0
273280
274- # Hosted plan upgrade URLs — override the default upgrade landing pages.
281+ # Hosted plan upgrade URLs: override the default upgrade landing pages.
275282# ENGRAPHIS_UPGRADE_URL=
276283# ENGRAPHIS_PRO_UPGRADE_URL=
277284# ENGRAPHIS_TEAM_UPGRADE_URL=
0 commit comments