mirror of https://github.com/aiden09/mirotalksfu
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
4 years ago | |
|---|---|---|
| api | 4 years ago | |
| public | 4 years ago | |
| src | 4 years ago | |
| ssl | 4 years ago | |
| .gitignore | 4 years ago | |
| .prettierrc.js | 4 years ago | |
| Dockerfile | 4 years ago | |
| LICENSE | 4 years ago | |
| README.md | 4 years ago | |
| docker-compose.yml | 4 years ago | |
| package.json | 4 years ago | |
README.md
mirotalksfu
Powered by WebRTC with SFU integrated server.
Features
- Is
100% Free-Open Source-Self Hosted No download,plug-inorloginrequired, entirely browser basedUnlimitednumber ofconference roomsandusers,withoutcalltime limitation- Desktop and Mobile compatible
- Optimized Room URL Sharing (share it to your participants, wait them to join)
- Possibility to Lock/Unlock 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 ...
- Chat with Emoji Picker to show you feeling and possibility to Save the conversations
- Select Microphone - Speaker and Video source
- Recording your Screen, Audio or Video
- Full Screen Mode on mouse click on the Video element
- Supports REST API (Application Programming Interface)
DigitalOcean
This application has been tested on DigitalOcean droplet Ubuntu 20.04 (LTS) x64, with Ngnix and Let's Encrypt.
If you want to deploy an MiroTalk SFU instance on your own dedicated droplet, or for other needs, don't hesitate to contact me at miroslav.pejic.85@gmail.com
Quick Start
- You will need to have
Node.jsinstalled, this project has been tested with Node version 12.X and 14.X
# Clone this repo
$ git clone https://github.com/miroslavpejic85/mirotalksfu.git
# Go to to dir mirotalksfu
$ cd mirotalksfu
# Copy src/config.template.js in src/config.js and edit it if needed
$ cp src/config.template.js src/config.js
# Install dependencies
$ npm install
# Start the server
$ npm start
- Open https://localhost:3010 in browser
Docker
# Copy src/config.template.js in src/config.js and edit it if needed
$ cp src/config.template.js src/config.js
# Build or rebuild services
$ docker-compose build
# Create and start containers
$ docker-compose up # -d
# Stop and remove resources
$ docker-compose down
- Open https://localhost:3010 in browser
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"
Notes
- Run the project on a
Linux or Macsystem as themediasoupinstallation could have issues onWindows. If you have a Windows system, consider to installing WSL to be able to run it.
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
