Skip to content

Commit 905d7b2

Browse files
Thomas TupperThomas Tupper
authored andcommitted
docs: add deployment guides, compose files, and agent instruction docs
1 parent 075334a commit 905d7b2

10 files changed

Lines changed: 116 additions & 3 deletions

File tree

.cursor/rules/foxmemory-deploy.mdc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
description: Rules for Cursor in foxmemory-deploy
3+
globs:
4+
- "*.yml"
5+
- "docs/**/*.md"
6+
alwaysApply: true
7+
---
8+
- Keep deployment instructions reproducible and explicit.
9+
- Keep compose.one.yml and compose.split.yml coherent.
10+
- Never introduce plaintext secrets.

.env.example

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Copy to .env and customize
2+
FOXMEMORY_INFER_IMAGE=ghcr.io/foxlight-foundation/foxmemory-infer:latest
3+
FOXMEMORY_STORE_IMAGE=ghcr.io/foxlight-foundation/foxmemory-store:latest

.github/copilot-instructions.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# GitHub Copilot Instructions
2+
3+
This repo packages deployment topology.
4+
- Favor explicit compose config over magic.
5+
- Keep commands copy/paste safe.
6+
- Update docs whenever compose behavior changes.

AGENTS.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Agent Instructions (foxmemory-deploy)
2+
3+
## Priority
4+
1. Keep deployment examples reproducible.
5+
2. Keep one-node and split modes both functional.
6+
3. Document all env vars and defaults.
7+
8+
## Rules
9+
- Never hardcode private credentials.
10+
- Keep compose files minimal and explicit.
11+
- Update README + runbook when topology changes.

CLAUDE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# CLAUDE.md
2+
3+
- Read `AGENTS.md` first.
4+
- Validate compose syntax before committing.
5+
- Keep docs aligned with actual files/commands.

CODEX.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# CODEX.md
2+
3+
- Preserve reproducible deployment commands.
4+
- Keep one-node and split compose files in sync with docs.
5+
- Avoid hidden assumptions about host paths/secrets.

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,34 @@
11
# foxmemory-deploy
22

3-
Initial scaffold for Foxlight Foundation memory infrastructure.
3+
Deployment pack for FoxMemory services.
44

5-
## Status
5+
## Why this exists
6+
This repo makes FoxMemory reproducible for others: one-command local deploy, clear environment config, and documented deployment topologies.
67

7-
Scaffolded v0.
8+
## Deployment modes
9+
1. **One-node mode** (`compose.one.yml`)
10+
- infer + store together on one host
11+
2. **Split mode** (`compose.split.yml`)
12+
- infer and store independently deployable
13+
14+
## Quick start
15+
```bash
16+
cp .env.example .env
17+
docker compose -f compose.one.yml up -d
18+
```
19+
20+
Then verify:
21+
```bash
22+
curl -s http://localhost:8081/health
23+
curl -s http://localhost:8082/health
24+
```
25+
26+
## Files
27+
- `compose.one.yml`
28+
- `compose.split.yml`
29+
- `.env.example`
30+
- `docs/RUNBOOK.md`
31+
32+
## Notes
33+
- Current images default to GHCR references.
34+
- Can be switched to Docker Hub tags once registry workflow is updated.

compose.one.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
services:
2+
infer:
3+
image: ghcr.io/foxlight-foundation/foxmemory-infer:latest
4+
container_name: foxmemory-infer
5+
ports:
6+
- "8081:8081"
7+
store:
8+
image: ghcr.io/foxlight-foundation/foxmemory-store:latest
9+
container_name: foxmemory-store
10+
ports:
11+
- "8082:8082"
12+
depends_on:
13+
- infer

compose.split.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
services:
2+
infer:
3+
image: ghcr.io/foxlight-foundation/foxmemory-infer:latest
4+
ports:
5+
- "8081:8081"
6+
7+
store:
8+
image: ghcr.io/foxlight-foundation/foxmemory-store:latest
9+
ports:
10+
- "8082:8082"
11+
environment:
12+
- FOXMEMORY_INFER_URL=http://infer:8081

docs/RUNBOOK.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Runbook
2+
3+
## Start
4+
```bash
5+
docker compose -f compose.one.yml up -d
6+
```
7+
8+
## Stop
9+
```bash
10+
docker compose -f compose.one.yml down
11+
```
12+
13+
## Health checks
14+
```bash
15+
curl -s http://localhost:8081/health
16+
curl -s http://localhost:8082/health
17+
```
18+
19+
## Troubleshooting
20+
- image pull errors: verify registry auth/tag
21+
- service unavailable: inspect `docker compose logs`

0 commit comments

Comments
 (0)