MiroTalk P2P

Free WebRTC browser-based video calls, chat, and screen sharing, using google Stun and numb Turn. MiroTalk provides video quality and latency not available with traditional technology.

Open the app with the following supported browsers and many more.

https://mirotalk.herokuapp.com/

Features

Is 100% Free - Open Source - Self-hosted
No download, plug-in, or login required, entirely browser-based
Unlimited number of conference rooms without call time limitation
Possibility to Lock/Unlock the Room for the meeting
Desktop and Mobile compatible
Optimized Room URL Sharing (share it to your participants, wait for them to join)
Webcam Streaming (Front - Rear for mobile)
Audio Streaming crystal clear + detect speacking and indicator
Screen Sharing to present documents, slides, and more...
File Sharing, share any files to your participants in the room
Select Audio Input - Output && Video source
Ability to set video quality up to 4K and 60 FPS
Recording your Screen, Audio and Video
Snapshot the video frame and save it as image png
Chat with Emoji Picker & Private messages & Save the conversations
Speech recognition to send the speeches
Advance collaborative whiteboard for the teachers
Share any YouTube video in real-time
Full-Screen Mode on mouse click on the Video element
Possibility to Change UI Themes
Right-click on the Video elements for more options
Direct peer-to-peer connection ensures the lowest latency thanks to WebRTC
Supports REST API (Application Programming Interface)

Demo

Open https://mirotalk.up.railway.app/newcall or https://mirotalk.herokuapp.com/newcall
Pick your Room name and Join
Allow using the camera and microphone
Share the Room URL and Wait for someone to join for the video conference

Direct join

You can also join directly to your room by going to:
https://mirotalk.up.railway.app/join?room=test&name=mirotalk&audio=0&video=0&notify=0
https://mirotalk.herokuapp.com/join?room=test&name=mirotalk&audio=0&video=0&notify=0

Params Type Description

room string room Id

name string your name

audio boolean enable / disable

video boolean enable / disable

notify boolean enable / disable

Params	Type	Description
room	string	room Id
name	string	your name
audio	boolean	enable / disable
video	boolean	enable / disable
notify	boolean	enable / disable

Quick start

You will need to have Node.js installed, this project has been tested with Node version 12.X and 14.X

# clone this repo
$ git clone https://github.com/miroslavpejic85/mirotalk.git
# go to mirotalk dir
$ cd mirotalk
# copy .env.template to .env
$ cp .env.template .env
# install dependencies
$ npm install
# start the server
$ npm start

Open http://localhost:3000 in browser

Docker

Install docker engine: https://docs.docker.com/engine/install/
Install docker compose: https://docs.docker.com/compose/install/

# copy .env.template to .env
$ cp .env.template .env
# build or rebuild services
$ docker-compose build
# create and start containers
$ docker-compose up # -d
# stop and remove resources
$ docker-compose down

Open http://localhost:3000 in browser

Setup Turn

Recommended, for more info about the Turn check out here. Just edit this part on your .env.

API

# The response will give you a entrypoint / Room URL for your meeting, where authorization: API_KEY_SECRET.
$ curl -X POST "http://localhost:3000/api/v1/meeting" -H "authorization: mirotalk_default_secret" -H "Content-Type: application/json"
$ curl -X POST "https://mirotalk.up.railway.app/api/v1/meeting" -H "authorization: mirotalk_default_secret" -H "Content-Type: application/json"
$ curl -X POST "https://mirotalk.herokuapp.com/api/v1/meeting" -H "authorization: mirotalk_default_secret" -H "Content-Type: application/json"

API Documentation

The API documentation uses swagger at http://localhost:3000/api/v1/docs. Or check it out on railway & heroku.

Live demo

If you want MiroTalk to be reachable from the outside of your local network, you can use a service like ngrok (by editing the Ngrok part on .env file) or expose it directly on HTTPS or deploy it on: