RamboRogers/mirotalk

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

---

p2p.mirotalk.com

---

---

Features

• Is 100% Free - Open Source - Self Hosted and PWA!
• No download, plug-in, or login required, entirely browser-based
• Unlimited number of conference rooms without call time limitation
• Translated in 133 languages
• Possibility to Password protect 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 with detect speaking and volume indicator
• Screen Sharing to present documents, slides, and more...
• File Sharing (with drag-and-drop), 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 to show you feeling, private messages, Markdown support, possibility to Save the conversations, and many more
• Speech recognition to send the speeches
• Advance collaborative whiteboard for the teachers
• Share any YT Embed video, video mp4, webm, ogg and audio mp3 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)
• Slack API integration
• Sentry error reporting

About

• Presentation

• Video

Start videoconference

• Open https://p2p.mirotalk.com/newcall or
• 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://p2p.mirotalk.com/join?room=test&name=mirotalk&audio=0&video=0&screen=0&notify=0

• https://mirotalk.up.railway.app/join?room=test&name=mirotalk&audio=0&video=0&screen=0&notify=0

• https://mirotalk.herokuapp.com/join?room=test&name=mirotalk&audio=0&video=0&screen=0&notify=0

  Params	Type	Description
  room	string	room Id
  name	string	user name
  audio	boolean	audio stream
  video	boolean	video stream
  screen	boolean	screen stream
  notify	boolean	welcome message

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.herokuapp.com/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 versions 12.X, 14.X and 16.X.

# clone this repo
$ git clone https://github.com/miroslavpejic85/mirotalk.git
# go to mirotalk dir
$ cd mirotalk
# copy .env.template to .env (edit it according to your needs)
$ 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/
• Repository docker hub: https://hub.docker.com/r/mirotalk/p2p

# copy .env.template to .env (edit it according to your needs)
$ cp .env.template .env
# Get official image from Docker Hub
$ docker pull mirotalk/p2p:latest
# create and start containers
$ docker-compose up # -d
# to stop and remove resources
$ docker-compose down

• Open http://localhost:3000 in browser

Ngrok - Https

You can start videoconferencing directly from your Local PC, and be reachable from any device outside your network, simply by reading these documentation, or expose it directly on HTTPS

Stun & Turn

You can Check here, if you are full covered by the MiroTalk default IceServers (Stun & Turn).

If not, you can change it in the .env file and test it by the URL eg:

https://p2p.mirotalk.com//test?iceServers=[{"urls":"stun:stun.l.google.com:19302"},{"urls":"turn:openrelay.metered.ca:443","username":"openrelayproject","credential":"openrelayproject"}]

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://p2p.mirotalk.com/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 live & heroku.

Hetzner

This application is running for demonstration purposes on Hetzner, one of the best cloud providers and dedicated root servers.

Use this link to receive €⁠20 IN CLOUD CREDITS on Hetzner.

If you need help to deploy MiroTalk P2P instance on your dedicated cloud server, or for other needs, don't hesitate to contact us at p2p.mirotalk@gmail.com

Live Demos

https://p2p.mirotalk.com

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 p2p.mirotalk@gmail.com.

Self Hosting

To Self-Host MiroTalk P2P on Your dedicated Server, read this documentation.

Credits

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

Contributing

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

Questions, Discussions and support

• For questions, 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 license.mirotalk@gmail.com or buy directly via CodeCanyon.

Support the project

Do you find MiroTalk useful?

Support the project by becoming a backer or 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.