Install NodeJs.

# Copy .env.template to .env and edit it
$ cp .env.template .env

Change the MONGO URL & DATABASE, with your own:

MONGO_URL=mongodb://${MONGO_USERNAME}:${MONGO_PASSWORD}@${MONGO_HOST}:${MONGO_PORT}
MONGO_DATABASE=mirotalk

Setup your email and app password:

Note if you disable the user email verification EMAIL_VERIFICATION=false skip this Email config.

EMAIL_HOST=emailHost
EMAIL_PORT=emailPort
EMAIL_USERNAME=emailUsername
EMAIL_PASSWORD=emailPassword

# Install dependencies
$ npm install
# Start the server
$ npm start

Open in browser: http://localhost:9000

Install docker and docker-compose.

# Copy .env.template to .env and edit it
$ cp .env.template .env
# Copy docker-compose.template.yml in docker-compose.yml and edit it if needed
$ cp docker-compose.template.yml docker-compose.yml
# Get official image from Docker Hub
$ docker pull mirotalk/webrtc:latest
# Create and start containers (-d as daemon)
$ docker-compose up

Docker official image

You can check the swagger document at http://localhost:9000/api/v1/docs, or live here.

To self-hosting MiroTalk WEB, just follow this steps.

Join with us on Discord, ask questions and post answers without opening issues.

You can support MiroTalk's projects by sponsoring it. Thanks!

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.

For a MiroTalk license under conditions other than AGPLv3, please contact us at [email protected] or purchase directly via CodeCanyon.

Thank you!