Miroslav Pejic
280 lines
8.2 KiB
Markdown
280 lines
8.2 KiB
Markdown
# <p align="center">MiroTalk P2P</p>
|
|
|
|
<p align="center">Free WebRTC - P2P - Simple, Secure, Fast Real-Time Video Conferences Up to 4k and 60fps, compatible with all browsers and platforms.</p>
|
|
|
|
<hr />
|
|
|
|
<p align="center">
|
|
<a href="https://mirotalk.herokuapp.com">mirotalk.herokuapp.com</a>
|
|
</p>
|
|
|
|
<hr />
|
|
|
|
<p align="center">
|
|
<a href="https://mirotalk.herokuapp.com"><img src="public/images/mirotalk-header.gif"></a>
|
|
</p>
|
|
|
|
<hr />
|
|
|
|
<details>
|
|
<summary>Features</summary>
|
|
|
|
<br/>
|
|
|
|
- Is `100% Free` - `Open Source` - `Self Hosted`
|
|
- 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 & Private messages & Save the conversations
|
|
- Speech recognition to send the speeches
|
|
- Advance collaborative whiteboard for the teachers
|
|
- Share any YT Embed video 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](app/api/README.md) (Application Programming Interface)
|
|
- [Sentry](https://sentry.io/) error reporting
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Presentation</summary>
|
|
|
|
<br/>
|
|
|
|
<a href="https://www.canva.com/design/DAE693uLOIU/view">MiroTalk presentation </a> - <a href="https://www.youtube.com/watch?v=_IVn2aINYww">video</a>
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Start videoconference</summary>
|
|
|
|
<br/>
|
|
|
|
- `Open` 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
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Direct Join</summary>
|
|
|
|
<br/>
|
|
|
|
- You can `join` directly to `room` by going to:
|
|
- https://mirotalk.up.railway.app/join?room=test&name=mirotalk&audio=0&video=0&screen=0¬ify=0
|
|
- https://mirotalk.herokuapp.com/join?room=test&name=mirotalk&audio=0&video=0&screen=0¬ify=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 |
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Embed a meeting</summary>
|
|
|
|
<br/>
|
|
|
|
Embedding a meeting into a service or app using an iframe.
|
|
|
|
```html
|
|
<iframe
|
|
allow="camera; microphone; fullscreen; display-capture; autoplay"
|
|
src="https://mirotalk.herokuapp.com/newcall"
|
|
style="height: 100%; width: 100%; border: 0px;"
|
|
></iframe>
|
|
```
|
|
|
|
</details>
|
|
|
|
<details open>
|
|
<summary>Quick start</summary>
|
|
|
|
<br/>
|
|
|
|
- You will need to have `Node.js` installed, this project has been tested with Node versions [12.X](https://nodejs.org/en/blog/release/v12.22.1/), [14.X](https://nodejs.org/en/blog/release/v14.17.5/) and [16.X](https://nodejs.org/en/blog/release/v16.15.0/).
|
|
|
|
```bash
|
|
# clone this repo
|
|
$ git clone https://github.com/miroslavpejic85/mirotalk.git
|
|
# go to mirotalk dir
|
|
$ cd mirotalk
|
|
# copy .env.template to .env
|
|
$ cp .env.template .env
|
|
# install dependencies
|
|
$ npm install
|
|
# start the server
|
|
$ npm start
|
|
```
|
|
|
|
- Open http://localhost:3000 in browser
|
|
|
|
</details>
|
|
|
|
<details open>
|
|
<summary>Docker</summary>
|
|
|
|
<br/>
|
|
|
|
- Install docker engine: https://docs.docker.com/engine/install/
|
|
- Install docker compose: https://docs.docker.com/compose/install/
|
|
|
|
```bash
|
|
# copy .env.template to .env
|
|
$ cp .env.template .env
|
|
# build or rebuild services
|
|
$ docker-compose build
|
|
# create and start containers
|
|
$ docker-compose up # -d
|
|
# stop and remove resources
|
|
$ docker-compose down
|
|
```
|
|
|
|
- Open http://localhost:3000 in browser
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Https</summary>
|
|
|
|
<br/>
|
|
|
|
You can start videoconferencing directly from your Local PC, and be reachable from any device outside your network, simply using a service like [ngrok](https://ngrok.com/) by editing the [Ngrok part](https://github.com/miroslavpejic85/mirotalk/blob/master/.env.template#L1) on `.env` file, or expose it directly on [HTTPS](app/ssl/README.md)
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Setup Turn</summary>
|
|
|
|
<br/>
|
|
|
|
`Recommended`, for more info about the Turn check out [here](https://webrtc.org/getting-started/turn-server). Just edit [this part](https://github.com/miroslavpejic85/mirotalk/blob/master/.env.template#L9) on your `.env`.
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Rest API</summary>
|
|
|
|
<br/>
|
|
|
|
```bash
|
|
# 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://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](https://swagger.io/) at http://localhost:3000/api/v1/docs. Or check it out on [live](https://p2p.mirotalk.org/api/v1/docs) & [heroku](https://mirotalk.herokuapp.com/api/v1/docs).
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Other Live Demos</summary>
|
|
|
|
<br/>
|
|
|
|
<a target="_blank" href="https://railway.app/new/template/mirotalk?referralCode=mirotalk"><img src="https://railway.app/button.svg" style="width: 220px;"></a>
|
|
|
|
https://mirotalk.up.railway.app/
|
|
|
|
[](https://mirotalk.up.railway.app/)
|
|
|
|
<br>
|
|
|
|
<a target="_blank" href="https://www.heroku.com/"><img src="https://www.herokucdn.com/deploy/button.svg" style="width: 220px;"></a>
|
|
|
|
https://mirotalk.herokuapp.com/
|
|
|
|
[](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.
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Credits</summary>
|
|
|
|
<br/>
|
|
|
|
- ianramzy (html [template](https://cruip.com/demos/neon/))
|
|
- vasanthv (webrtc-logic)
|
|
- fabric.js (whiteboard)
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Contributing</summary>
|
|
|
|
<br/>
|
|
|
|
- Contributions are welcome and greatly appreciated!
|
|
- Just run before `npm run lint`
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Discussions and support</summary>
|
|
|
|
<br/>
|
|
|
|
- For discussions, help & support, join with us on [Discord](https://discord.gg/rgGYfeYW3N)
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>License</summary>
|
|
|
|
<br/>
|
|
|
|
[](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](https://choosealicense.com/licenses/agpl-3.0/).
|
|
|
|
For a MiroTalk license under conditions other than AGPLv3, please contact us at info.mirotalk@gmail.com.
|
|
|
|
</details>
|
|
|
|
<details open>
|
|
<summary>Sponsors</summary>
|
|
|
|
<br/>
|
|
|
|
Support this project by [becoming a sponsor](https://github.com/sponsors/miroslavpejic85). Your logo will show up here with a link to your website.
|
|
|
|
[](https://broadcastx.de/)
|
|
|
|
</details>
|
|
|
|
<br>
|
|
|
|
<details>
|
|
<summary>MiroTalk SFU</summary>
|
|
|
|
<br/>
|
|
|
|
Try also [MiroTalk SFU](https://github.com/miroslavpejic85/mirotalksfu), the difference between the two projects you can found [here](https://github.com/miroslavpejic85/mirotalksfu/issues/14#issuecomment-932701999).
|
|
|
|
</details>
|