Skip to content

Commit 0a09e65

Browse files
Thomas TupperThomas Tupper
authored andcommitted
docs: add required environment variable contract table
1 parent b65e6a3 commit 0a09e65

1 file changed

Lines changed: 22 additions & 8 deletions

File tree

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,28 @@ bash scripts/smoke-external.sh
6262

6363
The `.env` file configures image tags, model names, and provider keys.
6464

65-
Most important fields:
66-
67-
- `FOXMEMORY_INFER_IMAGE`
68-
- `FOXMEMORY_STORE_IMAGE`
69-
- `OPENAI_BASE_URL`
70-
- `OPENAI_API_KEY`
71-
- `MEM0_LLM_MODEL`
72-
- `MEM0_EMBED_MODEL`
65+
### Required environment variables
66+
67+
| Variable | Purpose | Consumed by | Example |
68+
|---|---|---|---|
69+
| `FOXMEMORY_INFER_IMAGE` | Infer container image tag | Docker Compose (`infer`) | `docker.io/foxlightfoundation/foxmemory-infer:latest` |
70+
| `FOXMEMORY_STORE_IMAGE` | Store container image tag | Docker Compose (`store`) | `docker.io/foxlightfoundation/foxmemory-store:latest` |
71+
| `OLLAMA_BASE_URL` | Local model runtime URL for infer | `infer` service | `http://host.docker.internal:11434` |
72+
| `OLLAMA_EMBED_MODEL` | Embedding model name for infer | `infer` service | `nomic-embed-text` |
73+
| `OLLAMA_CHAT_MODEL` | Chat model name for infer | `infer` service | `llama3.1:8b` |
74+
| `INFER_API_KEY` | API key accepted by infer and forwarded to store in one-node compose | `infer` service; one-node `store` auth wiring | `change-me` |
75+
| `OPENAI_BASE_URL` | OpenAI-compatible base URL for store calls | `store` service | `http://infer:8081/v1` |
76+
| `OPENAI_API_KEY` | Provider API key used by store | `store` service | `change-me` |
77+
| `MEM0_LLM_MODEL` | LLM model used for memory reasoning | `store` service | `gpt-4.1-nano` |
78+
| `MEM0_EMBED_MODEL` | Embedding model used by store | `store` service | `text-embedding-3-small` |
79+
| `QDRANT_URL` | Canonical Qdrant endpoint URL | store runtime (where supported) | `http://qdrant:6333` |
80+
| `QDRANT_API_KEY` | Qdrant auth key (optional) | store runtime | `` |
81+
| `QDRANT_COLLECTION` | Collection name for memory vectors | `store` service | `foxmemory` |
82+
83+
Backward-compatible variables still present in some scripts/builds:
84+
85+
- `QDRANT_HOST`
86+
- `QDRANT_PORT`
7387

7488
---
7589

0 commit comments

Comments
 (0)