MiroTalk P2P

This project is proudly sponsored by

Recall.ai - API for meeting recording

Recall.ai – an API for recording Zoom, Google Meet, Microsoft Teams, and in-person meetings.

MiroTalk P2P - Free WebRTC, Simple, Secure, Fast Real-Time Video Conferences with support for up to 8k resolution and 60fps. It's compatible with all major browsers and platforms.

Explore MiroTalk P2P

Join our Community for questions, help, support, ideas, and discussions on Discord

Features

Is 100% Free - Open Source under (AGPLv3) - Self Hosted and PWA!
No downloads, plugins, or logins required – completely browser-based.
Unlimited conference rooms with no time limitations.
Translated into 133 languages.
Support for the OpenID Connect (OIDC) authentication layer.
Host protection to prevent unauthorized access.
User auth to prevent unauthorized access.
Room password protection.
JWT.io securely manages credentials for host configurations and user authentication, enhancing security and streamlining processes.
Compatible with desktop and mobile devices.
Optimized mobile room URL sharing.
Webcam streaming with front and rear camera support for mobile devices.
Crystal-clear audio streaming with speaking detection and volume indicators.
Screen sharing for presentations.
File sharing with drag-and-drop support.
Choose your audio input, output, and video source.
Supports video quality up to 8K and 60 FPS.
Supports advance Video/Document Picture-in-Picture (PiP) offering a more streamlined and flexible viewing experience.
Record your screen, audio, and video.
Snapshot video frames and save them as PNG images.
Chat with an Emoji Picker for expressing feelings, private messages, Markdown support, and conversation saving.
ChatGPT (powered by OpenAI) for answering questions, providing information, and connecting users to relevant resources.
Speech recognition for sending spoken messages.
Push-to-talk functionality, similar to a walkie-talkie.
Advanced collaborative whiteboard for teachers.
Real-time sharing of YouTube embed videos, video files (MP4, WebM, OGG), and audio files (MP3).
Full-screen mode with one-click video element zooming and pin/unpin.
Customizable UI themes.
Right-click options on video elements for additional controls.
Direct peer-to-peer connections for low-latency communication through WebRTC.
Supports REST API (Application Programming Interface).
Integration with Mattermost for enhanced communication.
Integration with Slack for enhanced communication.
Utilizes Sentry for error reporting.
And much more...

About

Start videoconference

Open MiroTalk P2P or alternative link.
Choose a room name and click Join Room.
Grant camera and microphone access.
Share the room URL and wait for participants to join the video conference.

Direct Join

https://mirotalk.up.railway.app/join?room=test&name=mirotalk&avatar=0&audio=0&video=0&screen=0&chat=0&hide=0&notify=0

Params	Type	Description
room	string	Room Id
name	string	User name
avatar	Mixed	User avatar
audio	boolean	Audio stream
video	boolean	Video stream
screen	boolean	Screen stream
chat.	boolean	Chat
hide	boolean	Hide myself
notify	boolean	Welcome message
token	string	jwt token

Note

The token parameter are optional when either HOST_PROTECTED or HOST_USER_AUTH is set to true in the .env file. The valid list of users is defined in the HOST_USERS configuration.

Host Protection Configuration

When host protection or host user auth is enabled, the host/users must provide a valid username and password as specified in the .env file.

Params	Value	Description
`HOST_PROTECTED`	`true` if protection is enabled, `false` if not (default false)	Requires the host to provide a valid username and password during room initialization.
`HOST_USER_AUTH`	`true` if user authentication is required, `false` if not (default false).	Determines whether host authentication is required.
`HOST_USERS`	JSON array with user objects: `{"username": "username", "password": "password"}`	List of valid host users with their credentials.

Quick start

Before running MiroTalk P2P, ensure you have Node.js installed.

# clone this repo
$ git clone https://github.com/miroslavpejic85/mirotalk.git
# go to mirotalk dir
$ cd mirotalk
# copy .env.template to .env (edit it according to your needs)
$ cp .env.template .env
# Copy app/src/config.template.js in app/src/config.js (edit it according to your needs)
$ cp app/src/config.template.js app/src/config.js
# install dependencies
$ npm install
# start the server
$ npm start

Open http://localhost:3000 in your browser.

Docker

Repository docker hub
Install docker engine and docker compose

