Files
unraid-docker-manager/.planning/ROADMAP.md
T
Lucas Berger af5397306d docs(02): complete docker integration phase
Phase 2 complete with 2 plans:
- 02-01: Docker socket configuration
- 02-02: Docker query workflow

Delivers: REQ-02 (container status queries)
- "status" returns container summary
- "status <name>" returns detailed container info
- Fuzzy matching for container names

Ready for Phase 3: Container Actions
2026-01-29 14:43:13 -05:00

104 lines
2.6 KiB
Markdown

# Roadmap — Unraid Docker Manager v1.0
## Milestone: v1.0 — Conversational Docker Control
### Phase 1: Foundation
**Goal:** Basic Telegram ↔ n8n communication working
- Set up n8n workflow with Telegram trigger
- Configure Telegram bot via BotFather
- Echo messages back to verify round-trip
- Implement user ID verification (single-user auth)
**Delivers:** REQ-01 (send/receive messages), REQ-09 (user ID auth)
**Plans:** 2 plans
Plans:
- [x] 01-01-PLAN.md — Create Telegram bot and n8n workflow
- [x] 01-02-PLAN.md — Verify echo and authentication
**Status:** ✅ Complete (2026-01-28)
---
### Phase 2: Docker Integration
**Goal:** n8n can query Docker and return container info
- Connect n8n to Unraid Docker socket
- Implement container listing endpoint
- Parse container status (running, stopped, health)
- Format status responses for Telegram
**Delivers:** REQ-02 (container status queries)
**Plans:** 2 plans
Plans:
- [x] 02-01-PLAN.md — Configure n8n container for Docker socket access
- [x] 02-02-PLAN.md — Add Docker query workflow with container matching
**Status:** ✅ Complete (2026-01-29)
---
### Phase 3: Container Actions
**Goal:** Control containers through conversation
- Implement start container by name
- Implement stop container by name
- Implement restart container by name
- Implement update container (pull + recreate)
- Handle fuzzy name matching ("plex" → "plex-server")
**Delivers:** REQ-03, REQ-04, REQ-05, REQ-06
**Status:** 🔲 Not started
---
### Phase 4: Logs & Intelligence
**Goal:** View logs and answer conversational questions
- Implement log retrieval with configurable line count
- Integrate Claude API for natural language understanding
- Parse user intent from conversational messages
- Implement resource queries ("what's using most memory?")
**Delivers:** REQ-07 (logs), REQ-08 (conversational queries)
**Status:** 🔲 Not started
---
### Phase 5: Polish & Deploy
**Goal:** Production-ready deployment on Unraid
- Error handling and user-friendly error messages
- Create Docker container for any custom components
- Write deployment instructions for Unraid
- End-to-end testing of all scenarios
**Delivers:** Production readiness
**Status:** 🔲 Not started
---
## Requirements Mapping
| REQ | Description | Phase |
|-----|-------------|-------|
| REQ-01 | Send/receive messages | 1 |
| REQ-02 | Container status queries | 2 |
| REQ-03 | Start container | 3 |
| REQ-04 | Stop container | 3 |
| REQ-05 | Restart container | 3 |
| REQ-06 | Update container | 3 |
| REQ-07 | View logs (configurable lines) | 4 |
| REQ-08 | Conversational queries | 4 |
| REQ-09 | User ID authentication | 1 |
---
*Created: 2026-01-28*