Skip to content

Commit d2795cb

Browse files
committed
Update documentation and configuration to reflect the transition from 'friend-backend' to 'chronicle-backend' across various files, including setup instructions, Docker configurations, and service logs.
1 parent 765373c commit d2795cb

File tree

22 files changed

+103
-60
lines changed

22 files changed

+103
-60
lines changed

.github/workflows/robot-tests.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ jobs:
141141
# Show logs every 10 attempts to help debug
142142
if [ $((i % 10)) -eq 0 ]; then
143143
echo "Still waiting... showing recent logs:"
144-
docker compose -f docker-compose-test.yml logs --tail=20 friend-backend-test
144+
docker compose -f docker-compose-test.yml logs --tail=20 chronicle-backend-test
145145
fi
146146
if [ $i -eq 40 ]; then
147147
echo "✗ Backend failed to start - showing full logs:"
@@ -219,7 +219,7 @@ jobs:
219219
working-directory: backends/advanced
220220
run: |
221221
echo "=== Backend Logs (last 50 lines) ==="
222-
docker compose -f docker-compose-test.yml logs --tail=50 friend-backend-test
222+
docker compose -f docker-compose-test.yml logs --tail=50 chronicle-backend-test
223223
echo ""
224224
echo "=== Worker Logs (last 50 lines) ==="
225225
docker compose -f docker-compose-test.yml logs --tail=50 workers-test

CLAUDE.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,49 @@ This supports a comprehensive web dashboard for management.
1313

1414
**❌ No Backward Compatibility**: Do NOT add backward compatibility code unless explicitly requested. This includes fallback logic, legacy field support, or compatibility layers. Always ask before adding backward compatibility - in most cases the answer is no during active development.
1515

16+
## Initial Setup & Configuration
17+
18+
Chronicle includes an **interactive setup wizard** for easy configuration. The wizard guides you through:
19+
- Service selection (backend + optional services)
20+
- Authentication setup (admin account, JWT secrets)
21+
- Transcription provider configuration (Deepgram, Mistral, or offline ASR)
22+
- LLM provider setup (OpenAI or Ollama)
23+
- Memory provider selection (Chronicle Native with Qdrant or OpenMemory MCP)
24+
- Network configuration and HTTPS setup
25+
- Optional services (speaker recognition, Parakeet ASR)
26+
27+
### Quick Start
28+
```bash
29+
# Run the interactive setup wizard from project root
30+
uv run python wizard.py
31+
32+
# Or use the quickstart guide for step-by-step instructions
33+
# See quickstart.md for detailed walkthrough
34+
```
35+
36+
### Setup Documentation
37+
For detailed setup instructions and troubleshooting, see:
38+
- **[@quickstart.md](quickstart.md)**: Beginner-friendly step-by-step setup guide
39+
- **[@Docs/init-system.md](Docs/init-system.md)**: Complete initialization system architecture and design
40+
- **[@Docs/getting-started.md](Docs/getting-started.md)**: Technical quickstart with advanced configuration
41+
- **[@backends/advanced/SETUP_SCRIPTS.md](backends/advanced/SETUP_SCRIPTS.md)**: Setup scripts reference and usage examples
42+
- **[@backends/advanced/Docs/quickstart.md](backends/advanced/Docs/quickstart.md)**: Backend-specific setup guide
43+
44+
### Wizard Architecture
45+
The initialization system uses a **root orchestrator pattern**:
46+
- **`wizard.py`**: Root setup orchestrator for service selection and delegation
47+
- **`backends/advanced/init.py`**: Backend configuration wizard
48+
- **`extras/speaker-recognition/init.py`**: Speaker recognition setup
49+
- **Service setup scripts**: Individual setup for ASR services and OpenMemory MCP
50+
51+
Key features:
52+
- Interactive prompts with validation
53+
- API key masking and secure credential handling
54+
- Environment file generation with placeholders
55+
- HTTPS configuration with SSL certificate generation
56+
- Service status display and health checks
57+
- Automatic backup of existing configurations
58+
1659
## Development Commands
1760

1861
### Backend Development (Advanced Backend - Primary)

Docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ uv sync --group (whatever group you want to sync)
396396
## Troubleshooting
397397

398398
**Service Issues:**
399-
- Check logs: `docker compose logs friend-backend`
399+
- Check logs: `docker compose logs chronicle-backend`
400400
- Restart services: `docker compose restart`
401401
- View all services: `docker compose ps`
402402

Docs/init-system.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ curl http://localhost:8767/health
210210
docker compose logs [service-name]
211211

212212
# Backend logs
213-
cd backends/advanced && docker compose logs friend-backend
213+
cd backends/advanced && docker compose logs chronicle-backend
214214

215215
# Speaker Recognition logs
216216
cd extras/speaker-recognition && docker compose logs speaker-service

backends/advanced/Caddyfile.template

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ localhost TAILSCALE_IP {
1919

2020
# WebSocket endpoints - proxy to backend with upgrade support
2121
handle /ws* {
22-
reverse_proxy friend-backend:8000 {
22+
reverse_proxy chronicle-backend:8000 {
2323
# Caddy automatically handles WebSocket upgrades
2424
header_up X-Real-IP {remote_host}
2525
header_up X-Forwarded-For {remote_host}
@@ -29,31 +29,31 @@ localhost TAILSCALE_IP {
2929

3030
# API endpoints - proxy to backend
3131
handle /api/* {
32-
reverse_proxy friend-backend:8000
32+
reverse_proxy chronicle-backend:8000
3333
}
3434

3535
# Auth endpoints - proxy to backend
3636
handle /auth/* {
37-
reverse_proxy friend-backend:8000
37+
reverse_proxy chronicle-backend:8000
3838
}
3939

4040
# Health checks - proxy to backend
4141
handle /health {
42-
reverse_proxy friend-backend:8000
42+
reverse_proxy chronicle-backend:8000
4343
}
4444

4545
handle /readiness {
46-
reverse_proxy friend-backend:8000
46+
reverse_proxy chronicle-backend:8000
4747
}
4848

4949
# Users endpoints - proxy to backend
5050
handle /users/* {
51-
reverse_proxy friend-backend:8000
51+
reverse_proxy chronicle-backend:8000
5252
}
5353

5454
# Audio files - proxy to backend
5555
handle /audio/* {
56-
reverse_proxy friend-backend:8000
56+
reverse_proxy chronicle-backend:8000
5757
}
5858

5959
# Everything else - proxy to webui
@@ -68,36 +68,36 @@ localhost TAILSCALE_IP {
6868
#
6969
# # WebSocket endpoints
7070
# handle /ws* {
71-
# reverse_proxy friend-backend:8000
71+
# reverse_proxy chronicle-backend:8000
7272
# }
7373
#
7474
# # API endpoints
7575
# handle /api/* {
76-
# reverse_proxy friend-backend:8000
76+
# reverse_proxy chronicle-backend:8000
7777
# }
7878
#
7979
# # Auth endpoints
8080
# handle /auth/* {
81-
# reverse_proxy friend-backend:8000
81+
# reverse_proxy chronicle-backend:8000
8282
# }
8383
#
8484
# # Health checks
8585
# handle /health {
86-
# reverse_proxy friend-backend:8000
86+
# reverse_proxy chronicle-backend:8000
8787
# }
8888
#
8989
# handle /readiness {
90-
# reverse_proxy friend-backend:8000
90+
# reverse_proxy chronicle-backend:8000
9191
# }
9292
#
9393
# # Users endpoints
9494
# handle /users/* {
95-
# reverse_proxy friend-backend:8000
95+
# reverse_proxy chronicle-backend:8000
9696
# }
9797
#
9898
# # Audio files
9999
# handle /audio/* {
100-
# reverse_proxy friend-backend:8000
100+
# reverse_proxy chronicle-backend:8000
101101
# }
102102
#
103103
# # Everything else - webui

backends/advanced/Docs/HTTPS_SETUP.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ CORS_ORIGINS=https://localhost,https://127.0.0.1,https://100.83.66.30
8989
**Services started:**
9090
- ✅ nginx (ports 443/80) - SSL termination and proxy
9191
- ✅ webui (port 5173, internal) - Vite dev server
92-
-friend-backend (port 8000, internal)
92+
-chronicle-backend (port 8000, internal)
9393
- ✅ mongo, qdrant (databases)
9494

9595
**Access:** https://localhost/ or https://your-ip/
@@ -99,7 +99,7 @@ CORS_ORIGINS=https://localhost,https://127.0.0.1,https://100.83.66.30
9999
**Services started:**
100100
- ✅ nginx (ports 443/80) - but without SSL certificates
101101
- ✅ webui (port 5173, direct access) - Vite dev server
102-
-friend-backend (port 8000)
102+
-chronicle-backend (port 8000)
103103
- ✅ mongo, qdrant (databases)
104104

105105
**Access:** http://localhost:5173
@@ -169,7 +169,7 @@ docker compose restart nginx
169169
**Problem:** "Cross-Origin Request Blocked"
170170
**Solution:**
171171
1. Update CORS_ORIGINS in `.env` to include your HTTPS origin
172-
2. Restart backend: `docker compose restart friend-backend`
172+
2. Restart backend: `docker compose restart chronicle-backend`
173173

174174
### Microphone Access Denied
175175

@@ -192,7 +192,7 @@ docker compose restart nginx
192192
### Standard Setup
193193
- **3000** - HTTP (webui production)
194194
- **5173** - HTTP (webui development)
195-
- **8000** - HTTP (friend-backend)
195+
- **8000** - HTTP (chronicle-backend)
196196

197197
## Live Recording Feature
198198

backends/advanced/Docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ backends/advanced-backend/
189189

190190
- **Debug API**: `GET /api/debug/memory/*` endpoints show real-time system status
191191
- **Configuration**: Check `memory_config.yaml` for behavior controls
192-
- **Logs**: Check Docker logs with `docker compose logs friend-backend`
192+
- **Logs**: Check Docker logs with `docker compose logs chronicle-backend`
193193
- **Documentation**: Each doc file links to relevant code sections
194194

195195
---

backends/advanced/Docs/architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -585,7 +585,7 @@ stateDiagram-v2
585585
```mermaid
586586
graph LR
587587
subgraph "Docker Network"
588-
Backend[friend-backend<br/>uv + FastAPI]
588+
Backend[chronicle-backend<br/>uv + FastAPI]
589589
WebUI[webui<br/>React Dashboard]
590590
Proxy[nginx<br/>Load Balancer]
591591
Mongo[mongo:4.4.18<br/>Primary Database]
@@ -616,7 +616,7 @@ graph LR
616616

617617
### Container Specifications
618618

619-
#### Backend Container (`friend-backend`)
619+
#### Backend Container (`chronicle-backend`)
620620
- **Base**: Python 3.12 slim with uv package manager
621621
- **Dependencies**: FastAPI, WebSocket libraries, audio processing tools
622622
- **Volumes**: Audio chunk storage, debug directories

backends/advanced/Docs/auth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ curl -X POST "http://localhost:8000/auth/jwt/login" \
260260
#### 3. Admin User Creation
261261
```bash
262262
# Check logs for admin creation
263-
docker compose logs friend-backend | grep -i admin
263+
docker compose logs chronicle-backend | grep -i admin
264264

265265
# Verify environment variables
266266
echo $ADMIN_PASSWORD
@@ -272,7 +272,7 @@ echo $ADMIN_PASSWORD
272272
docker exec -it mongo-container mongosh chronicle
273273

274274
# View authentication logs
275-
docker compose logs friend-backend | grep -i auth
275+
docker compose logs chronicle-backend | grep -i auth
276276

277277
# Test API endpoints
278278
curl -H "Authorization: Bearer $TOKEN" http://localhost:8000/api/users/me

backends/advanced/Docs/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ uv sync --group (whatever group you want to sync)
394394
## Troubleshooting
395395

396396
**Service Issues:**
397-
- Check logs: `docker compose logs friend-backend`
397+
- Check logs: `docker compose logs chronicle-backend`
398398
- Restart services: `docker compose restart`
399399
- View all services: `docker compose ps`
400400

0 commit comments

Comments
 (0)