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

You can join directly to room by going to

https://sfu.mirotalk.com/join?room=test&password=0&name=mirotalksfu&audio=0&video=0&screen=0&notify=0

Params	Type	Description
room	string	room Id
password	string/boolean	room password
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; display-capture; fullscreen; clipboard-read; clipboard-write; 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 version 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 npm@latest

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

Open in browser https://localhost:3010 or :3011 if default port changed.

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/sfu

# 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

Open in browser https://localhost:3010

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 API documentation uses swagger at https://localhost:3010/api/v1/docs or check it on live here.

# 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

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

Use my personal link to receive €⁠20 IN CLOUD CREDITS.

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

DigitalOcean

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

Live Demo

https://sfu.mirotalk.com

Credits

Davide Pacilio (html template)
Dirk Vanbeveren (sfu logic)
Mediasoup (sfu server)

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 purchase directly from 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 P2P

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

This project is tested with BrowserStack.

tomdevlive/mirotalksfu

MiroTalk SFU