docs: Added CLAUDE.md redirect to ub01 canonical path, updated README with deployment section

This commit is contained in:
jlightner 2026-03-30 01:28:26 +00:00
parent 541354d89e
commit 9fdef3b720
2 changed files with 92 additions and 1 deletions

48
CLAUDE.md Normal file
View file

@ -0,0 +1,48 @@
# Chrysopedia — Development Reference
## ⚠️ Canonical Development Directory
**This is NOT the canonical development directory.**
The production codebase and all future development happens on **ub01**:
```
ssh ub01
cd /vmPool/r/repos/xpltdco/chrysopedia
```
**GitHub:** https://github.com/xpltdco/chrysopedia (private, xpltdco org)
## Why?
The Docker Compose stack runs on ub01 with bind mounts at `/vmPool/r/services/chrysopedia_*`. Development, deployment, and testing all happen from the ub01 clone. This directory (`/home/aux/projects/content-to-kb-automator`) was the initial workspace used during M001 development and should not be used for future work.
## Stack Info
- **Web UI:** http://ub01:8096
- **API Health:** http://ub01:8096/health
- **PostgreSQL:** ub01:5433 (user: chrysopedia)
- **Compose project:** xpltd_chrysopedia
- **Compose path:** /vmPool/r/compose/xpltd_chrysopedia/docker-compose.yml (symlink to repo)
- **Services:** chrysopedia-db, chrysopedia-redis, chrysopedia-qdrant, chrysopedia-ollama, chrysopedia-api, chrysopedia-worker, chrysopedia-web-8096
## Quick Commands (on ub01)
```bash
# Check status
docker ps --filter name=chrysopedia
# Rebuild and restart after code changes
cd /vmPool/r/repos/xpltdco/chrysopedia
git pull
docker compose build && docker compose up -d
# Run Alembic migrations
docker exec chrysopedia-api alembic upgrade head
# View worker logs
docker logs -f chrysopedia-worker
# View API logs
docker logs -f chrysopedia-api
```

View file

@ -275,5 +275,48 @@ This project follows XPLTD infrastructure conventions:
- **Docker project name:** `xpltd_chrysopedia`
- **Bind mounts:** persistent data stored under `/vmPool/r/services/`
- **Network:** dedicated bridge `chrysopedia` (`172.24.0.0/24`)
- **Network:** dedicated bridge `chrysopedia` (`172.32.0.0/24`)
- **PostgreSQL host port:** `5433` (avoids conflict with system PostgreSQL on `5432`)
---
## Deployment (ub01)
The production stack runs on **ub01.a.xpltd.co**:
```bash
# Clone (first time only — requires SSH agent forwarding)
ssh -A ub01
cd /vmPool/r/repos/xpltdco/chrysopedia
git clone git@github.com:xpltdco/chrysopedia.git .
# Create .env from template
cp .env.example .env
# Edit .env with production secrets
# Build and start
docker compose build
docker compose up -d
# Run migrations
docker exec chrysopedia-api alembic upgrade head
# Pull embedding model (first time only)
docker exec chrysopedia-ollama ollama pull nomic-embed-text
```
### Service URLs
| Service | URL |
|---------|-----|
| Web UI | http://ub01:8096 |
| API Health | http://ub01:8096/health |
| PostgreSQL | ub01:5433 |
| Compose config | `/vmPool/r/compose/xpltd_chrysopedia/docker-compose.yml` |
### Update Workflow
```bash
ssh -A ub01
cd /vmPool/r/repos/xpltdco/chrysopedia
git pull
docker compose build && docker compose up -d
```