Giter Club home page Giter Club logo

mirotalksfu's Introduction

MiroTalk SFU

Author License: AGPLv3 PayPal Digital Ocean Code style: prettier

Powered by WebRTC and powerful SFU integrated media server.

Open the app with the following supported browsers and many more.

Foo


mirotalksfu

Features

  • Is 100% Free - Open Source - Self Hosted
  • No download, plug-in or login required, entirely browser-based
  • Unlimited number of conference rooms and users, without call time limitation
  • Desktop and Mobile compatible
  • Optimized Room URL Sharing (share it to your participants, wait for them to join)
  • Possibility to Password protect the Room for the meeting
  • 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, 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 and the possibility to Save the conversations
  • 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
  • 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)

Quick Start

  • You will need to have NodeJS installed, this project has been tested with Node version 12.X and 14.X.
  • python3-pip DEB package, build-essential DEB package and python version >= 3.6 with PIP.
  • The requirements can also be found here.
# 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
$ npm install
# Start the server
$ npm start

Docker

# 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
# Copy docker-compose.template.yml in docker-compose.yml and edit it if needed
$ cp docker-compose.template.yml docker-compose.yml
# 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.
$ 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.org/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","notify":"0"}'
$ curl -X POST "https://sfu.mirotalk.org/api/v1/join" -H "authorization: mirotalksfu_default_secret" -H "Content-Type: application/json" --data '{"room":"test","name":"mirotalksfu","audio":"0","video":"0","notify":"0"}'

Direct Join


DigitalOcean

This application is running just for demonstration purposes on DigitalOcean droplet Ubuntu 20.04 (LTS) x64 [1 vCPU - 1GB Ram], with Ngnix and Let's Encrypt.

If you want to deploy a MiroTalk SFU instance on your dedicated droplet, or for other needs, don't hesitate to contact me at [email protected]

DigitalOcean Referral Badge

Live Demo

https://sfu.mirotalk.org

mirotalksfu-qr


Https

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

Notes

  • Run the project on a Linux or Mac system as the mediasoup installation could have issues on Windows.

Credits

Contributing

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

Discussions

  • For discussions about the project, 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.



Commercial License or closed source

For commercial use or closed source projects, we can offer licensing under the following terms.

World-wide, non-exclusive, non-transferable and non-sub-licensable license of MiroTalk as is on https://github.com/miroslavpejic85/mirotalksfu for use in purchasers products, as long as the resulting software does not stand in concurrence to the MiroTalk itself. Any liability is excluded. The law of the Federal Republic of Italy shall apply exclusively.

The one time fee is 499 EUR net. Please contact [email protected].



Sponsors

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

BroadcastX



MiroTalk P2P

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


mirotalksfu's People

Contributors

iconio avatar loranger avatar miroslavpejic85 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.