Christian Nennemann
2e081ead8e
Rename all project references from quicproquo/qpq to quicprochat/qpc across documentation, Docker configuration, CI workflows, packaging scripts, operational configs, and build tooling. - Docker: crate paths, binary names, user/group, data dirs, env vars - CI: workflow crate references, binary names, artifact names - Docs: all markdown files under docs/, SDK READMEs, book.toml - Packaging: OpenWrt Makefile, init script, UCI config (file renames) - Scripts: justfile, dev-shell, screenshot, cross-compile, ai_team - Operations: Prometheus config, alert rules, Grafana dashboard - Config: .env.example (QPQ_* → QPC_*), CODEOWNERS paths - Top-level: README, CONTRIBUTING, ROADMAP, CLAUDE.md
4.2 KiB
4.2 KiB
Summary
Why quicprochat?
Getting Started
- Prerequisites
- Building from Source
- Running the Server
- Running the Client
- REPL Command Reference
- Rich Messaging
- File Transfer
- TLS in quicprochat
- Certificate Lifecycle and CA-Signed TLS
- Docker Deployment
- Mesh Networking
- Demo Walkthrough: Alice and Bob
Architecture
- Architecture Overview
- Protocol Stack
- Crate Responsibilities
- Service Architecture
- End-to-End Data Flow
Protocol Deep Dives
- Protocol Layers Overview
- QUIC + TLS 1.3
- Protobuf Framing
- MLS (RFC 9420)
- Hybrid KEM: X25519 + ML-KEM-768
Client SDKs
- SDK Overview
- Wire Format Reference
- Rust SDK
- Go SDK
- TypeScript SDK and Browser Demo
- C FFI Bindings
- WASM Integration
Cryptographic Properties
- Cryptography Overview
- Ed25519 Identity Keys
- Key Lifecycle and Zeroization
- Forward Secrecy
- Post-Compromise Security
- Post-Quantum Readiness
- Threat Model
Wire Format Reference
Design Rationale
- Design Decisions Overview
- ADR-002: Cap'n Proto over MessagePack
- ADR-004: MLS-Unaware Delivery Service
- ADR-005: Single-Use KeyPackages
- ADR-006: SDK-First Adoption (No REST Gateway)
Implementation Internals
- GroupMember Lifecycle
- KeyPackage Exchange Flow
- Delivery Service Internals
- Authentication Service Internals
- Storage Backend
- Server Hooks (Plugin System)
Roadmap
- Milestone Tracker
- Phase 2 + M4-M6 Roadmap
- Production Readiness WBS
- Auth, Devices, and Tokens
- 1:1 Channel Design
- Future Research Directions
- Full Roadmap (Phases 1-8)