Skip to content

πŸš€ Powered by WebRTC, Real-time video call, chat room and screen sharing entirely browser based πŸš€

License

Notifications You must be signed in to change notification settings

sbignell/mirotalk

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

MiroTalk P2P

πŸš€ A free WebRTC browser-based video call, chat and screen sharing πŸš€


Author License: AGPLv3 Support Repo Link Digital Ocean Code style: prettier Gitter Discord

Powered by WebRTC 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 & many more...

browsers


mirotalk

Features

  • Is 100% Free and Open Source
  • 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 them to join)
  • Webcam Streaming (Front - Rear for mobile)
  • Audio Streaming crystal clear
  • 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 adapt the FPS
  • Recording your Screen, Audio and Video
  • Chat with Emoji Picker & Private messages & Save the conversations
  • 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

Room join

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

Docker

# 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

API

# The response will give you a entrypoint / Room URL for your meeting, where authorization: API_KEY_SECRET.
$ curl -X POST "https://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 https://localhost:3000/api/v1/docs. Or check it out on railway & heroku.


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:


Deploy on Heroku

demo https://mirotalk.herokuapp.com/

heroku-qr


Deploy on Railway

demo https://mirotalk.up.railway.app/

railway-qr


Credits

Many Thanks to:

  • ianramzy (html template)
  • vasanthv (webrtc)
  • Sajad (chat)
  • fabric.js (whiteboard)
  • fmeringdal (rest api)

From where I took inspiration for this project. ❀️

Contributing

  • Pull Requests are very welcome! πŸ™‚

  • Just run prettier on all of your PRs before submitting, this can be done with the following comand: npm run lint

  • For communication we use gitter or discord chats which can be found here:

Gitter Discord

License

AGPLv3


MiroTalk SFU

You can try also MiroTalk SFU, The difference between the 2 projects you can found here.


Made with ❀️ by Miroslav Pejic

About

πŸš€ Powered by WebRTC, Real-time video call, chat room and screen sharing entirely browser based πŸš€

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 53.2%
  • HTML 23.3%
  • CSS 23.0%
  • PHP 0.2%
  • Python 0.1%
  • Shell 0.1%
  • Dockerfile 0.1%