fleet-memory/standalone/QUICKSTART.md
2025-11-11 12:35:20 +01:00

106 lines
2.1 KiB
Markdown

# Memora Standalone - Quick Start
## What is this?
A single Docker image containing everything you need to run Memora:
- ✅ PostgreSQL database
- ✅ Dataplane API (FastAPI backend)
- ✅ Control Plane (Next.js web UI)
## Fastest Start (Docker Compose)
```bash
cd standalone
docker-compose up -d
```
Access the UI at: **http://localhost:3000**
## Manual Docker Build & Run
### Build the image:
```bash
./standalone/build-docker.sh
```
### Run with the helper script:
```bash
./standalone/run-docker.sh --persist
```
### Or run directly:
```bash
docker run -d \
--name memora \
-p 3000:3000 \
-p 8080:8080 \
-p 5432:5432 \
-v memora-data:/var/lib/postgresql/data \
memora-standalone:latest
```
## Access Points
| Service | URL | Purpose |
|---------|-----|---------|
| **Control Plane** | http://localhost:3000 | Web UI |
| **Dataplane API** | http://localhost:8080 | REST API |
| **PostgreSQL** | localhost:5432 | Database |
## View Logs
```bash
docker logs -f memora-standalone
```
## Stop & Remove
```bash
# Stop
docker-compose down
# Stop and remove data
docker-compose down -v
```
## Environment Variables
Set in `docker-compose.yml` or pass with `-e`:
- `MEMORA_API_LLM_PROVIDER` - LLM provider (openai, groq, ollama, none) (default: none)
- `MEMORA_API_LLM_API_KEY` - API key for LLM provider
- `MEMORA_API_LLM_MODEL` - LLM model name (default: openai/gpt-oss-120b)
- `MEMORA_API_LLM_BASE_URL` - Optional custom LLM endpoint
- `MEMORA_CP_DATAPLANE_API_URL` - Dataplane API URL (default: http://localhost:8080)
## Troubleshooting
**Container won't start:**
```bash
docker logs memora-standalone
```
**Database issues:**
```bash
docker exec -it memora-standalone su - postgres -c "psql memora"
```
**Reset everything:**
```bash
docker-compose down -v
docker-compose up -d
```
## Production Notes
This standalone image is ideal for:
- ✅ Development
- ✅ Demos
- ✅ Testing
- ✅ Small deployments
For production, consider:
- Separate containers for each service
- External PostgreSQL database
- Kubernetes/Docker Swarm orchestration
- Environment-specific configurations