MiroTalk P2P: Simple, Secure, and Fast WebRTC Video Conferencing

Introduction

MiroTalk P2P is a robust, free, and open-source WebRTC solution designed for simple, secure, and fast real-time video conferences. Leveraging peer-to-peer technology, it supports high-quality video up to 8K resolution and 60 frames per second, ensuring a smooth experience across all major browsers and platforms. This project empowers users with a comprehensive suite of features, including screen sharing, file sharing, a collaborative whiteboard, and even integrated ChatGPT capabilities, making it a versatile tool for various communication needs.

Installation

Getting MiroTalk P2P up and running is straightforward, whether you prefer a Node.js setup or Docker.

Quick Start with Node.js

Ensure you have Node.js installed on your system. For more details, refer to the Node.js installation guide.

Clone the repository:

git clone https://github.com/miroslavpejic85/mirotalk.git

Navigate into the project directory:
```
cd mirotalk
```

Copy the environment template and configure it:

cp .env.template .env
cp app/src/config.template.js app/src/config.js

Install dependencies:
```
npm install
```
Start the server:
```
npm start
```

Open your browser to http://localhost:3000 to access MiroTalk P2P.

Docker Installation

For a containerized setup, Docker offers an easy deployment. Ensure you have Docker Engine and Docker Compose installed.

Clone the repository:

git clone https://github.com/miroslavpejic85/mirotalk.git

Navigate into the project directory:
```
cd mirotalk
```

Copy the necessary configuration files:

cp .env.template .env
cp app/src/config.template.js app/src/config.js
cp docker-compose.template.yml docker-compose.yml

Pull the official Docker image:
```
docker pull mirotalk/p2p:latest
```
Create and start containers:
```
docker-compose up -d
```

Access MiroTalk P2P at http://localhost:3000.

Examples

MiroTalk P2P is designed for quick and easy conference setup.

Start a Videoconference

Open MiroTalk P2P in your browser, for example, via the live demo.
Choose a room name and click "Join Room".
Grant camera and microphone access when prompted.
Share the room URL with participants and start your video conference.

Direct Join

You can also directly join a room using a parameterized URL, allowing for pre-configured settings.

Example: https://p2p.mirotalk.com/join?room=test&name=mirotalk&avatar=0&audio=0&video=0&screen=0&chat=0&hide=0&notify=0

Why Use MiroTalk P2P?

MiroTalk P2P stands out as an excellent choice for real-time communication due to several compelling reasons:

Free and Open Source: It's 100% free, open-source under the AGPLv3 license, and supports self-hosting, giving you full control and transparency.
High-Quality Performance: Experience crystal-clear audio and video up to 8K resolution and 60 FPS, powered by WebRTC for direct peer-to-peer connections and low latency.
Feature-Rich: Beyond basic video calls, it offers screen sharing, file sharing with drag-and-drop, a collaborative whiteboard, chat with Markdown and emoji support, speech recognition, push-to-talk, and even ChatGPT integration for enhanced interaction.
Security and Privacy: Features like host protection, room password protection, and JWT.io for credential management ensure secure communication. Its P2P nature minimizes reliance on central servers for media routing.
Broad Compatibility: Compatible with all major desktop and mobile browsers, it requires no downloads, plugins, or logins, making it incredibly accessible.
Customization and Integration: Supports customizable UI themes, offers a REST API, and integrates with platforms like Mattermost and Slack, providing flexibility for various use cases.