# clone this repo
$ git clone https://github.com/miroslavpejic85/mirotalk.git
# go to mirotalk dir
$ cd mirotalk
# copy .env.template to .env (edit it according to your needs)
$ cp .env.template .env
# Copy app/src/config.template.js in app/src/config.js (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 (edit it according to your needs)
$ cp docker-compose.template.yml docker-compose.yml
# Get official image from Docker Hub
$ docker pull mirotalk/p2p:latest
# create and start containers
$ docker-compose up # -d
# to stop and remove resources
$ docker-compose down

Open http://localhost:3000 in your browser.

Embed a meeting

To embed a meeting within your service or app using an iframe, you can use the following code:

<iframe
    allow="camera; microphone; display-capture; fullscreen; clipboard-read; clipboard-write; web-share; autoplay"
    src="https://p2p.mirotalk.com/newcall"
    style="height: 100vh; width: 100vw; border: 0px;"
></iframe>

WIdget

To quickly add a support widget to your site, include the script in your <head> and place the widget <div> at the end of your <body>. Your support widget will be ready instantly!

<!doctype html>
<html>
    <head>
        <script src="https://p2p.mirotalk.com/js/widget.js"></script>
    </head>
    <body>
        <div
            id="support-widget"
            data-mirotalk-auto
            data-domain="p2p.mirotalk.com"
            data-room="support-room"
            data-theme="dark"
            data-widget-type="support"
            data-widget-state="normal"
            data-position="bottom-right"
            data-check-online="false"
            data-expert-images="https://i.pravatar.cc/40?img=1,https://i.pravatar.cc/40?img=2,https://i.pravatar.cc/40?img=3"
            data-buttons="audio,video,screen,chat,join"
            data-heading="Need Help?"
            data-subheading="Get instant support from our expert team!"
            data-connect-text="connect in &lt; 5 seconds"
            data-online-text="We are online"
            data-offline-text="We are offline"
            data-powered-by="Powered by MiroTalk"
        ></div>
    </body>
</html>

Explore Integrations →

Documentations

Ngrok/HTTPS: You can start a video conference directly from your local PC and make it accessible from any device outside your network by following these instructions, or expose it directly on HTTPS.
Stun/Turn: Install your own Stun & Turn by following this instructions.
Self-hosting: For self-hosting MiroTalk P2P on your own dedicated server, please refer to this comprehensive guide. It will provide you with all the necessary instructions to get your MiroTalk P2P instance up and running smoothly.
Rest API: The API documentation uses swagger at http://localhost:3000/api/v1/docs. Or check it out on live.

1. Stats Endpoint (Get server statistics)

curl -X GET "http://localhost:3000/api/v1/stats" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json"
curl -X GET "https://p2p.mirotalk.com/api/v1/stats" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json"
curl -X GET "https://mirotalk.up.railway.app/api/v1/stats" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json"

2. Meetings Endpoint (Get active meetings)

curl -X GET "http://localhost:3000/api/v1/meetings" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json"
curl -X GET "https://p2p.mirotalk.com/api/v1/meetings" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json"
curl -X GET "https://mirotalk.up.railway.app/api/v1/meetings" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json"

3. Create Meeting

curl -X POST "http://localhost:3000/api/v1/meeting" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json"
curl -X POST "https://p2p.mirotalk.com/api/v1/meeting" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json"
curl -X POST "https://mirotalk.up.railway.app/api/v1/meeting" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json"

4. Join Meeting (Basic)

curl -X POST "http://localhost:3000/api/v1/join" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json" --data '{"room":"test","name":"mirotalk","avatar":false,"audio":true,"video":true,"screen":false,"chat":false,"hide":false,"notify":true}'
curl -X POST "https://p2p.mirotalk.com/api/v1/join" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json" --data '{"room":"test","name":"mirotalk","avatar":false,"audio":true,"video":true,"screen":false,"chat":false,"hide":false,"notify":true}'
curl -X POST "https://mirotalk.up.railway.app/api/v1/join" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json" --data '{"room":"test","name":"mirotalk","avatar":false,"audio":true,"video":true,"screen":false,"chat":false,"hide":false,"notify":true}'

5. Join Meeting with Token

