Awesome Open Source
Awesome Open Source

MiroTalk SFU

Free WebRTC - SFU - Simple, Secure, Scalable Real-Time Video Conferences Up to 4k, compatible with all browsers and platforms.


sfu.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
  • Desktop and Mobile compatible
  • Translated in 133 languages
  • Optimized Room URL Sharing (share it to your participants, wait for them to join)
  • Possibility to Password protect the Room for the meeting
  • Lobby mode lets you protect your meeting by only allowing people to enter after a formal approval by a moderator.
  • Webcam Streaming up to 4K quality (Front - Rear for mobile)
  • Echo cancellation and noise suppression that makes your audio crystal clear
  • Screen Sharing to present documents, slides, and more ...
  • File Sharing (with drag-and-drop), share any files to your participants in the room
  • Take a snapshot from the video frame(screen/cam) to save it as an image on your device.
  • Chat with Emoji Picker to show you feeling, private messages, Markdown support, possibility to Save the conversations, and many more.
  • Speech recognition, execute the app features simply with your voice.
  • Advance collaborative whiteboard for the teachers
  • Select Microphone - Speaker and Video source
  • Recording your Screen, Audio, or Video
  • Share any YouTube video in real-time to your participants
  • Share any mp4, webm, ogg video in real-time to your participants with possibility to download it
  • Full-Screen Mode on mouse click on the Video element
  • Possibility to Change UI Themes
  • Possibility to protect your Host with username and password (default disabled)
  • Supports REST API (Application Programming Interface)
  • Slack API integration
  • Sentry error reporting
About
Direct Join
Embed a meeting

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

<iframe
    allow="camera; microphone; fullscreen; display-capture; autoplay"
    src="https://sfu.mirotalk.com/newroom"
    style="height: 100%; width: 100%; border: 0px;"
></iframe>
Quick Start
  • You will need to have NodeJS and all requirements installed, this project has been tested with Node versions 12.X - 14.X - 16.X.

  • Requirements install example for Ubuntu 20.04

# Gcc g++ make
$ apt-get update
$ apt-get install -y build-essential
# Python 3.8 and pip
$ DEBIAN_FRONTEND=noninteractive apt-get install -y tzdata
$ apt install -y software-properties-common
$ add-apt-repository ppa:deadsnakes/ppa
$ apt update
$ apt install -y python3.8 python3-pip
# NodeJS 16.X and npm
$ apt install -y curl dirmngr apt-transport-https lsb-release ca-certificates
$ curl -sL https://deb.nodesource.com/setup_16.x | bash -
$ apt-get install -y nodejs
$ npm install -g [email protected]
  • Start the server
# Clone this repo
$ git clone https://github.com/miroslavpejic85/mirotalksfu.git
# Go to to dir mirotalksfu
$ cd mirotalksfu
# Copy app/src/config.template.js in app/src/config.js and edit it if needed
$ cp app/src/config.template.js app/src/config.js
# Install dependencies - be patient, the first time will take a few minutes, in the meantime have a good coffee ;)
$ npm install
# Start the server
$ npm start
# If you want to start the server on a different port than the default use an env var
$ PORT=3011 npm start
Docker

docker

# Copy app/src/config.template.js in app/src/config.js IMPORTANT (edit it according to your needs)
$ cp app/src/config.template.js app/src/config.js
# Copy docker-compose.template.yml in docker-compose.yml and edit it if needed
$ cp docker-compose.template.yml docker-compose.yml
# (Optional) Get official image from Docker Hub
$ docker-compose pull
# Create and start containers
$ docker-compose up # -d
# To stop and remove resources
$ docker-compose down
Ngrok - Https

You can start videoconferencing directly from your Local PC, and be reachable from any device outside your network, simply by following these documentation.

Self Hosting

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

Notes
  • Run the project on a Linux or Mac system as the mediasoup installation could have issues on Windows.
Rest API
# The response will give you a entrypoint / Room URL for your meeting.
$ curl -X POST "http://localhost:3010/api/v1/meeting" -H "authorization: mirotalksfu_default_secret" -H "Content-Type: application/json"
$ curl -X POST "https://sfu.mirotalk.com/api/v1/meeting" -H "authorization: mirotalksfu_default_secret" -H "Content-Type: application/json"
# The response will give you a entrypoint / URL for the direct join to the meeting.
$ curl -X POST "http://localhost:3010/api/v1/join" -H "authorization: mirotalksfu_default_secret" -H "Content-Type: application/json" --data '{"room":"test","name":"mirotalksfu","audio":"0","video":"0","screen":"0","notify":"0"}'
$ curl -X POST "https://sfu.mirotalk.com/api/v1/join" -H "authorization: mirotalksfu_default_secret" -H "Content-Type: application/json" --data '{"room":"test","name":"mirotalksfu","audio":"0","video":"0","screen":"0","notify":"0"}'
Hetzner

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 SFU instance on your dedicated cloud server, or for other needs, don't hesitate to contact us at [email protected]

DigitalOcean

DigitalOcean Referral Badge

For personal use, you can start with a single $5 a month cloud server and scale up as needed. You can use this link to get a $100 credit for the first 60 days.

If you need help to deploy MiroTalk SFU instance on your dedicated cloud server, or for other needs, don't hesitate to contact us at [email protected]

Live Demo

https://sfu.mirotalk.com

mirotalksfu-qr

Credits
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

AGPLv3

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 [email protected] or buy directly via CodeCanyon.

Support the project

Do you find MiroTalk useful?

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

BroadcastX

Hetzner

LuvLounge


MiroTalk P2P

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



Alternative Project Comparisons
Related Awesome Lists
Top Programming Languages

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Javascript (1,117,147
Docker (98,935
Real Time (10,660
Collaboration (6,191
Webrtc (4,437
Meeting (3,861
Sip (1,733
Self Hosted (1,344
Voip (887
Jitsi Meet (77
Sfu (50
Mediasoup (34
Conferencing (20
Google Meet Clone (5
Zoom Clone (5
Scalable Video Conferences (3