Skip to content

Commit 4455def

Browse files
committed
Docs: use docker exclusively for all setups and restore UI screenshot
1 parent 428b3db commit 4455def

1 file changed

Lines changed: 33 additions & 35 deletions

File tree

README.md

Lines changed: 33 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ KryptoDB is a graph-based memory server for multi-agent systems, exposing its kn
1313

1414
---
1515

16+
<div align="center">
17+
<img src="image-1.png" alt="KryptoDB Web Dashboard" style="max-width: 100%" />
18+
</div>
19+
20+
---
21+
1622
## 🔒 Security Model & Residual Trust
1723

1824
KryptoDB isolates knowledge between agents using envelope encryption. Every new fact receives a fresh random Data Encryption Key (DEK), wrapped by a stable Key Encryption Key (KEK) tied to a specific permission scope. Agents never receive DEKs or KEKs; the daemon decrypts only authorized final candidates.
@@ -57,28 +63,10 @@ KryptoDB operates as an intermediary broker between LLM agents and the encrypted
5763
- *(SQLite is bundled internally by the daemon for lightweight state tracking, no setup required).*
5864

5965
### 1. Start the backend
60-
Clone the repo and configure the minimal environment:
61-
```bash
62-
python -m venv .venv
63-
source .venv/bin/activate
64-
pip install -e .
65-
```
66+
Ensure Docker is installed, then launch the production stack (which includes KryptoDB, Neo4j, and Redis) in detached mode:
6667

67-
Create a `.env` file (minimal local setup):
68-
```env
69-
NEO4J_URI=bolt://localhost:7687
70-
NEO4J_USER=neo4j
71-
NEO4J_PASSWORD=password
72-
REDIS_URL=redis://localhost:6379/0
73-
KRYPTODB_MASTER_KEY=b2c4d6e8f0a2c4d6e8f0a2c4d6e8f0a2c4d6e8f0a2c4d6e8f0a2c4d6e8f0a2c4
74-
KRYPTODB_ADMIN_API_KEY=dev-admin-key
75-
# DO NOT USE THIS FLAG IN PRODUCTION:
76-
KRYPTODB_BOOTSTRAP_UNENCRYPTED=true
77-
```
78-
79-
Launch the daemon:
8068
```bash
81-
uvicorn kryptodb.daemon.server:app --host 127.0.0.1 --port 8000
69+
docker compose -f kryptodb-compose.yml up -d
8270
```
8371
*The web UI is now accessible at http://127.0.0.1:8000.*
8472

@@ -93,20 +81,25 @@ curl -X POST http://127.0.0.1:8000/admin/api-keys \
9381
*Note the returned `api_key`.*
9482

9583
### 3. Connect via MCP (Claude Desktop / Cursor / Codex)
96-
Add the native Python MCP server to your IDE/client configuration, replacing `<paste-api-key>` with the key from the previous step:
84+
Add the Docker MCP server to your IDE/client configuration, replacing `<paste-api-key>` with the key from the previous step:
9785

9886
**JSON Format (Claude / Cursor):**
9987
```json
10088
{
10189
"mcpServers": {
10290
"kryptodb": {
103-
"command": "/absolute/path/to/AIAgent/.venv/bin/python",
104-
"args": ["-m", "kryptodb.daemon.mcp_server"],
105-
"env": {
106-
"AGENT_ID": "Agent-1",
107-
"KRYPTODB_API_KEY": "<paste-api-key>",
108-
"KRYPTODB_URL": "http://127.0.0.1:8000"
109-
}
91+
"command": "docker",
92+
"args": [
93+
"run",
94+
"-i",
95+
"--rm",
96+
"--network", "aiagent_default",
97+
"-e", "AGENT_ID=Agent-1",
98+
"-e", "KRYPTODB_API_KEY=<paste-api-key>",
99+
"-e", "KRYPTODB_URL=http://daemon:8000",
100+
"ghcr.io/prolomaster/kryptodb:latest",
101+
"mcp"
102+
]
110103
}
111104
}
112105
}
@@ -115,13 +108,18 @@ Add the native Python MCP server to your IDE/client configuration, replacing `<p
115108
**TOML Format (RooCode / Windsurf / Codex):**
116109
```toml
117110
[mcp_servers.kryptodb]
118-
command = "/absolute/path/to/AIAgent/.venv/bin/python"
119-
args = ["-m", "kryptodb.daemon.mcp_server"]
120-
121-
[mcp_servers.kryptodb.env]
122-
AGENT_ID = "Agent-1"
123-
KRYPTODB_API_KEY = "<paste-api-key>"
124-
KRYPTODB_URL = "http://127.0.0.1:8000"
111+
command = "docker"
112+
args = [
113+
"run",
114+
"-i",
115+
"--rm",
116+
"--network", "aiagent_default",
117+
"-e", "AGENT_ID=Agent-1",
118+
"-e", "KRYPTODB_API_KEY=<paste-api-key>",
119+
"-e", "KRYPTODB_URL=http://daemon:8000",
120+
"ghcr.io/prolomaster/kryptodb:latest",
121+
"mcp"
122+
]
125123
```
126124

127125
---

0 commit comments

Comments
 (0)