This project provides a feature-rich WebRTC-based peer-to-peer media streaming and file transfer tool for web applications. It targets developers and users needing robust, private-deployable solutions for file sharing, screen sharing, video calls, and live streaming, offering high local network speeds and extensive customization.

How It Works

The tool leverages WebRTC for direct peer-to-peer communication, enabling fragmented transmission of files and real-time media streams. It supports both HTTP and HTTPS modes, with HTTPS required for advanced features like audio/video and screen sharing. The architecture includes a backend API and socket services, with optional integrations for databases, admin panels, cloud storage, and AI chat.

Quick Start & Requirements

• Install: Node.js 14.21.x or above, and npm.
• Dependencies: npm install in the svr/ directory.
• Run: npm run http-api and npm run http-socket (for HTTP) or npm run https-api and npm run https-socket (for HTTPS).
• Docker: docker-compose --profile=http up -d (V1) or docker compose --profile=http up -d (V2).
• Docs: Document

Highlighted Details

• Supports fragmented transmission and large file transfers.
• Achieves over 70 MB/s in local networks.
• Offers zero-latency screen sharing, audio/video calls, and live streaming.
• Includes features like password-protected rooms, drag-and-drop, web file preview, and AI chat integration.
• Provides an admin panel with real-time execution logs.

Maintenance & Community

• Developed since 2020, with updates noted up to 2023.
• QQ Group: 624214498

Licensing & Compatibility

• MIT License.
• Permissive license suitable for commercial use and closed-source linking.

Limitations & Caveats

WAN usage requires configuring a TURN server. Some optional features like WeChat notifications and specific cloud storage integrations require additional setup and API keys.