mirotalk

• 🎥 Video up to 8K @ 60fps · Screen sharing · Recording · Picture-in-Picture
• 💬 Chat with Markdown, emoji & optional GIF search (KLIPY) · Collaborative whiteboard · Shared P2P editor · Live polls · Breakout rooms · File sharing
• 🤖 ChatGPT (OpenAI) integration · Speech recognition · Voice commands
• 🔒 OIDC auth · Host protection · JWT credentials · Room passwords · Lobby · Peer-to-peer encryption
• 🔌 REST API · Slack & Mattermost · Embeddable iframe & widget · 133 languages

See all features →

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!

In Settings > Video > Background, select Off, Blur, or Image. Local PNG, JPEG, and WebP images up to 10 MB are processed in your browser and are not uploaded. Effects appear in your camera preview, outgoing camera video, and camera recordings. Screen sharing remains unaffected, including when sharing your camera and screen together.

Background controls are also available in prejoin and the quick video menu. Select Image, then use the file picker (or Choose image in the quick video menu) to choose or replace an image. The selected filename stays synchronized between prejoin and Video settings.

Effects require WebGL2 and canvas stream capture; blur also requires canvas filter support. MediaPipe Tasks Vision 0.10.21 and its WASM files are lazy-loaded from jsDelivr, and the selfie segmentation model (version 1) is loaded from Google Storage. These hosts must be reachable and permitted by any custom CSP (including WASM execution). Failures fall back to the camera without effects.

Effect output is capped at 1280 x 720 and 15 FPS. Off uses the original camera track without processing. Performance varies by device; background tabs may throttle rendering.

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.

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

Provider	Description	Link
	One-click install from the Cloudron App Store. Automates deployment, updates, backups, and user management.	Get Started
	High-performance cloud servers and dedicated root servers with top-tier reliability. Powers our live demo.	Explore Hetzner
	Enterprise-grade performance at unbeatable prices. Scalable and reliable.	Explore Netcup
	Fast, reliable hosting with 24/7 support and great performance.	Check out Hostinger
	Top-tier German hosting, dedicated servers, VPS, and web hosting at unbeatable prices.	Explore Contabo

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

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

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 & npm run test before committing
4. Submit a pull request

Have questions? Join our Discord community!

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 use MiroTalk P2P in a closed-source, rebranded, or commercial product, get a one-time fee license from the MiroTalk P2P page:

• Regular License: private source code and rebranding for one end product where end users are not charged.
• Extended License: private source code and rebranding for one end product where end users can be charged for access.

Choose your license first, then compare licenses & prices to pick the best fit for your 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!

We are grateful to our past sponsors for their support!

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