| Document | Description |
|---|---|
| Getting Started | Build, run, and test the server in 5 minutes |
| Architecture | System overview with diagrams and package map |
| Design | Design principles, concurrency model, and key decisions |
| Document | Description |
|---|---|
| RTMP Protocol Reference | Wire-level protocol details: chunks, headers, AMF0, commands |
| SRT Protocol Reference | SRT ingest: handshake, reliability, MPEG-TS conversion |
| Implementation Guide | Code walkthrough: connection lifecycle, data structures, media flow |
| Testing Guide | How to run tests, golden vectors, manual interop testing |
| Definition of Done | Feature completion checklist and verification commands |
| Document | Description |
|---|---|
| FLV Recording | Automatic stream recording to FLV files |
| RTMP Relay | Multi-subscriber relay with late-join support |
| Document | Description |
|---|---|
| Recording Quick Ref | Recording commands and troubleshooting |
| Media Logging Quick Ref | Media packet logging and codec detection |
| Wireshark Guide | Capture and analyze RTMP traffic |
| Document | Description |
|---|---|
| ../README.md | Project overview and feature summary |
| ../quick-start.md | Original quick-start guide with OBS setup |
| Document | Description |
|---|---|
| ../specs/001-rtmp-server-implementation/spec.md | Core server specification |
| ../specs/001-rtmp-server-implementation/contracts/ | Wire format contracts (AMF0, chunking, commands, control, handshake, media) |
| ../specs/004-token-auth/spec.md | Token-based authentication specification |
Historical fix notes, debugging sessions, and completed feature implementation docs are preserved in the archived/ folder for reference.