How-to guides
Each guide solves one operational task, assuming a working deployment (start with Getting started if you don’t have one). For the why behind these procedures, see Architecture.
Run it in production
Section titled “Run it in production”| Guide | Task |
|---|---|
| Deploy to production | Build and run the hardened Docker image, compose file, health checks |
| Back up and restore | pg_dump, retention policy, restore drills |
| Enable observability | Prometheus metrics scraping and OpenTelemetry tracing |
| Migrate lite to standard | Switch a lite deployment to the standard multi-tenant profile |
Secure it
Section titled “Secure it”| Guide | Task |
|---|---|
| Enable authentication | AUTH_REQUIRED, JWT_SECRET, the boot fail-safe, verifying enforcement |
| Provision agent API keys | Mint, distribute, and rotate least-privilege per-agent keys |
Tune retrieval
Section titled “Tune retrieval”| Guide | Task |
|---|---|
| Configure embeddings | Providers and safe model/dimension changes |
| Reindex embeddings | Rebuild the vector store — CLI flags and the queued admin tools |
Move data in
Section titled “Move data in”| Guide | Task |
|---|---|
| Import agent memory | Bulk-import Claude/Copilot/Cursor/Codex/Gemini memory files |
Extend and validate
Section titled “Extend and validate”| Guide | Task |
|---|---|
| Add an MCP tool | Zod schema → manifest entry → handler → regenerated reference |
| Write evaluations | Score retrieval quality with @engram/eval; recall gate |
| Run a load test | Throughput/latency of the storage pipeline with scripts/load-test.mjs |