WebRTC Documentation
Welcome to the WebRTC project documentation. This project follows Spec-Driven Development (SDD).
Table of Contents
- Documentation Home — 文档索引（中文）
- Quick Navigation
- Specifications (Single Source of Truth)
- User & Developer Guides
- Language Selection
- External Resources
Quick Navigation
Getting Started
Quick start guide with architecture overview and implementation details
Signaling Protocol
WebSocket message formats, room management, and heartbeat mechanism
Deployment Guide
Docker deployment, HTTPS/WSS setup, and production best practices
Troubleshooting
Common issues and solutions for connection, media, and deployment problems
API Reference
Environment variables, configuration options, and endpoints
Specifications (Single Source of Truth)
The /specs directory is the authoritative source. Specs drive all development.
| Spec | Description |
|---|---|
| Product Spec | Feature definitions and acceptance criteria |
| RFC-0001 | Signaling server architecture |
| RFC-0002 | Frontend architecture and module design |
| API Spec | OpenAPI 3.0 signaling specification |
| DB Schema | In-memory data structures |
| Testing Spec | BDD test specifications |
User & Developer Guides
Complete documentation available in English and 简体中文.
Getting Started
| Document | EN | ZH | Description |
|---|---|---|---|
| Guide | English | 中文 | Architecture, implementation details, code walkthrough |
| Deployment | English | 中文 | Docker, HTTPS/TURN setup, production deployment |
Reference
| Document | EN | ZH | Description |
|---|---|---|---|
| Signaling Protocol | English | 中文 | WebSocket protocol and message specifications |
| API Reference | English | 中文 | Configuration options, environment variables, endpoints |
Troubleshooting
| Document | EN | ZH | Description |
|---|---|---|---|
| Troubleshooting | English | 中文 | Common issues and solutions |
Language Selection
This documentation is available in multiple languages:
External Resources
| Resource | Link | Description |
|---|---|---|
| GitHub Repository | LessUp/webrtc | Source code |
| Changelog | CHANGELOG.md | Version history |
| Contributing | CONTRIBUTING.md | Development workflow |
| Roadmap | ROADMAP.md | Future plans |
Need Help?
- Found a bug? Open an issue
- Have a question? Check the Troubleshooting Guide
- Want to contribute? See Contributing Guidelines
Last Updated: 2026-04-17 | Version: v1.0.0