MiroTalk P2P

MiroTalk P2P is a browser‑first, peer‑to‑peer video conferencing stack that eliminates the need for heavyweight media servers. Built on WebRTC, it delivers 8 K video at 60 fps while keeping latency minimal by routing media directly between participants. The application exposes a rich set of APIs for authentication, room management, and media control, making it an attractive platform for developers who need a lightweight, self‑hosted solution that can be embedded or extended.

Key Features

• Pure P2P media routing – no media relay servers, reducing bandwidth costs and improving QoS.
• OpenID Connect (OIDC) & JWT – secure, token‑based authentication that integrates with existing identity providers.
• Room and host protection – password, JWT‑driven ACLs, and optional moderation controls.
• High‑resolution media – 8 K video, 60 fps, and support for front/rear mobile cameras.
• Rich media controls – screen sharing, PiP, snapshots, and file transfer via WebRTC data channels.
• Developer hooks – REST endpoints for room lifecycle, webhook support for events (join/leave, recording), and a WebSocket API for real‑time messaging.

Technical Stack

The core server is lightweight: it only orchestrates signaling (SDP exchange) and manages user metadata. All media traffic bypasses the server, ensuring that scaling is achieved by adding more stateless signaling instances rather than media relays.

Core Capabilities

• Signaling API – /api/sdp for exchanging offers/answers, ICE candidates.
• Room API – CRUD operations (POST /rooms, GET /rooms/:id) with optional password or JWT protection.
• WebSocket Events – user.join, user.leave, chat.message, file.share.
• Webhook Hooks – configurable URLs for room lifecycle events, enabling CI/CD pipelines or external monitoring.
• Recording Integration – built‑in screen/audio capture that can be streamed to Recall.ai or stored locally.

Deployment & Infrastructure

• Self‑hosted – deploy via Docker Compose or Helm chart; requires only a modern Linux host with outbound HTTPS.
• Scalability – the signaling layer can be horizontally scaled behind a load balancer; WebRTC traffic remains peer‑to‑peer.
• PWA Support – users can install the web app on mobile/desktop, ensuring a native‑like experience without native builds.
• Resource Footprint – a single container consumes < 200 MB RAM and 10 Mbps bandwidth for signaling.

Integration & Extensibility

• Plugin System – developers can inject custom UI components via a hook system; the core exposes onMount and beforeSend events.
• Webhooks – expose external services to room events (e.g., analytics, billing).
• Custom Auth – swap OIDC provider or extend JWT claims to add role‑based access.
• SDK – a lightweight JavaScript SDK simplifies embedding MiroTalk into existing applications.

Developer Experience

• Configuration – environment variables (MIROTALK_JWT_SECRET, OIDC_PROVIDER_URL) control all auth and room policies.
• Documentation – a comprehensive README, API reference, and example integration guides are available on GitHub.
• Community – active Discord channel for support, feature requests, and code contributions; the project is AGPL‑v3 licensed, encouraging open collaboration.

Use Cases

• Enterprise Collaboration – embed a secure video room inside an intranet portal, leveraging existing SSO.
• Education Platforms – provide lightweight classrooms with screen sharing and chat, all hosted on campus servers.
• IoT/Remote Monitoring – stream high‑resolution camera feeds between devices without central servers.
• Event Hosting – create unlimited rooms for webinars or meetups with minimal infrastructure.

Advantages

• Performance – direct P2P paths eliminate media server bottlenecks, yielding lower latency and higher video quality.
• Cost‑effective – no media server licensing; only signaling infrastructure is required.
• Flexibility – AGPL‑v3 licensing allows full source modification, while a commercial license is available for proprietary use.
• Security – token‑based auth, optional room passwords, and encrypted media streams ensure privacy.

In short, MiroTalk P2P offers developers a turnkey, high‑performance video conferencing framework that can be fully self‑hosted and deeply customized to fit a wide range of modern application scenarios.