mirotalkwebrtc

[GitHub Stars] [GitHub Forks]

[License: AGPLv3] [Docker Pulls] [Last Commit] [Discord] [Author]

Start in a few commands:

git clone https://github.com/miroslavpejic85/mirotalkwebrtc.git
cd mirotalkwebrtc
cp .env.template .env
cp backend/config.template.js backend/config.js
npm install
npm run mongo:up   # start local MongoDB via Docker
npm start

Open http://localhost:9000 - done!

Note: For cloud MongoDB (e.g. MongoDB Atlas), update the credentials in .env instead of running npm run mongo:up.

[docker]

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

git clone https://github.com/miroslavpejic85/mirotalkwebrtc.git
cd mirotalkwebrtc
cp .env.template .env
cp backend/config.template.js backend/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:9000 - done!

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

For detailed guides and references, visit the official documentation:

• About
• Self-Hosting Guide
• Stripe integration
• Automation-scripts
• Configurations
• Integration
• REST API Documentation
• Ngrok

[stripe]

MiroTalk WEB can run as a paid SaaS platform powered by Stripe. Enable it with SAAS=true in your .env.

• SAAS=false (default): the application behaves exactly as the open-source self-hosted version - no subscriptions, no payment gating.
• SAAS=true: registered users (excluding demo and admin accounts) must hold an active subscription to create/manage rooms and join meetings. Three plans are offered out of the box:
  • Monthly - recurring Stripe subscription.
  • Annual - recurring yearly Stripe subscription.
  • Lifetime - one-time Stripe payment.

For full setup, environment variables, Stripe configuration, webhooks, and local testing, see docs/STRIPE.md.

[!WARNING] Commercial license required

Running MiroTalk WEB in SaaS mode (i.e. reselling access or operating it as a paid service) requires an Extended license. See the MiroTalk WEB license for details.

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

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. Submit a pull request

Have questions? Join our Discord community!

[AGPLv3]

MiroTalk WEB 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 WEB 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.

Do you find MiroTalk WEB 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 WEB. Your support is vital in ensuring that this valuable platform continues to thrive and remain accessible for all. Make an impact – back MiroTalk WEB today and be part of this exciting journey!