niom-turn/docs/index.md

niom-turn Docs

Short entry point for the documentation.

Start here

• deployment.md – systemd deployment, TLS, NAT/advertised_ip, debugging.
• config/runtime.md – appsettings.json schema and defaults.

Protocol flows

• architecture/turn_end_to_end_flow.md – Happy path: Allocate → (Permission) → Send/ChannelData → return path.
• architecture/turn_rest_credentials.md – TURN REST Credentials + CLI.

Architecture

• architecture/data_flow.md – components and data flow.
• tcp_tls_data_plane.md – stream framing and TCP/TLS data plane.

Testing

• testing.md – test overview and commands.

Notes & specs

• mvp_gaps_and_rfc_notes.md – MVP gaps and RFC notes.
• specs/rfc5389-stun.txt – STUN RFC (text copy).
• specs/rfc5766-turn.txt – TURN RFC (text copy).