curl -X POST "http://localhost:3000/api/v1/join" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json" --data '{"room":"test","name":"mirotalk","audio":true,"video":true,"screen":false,"chat":false,"hide":false,"notify":true,"token":{"username":"username","password":"password","presenter":true,"expire":"1h"}}'
curl -X POST "https://p2p.mirotalk.com/api/v1/join" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json" --data '{"room":"test","name":"mirotalk","audio":true,"video":true,"screen":false,"chat":false,"hide":false,"notify":true,"token":{"username":"username","password":"password","presenter":true,"expire":"1h"}}'
curl -X POST "https://mirotalk.up.railway.app/api/v1/join" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json" --data '{"room":"test","name":"mirotalk","audio":true,"video":true,"screen":false,"chat":false,"hide":false,"notify":true,"token":{"username":"username","password":"password","presenter":true,"expire":"1h"}}'

6. Generate Token

curl -X POST "http://localhost:3000/api/v1/token" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json" --data '{"username":"username","password":"password","presenter":true,"expire":"1h"}'
curl -X POST "https://p2p.mirotalk.com/api/v1/token" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json" --data '{"username":"username","password":"password","presenter":true,"expire":"1h"}'
curl -X POST "https://mirotalk.up.railway.app/api/v1/token" -H "authorization: mirotalkp2p_default_secret" -H "Content-Type: application/json" --data '{"username":"username","password":"password","presenter":true,"expire":"1h"}'

These commands should now work correctly with the MiroTalk P2P

Hetzner, Netcup, Hostinger & Contabo

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.

Unlock enterprise-grade performance at a price you won’t believe. Scalable, reliable, and built for businesses that demand more.

👉 Power Meets Value with Netcup Root Server

Fast, reliable hosting with 24/7 support and great performance. Start today!

👉 Check out Hostinger now

Experience also top-tier German web hosting – dedicated servers, VPS, and web hosting at unbeatable prices.

👉 Explore now here

To set up your own instance of MiroTalk P2P on a dedicated cloud server, please refer to our comprehensive self-hosting documentation. This guide will walk you through the process step by step, ensuring a smooth and successful deployment.

Live Demos

https://p2p.mirotalk.com

https://mirotalk.up.railway.app

Security

For Security concerning, please follow this documentation.

Credits

ianramzy (html template)
vasanthv (webrtc-logic)
fabric.js (whiteboard)

Contributing

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

License

MiroTalk P2P is free and open-source under the terms of AGPLv3 (GNU Affero General Public License v3.0). Please respect the license conditions, 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.

To obtain a MiroTalk P2P license with terms different from the AGPLv3, you can conveniently make your purchase on CodeCanyon. This allows you to tailor the licensing conditions to better suit your specific requirements.

Support the project

Do you find MiroTalk P2P indispensable for your needs? Join us in supporting this transformative project by becoming a backer or sponsor. By doing so, not only will your logo prominently feature here, but you'll also drive the growth and sustainability of MiroTalk P2P. Your support is vital in ensuring that this valuable platform continues to thrive and remain accessible for all. Make an impact – back MiroTalk P2P today and be part of this exciting journey!

Advertisers

EffectsSDK ✨

Enhance your video conferencing experience with advanced virtual backgrounds and noise suppression. EffectsSDK offers powerful SDKs and plugins for fast integration.

Explore:

🎥 AI Video Effects Extension – Add virtual backgrounds and effects to your webcam.
🔊 Noise Cancelling Extension – Reduce background noise for clearer audio.
🛠️ Integrate EffectsSDK – Access SDKs and plugins for custom solutions.

Diving into Additional MiroTalk Projects:

MiroTalk SFU

Try also MiroTalk SFU selective forwarding unit real-time video conferences, optimized for large groups. Unlimited time, unlimited concurrent rooms each having 8+ participants, up to ~ 100 per single CPU.

MiroTalk C2C

Try also MiroTalk C2C peer to peer real-time video conferences, optimized for cam 2 cam. Unlimited time, unlimited concurrent rooms each having 2 participants.

MiroTalk BRO

Try also MiroTalk BRO Live broadcast (peer to peer) live video, audio and screen stream to all connected users (viewers). Unlimited time, unlimited concurrent rooms each having a broadcast and many viewers.

MiroTalk WEB

Try also MiroTalk WEB a platform that allows for the management of an unlimited number of users. Each user must register with their email, username, and password, after which they gain access to their personal dashboard. Within the dashboard, users can manage their rooms and schedule meetings using the desired version of MiroTalk on a specified date and time. Invitations to these meetings can be sent via email, shared through the web browser, or sent via SMS.

This project is tested with BrowserStack.