📖 Documentation
Complete technical documentation for WebRTC platform
WebRTC 项目完整技术文档
Quick Navigation
Getting Started
Prerequisites, local development, Docker deployment
Signaling Protocol
WebSocket message formats, room management, heartbeat mechanism
Deployment Guide
HTTPS/WSS, TURN server, performance optimization
Troubleshooting
Connection issues, media problems, deployment solutions
API Reference
Environment variables, ports, ICE server configuration
Documentation Structure
This project follows Spec-Driven Development (SDD). All implementation is driven by specifications.
User & Developer Guides
| Document | EN | ZH | Description |
|---|---|---|---|
| Guide | English | 中文 | Architecture, implementation details, code walkthrough |
| Deployment | English | 中文 | Docker, HTTPS/TURN setup, production deployment |
| Signaling | English | 中文 | WebSocket protocol and message specifications |
| API Reference | English | 中文 | Configuration options, environment variables, endpoints |
| Troubleshooting | English | 中文 | Common issues and solutions |
Specification Documents (Single Source of Truth)
The /specs directory is the authoritative source. Specs drive all development.
| Spec | Path | Description |
|---|---|---|
| Product Spec | /specs/product/ |
Feature definitions and acceptance criteria |
| RFC Documents | /specs/rfc/ |
Technical design and architecture decisions |
| API Spec | /specs/api/ |
OpenAPI 3.0 signaling specification |
| Database Spec | /specs/db/ |
In-memory data structure definitions |
| Testing Spec | /specs/testing/ |
BDD test specifications and acceptance criteria |
Learning Paths
🔰 Beginners
If you’re new to WebRTC, we recommend reading in this order:
- Getting Started — Get the project running
- Signaling Protocol Overview — Understand how browsers establish connections
- Frontend State Machine — Understand client connection state management
🛠️ Developers
If you want to extend or modify the project:
- Architecture Overview — Overall system architecture
- RFC-0001: Signaling Server — Server design decisions
- RFC-0002: Frontend Architecture — Client module design
- Product Spec — Feature definitions and acceptance criteria
🏭 DevOps Engineers
If you need to deploy to production:
- Deployment Guide — Docker deployment and configuration
- API Configuration Reference — All environment variables
- Troubleshooting — Common deployment issues
Resources
External Links
| Resource | Link | Description |
|---|---|---|
| GitHub Repository | LessUp/webrtc | Source code, Issues, PRs |
| Changelog | CHANGELOG.md | Version history and release notes |
| Contributing | CONTRIBUTING.md | Development workflow and guidelines |
| Roadmap | ROADMAP.md | Future development plans |
WebRTC Learning Resources
💡 Need Help?
- Found a bug? Open an issue on GitHub Issues
- Have a feature request? Check the Roadmap or submit a Feature Request
- Want to contribute? Read the Contributing Guidelines
Last Updated / 最后更新: 2026-04-22 | Version / 版本: v1.0.0