MiroTalk P2P

Open Source WebRTC P2P Video Conferencing You Can Self-Host in Minutes

Free, Secure, Fast Real-Time Communication - up to 8K, 60fps. Works in All Browsers and Platforms.

[Recall.ai](https://www.recall.ai/?utm_source=github&utm_medium=sponsorship&utm_campaign=miroslavpejic85-mirotalk) - API for meeting recording

✨ Why MiroTalk P2P?

🚀 Features

• 🎥 Video up to 8K @ 60fps · Screen sharing · Recording · Picture-in-Picture
• 💬 Chat with Markdown & emoji · Collaborative whiteboard · File sharing
• 🤖 ChatGPT (OpenAI) integration · Speech recognition
• 🔒 OIDC auth · Host protection · JWT credentials · Room passwords · Peer-to-peer encryption
• 🔌 REST API · Slack & Mattermost · Embeddable iframe & widget · 133 languages

See all features →

⚡ Quick start

Start in 6 commands:

git clone https://github.com/miroslavpejic85/mirotalk.git
cd mirotalk
cp .env.template .env
cp app/src/config.template.js app/src/config.js
npm install
npm start

Open http://localhost:3000 - done!

🐳 Docker

Prerequisites: Install Docker Engine and Docker Compose - Image available on Docker Hub

git clone https://github.com/miroslavpejic85/mirotalk.git
cd mirotalk
cp .env.template .env
cp app/src/config.template.js app/src/config.js
cp docker-compose.template.yml docker-compose.yml
docker-compose pull    # optional: pull official image
docker-compose up      # add -d to run in background

Open http://localhost:3000 - done!

Note:
Edit app/src/config.js, .env, and docker-compose.yml to customize your setup.

📚 Documentation

For detailed guides and references, visit the official documentation:

• Our Story
• About
• Self-Hosting Guide
• Automation-scripts
• Configurations
• Rebranding
• Host Protection Mode
• Integration
• Direct Room Join
• REST API Documentation
• Ngrok
• Updates
• WebHook

☁️ Recommended Hosting Providers

To set up your own instance of MiroTalk P2P on a dedicated cloud server, please refer to our comprehensive self-hosting documentation.

🙏 Credits

• ianramzy (html template)
• vasanthv (webrtc-logic)
• fabric.js (whiteboard)
• DiceBear (random avatars)
• Image by ddraw on Freepik (avatar illustrations)

🤝 Contributing

Contributions are welcome and greatly appreciated! Whether it's bug fixes, features, or documentation - every contribution helps.

1. Fork the repository
2. Create your feature branch
3. Run npm run lint before committing
4. Submit a pull request

Have questions? Join our Discord community!

📄 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!

🙏 Past Sponsors

We are grateful to our past sponsors for their support!

📢 Advertisers

✨ EffectsSDK

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

• 🎥 AI Video Effects Extension: Virtual backgrounds and effects for your webcam
• 🔊 Noise Cancelling Extension: Clearer audio with background noise reduction
• 🛠️ Integrate EffectsSDK: SDKs and plugins for custom solutions

This project is tested with BrowserStack.

Contributors