This project is not covered by Drupal’s security advisory policy.

The MiroTalk SFU module enables seamless integration of video calling and screen-sharing functionalities in Drupal by leveraging the MiroTalk SFU server. It provides a simple interface for managing video call rooms, connecting to the MiroTalk SFU server, and customizing video call settings.

Features

Integration with MiroTalk SFU for video calls and screen sharing.
Create and manage video call rooms directly from your Drupal site.
Built-in support for recording and storing video calls.
Redirect users to a specified URL after leaving the call.

Requirements

A linux server running (Ubuntu 20.04 LTS or later).
MiroTalk SFU Server: Fully configured & operational MiroTalk SFU.
Browser: A modern browser with WebRTC support (e.g., Chrome, Firefox).

Installation

Download & install the MiroTalk SFU server https://github.com/miroslavpejic85/mirotalksfu.
High recommend download to /opt (ubuntu)
Install dotenv by running the following command:

npm install dotenv

After the installation, you can start the server by running: npm run start
or you run with pm2
pm2 start ecosystem.config.js --env production

#/opt/mirotalksfu/ecosystem.config.js
module.exports = {
    apps: [
      {
        name: "Miro Talk",
        script: "./app/src/Server.js",

        // Env Specific Config
        env_production: {
          NODE_ENV: "production",
          PORT: 3000,
          exec_mode: "cluster_mode",
        },
      },
    ],
  };

Important

Module need to full write permission to file mirotalk/app/src/config.js in root of mirotalk installed, example:

cd /opt/mirotalk/app/src
sudo cp config.template.js config.js
sudo chown www-data:www-data config.js

Setup

Go to /admin/config/services/mirotalk-sfu-meeting to configure Miro talk server.
After install module MiroTalk SFU you will have new entity type
You can create new meeting room, or you can add like field reference in your content type
You can add a meeting block, it will show a button meeting and pop-up to join or create a room

Configuration

Module design with bootstrap 5 and bootstrap 5 icons Best support with theme Boostrap 5 admin

Before using the module, ensure that you have configured the following fields:

  • server_path: The path to the server's MiroTalk SFU source,
  • server_url: The URL for connecting to the MiroTalk SFU server.
  • server_port: The port for connecting to the server.
  • recording_endpoint: The API endpoint for screen recording.
  • video_storage_path: The folder name for storing video recordings.
  • redirect_url: The URL to redirect users after leaving the room.

Usage

Once installed and configured, you can create video call rooms and invite users to join. The module will handle the connection to the MiroTalk SFU server, allow for screen sharing, and provide functionality for managing video call sessions.

Supporting organizations: 

Project information

Releases