kashifsaeed79 / web-chat

🚀 WebRTC - P2P - Simple, Secure, Fast Real-Time Video Conferences Up to 4k and 60fps, compatible with all browsers and platforms.

MiroTalk P2P

Free WebRTC - P2P - Simple, Secure, Fast Real-Time Video Conferences Up to 4k and 60fps, compatible with all browsers and platforms.

---

---

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 YT Embed 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)

Presentation

MiroTalk presentation

Start videoconference

• 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 join directly to 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	user name
  audio	boolean	enable / disable
  video	boolean	enable / disable
  notify	boolean	enable / disable

Embed a meeting

Embedding a meeting into a service or app using an iframe.

<iframe
    allow="camera; microphone; fullscreen; display-capture; autoplay"
    src="https://mirotalk.up.railway.app/newcall"
    style="height: 100%; width: 100%; border: 0px;"
></iframe>

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.

Rest 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.

Https

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

Live Demo

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

https://mirotalk.herokuapp.com/

If you want to deploy a MiroTalk P2P instance on your dedicated server, or for other needs, don't hesitate to contact us at [e-mail].

Credits

• ianramzy (html template)
• vasanthv (webrtc-logic)
• fabric.js (whiteboard)

Contributing

• Contributions are welcome and greatly appreciated!
• Just run before npm run lint

Discussions and support

• For discussions, help & support, join with us on Discord

License

MiroTalk is free and can be modified and forked. But the conditions of the AGPLv3 (GNU Affero General Public License v3.0) need to be respected. In particular modifications need to be free as well and made available to the public. Get a quick overview of the license at Choose an open source license.

For a MiroTalk license under conditions other than AGPLv3, please contact us at [e-mail].

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

MiroTalk SFU

Try also MiroTalk SFU, the difference between the two projects you can found here.