MiroTalk

https://docs.mirotalk.com
Admin
MiroTalk is an open-source suite of browser-based WebRTC real-time video communication applications...
Tokens:132,884
Snippets:1,368
Trust Score:6.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Quick Start Installation and Run

Source: https://docs.mirotalk.com/mirotalk-cme/self-hosting

Clones the repository, copies configuration files, installs dependencies, and starts the server. This is the foundational setup for running the service locally.

```Bash
# Clone this repo
git clone https://github.com/miroslavpejic85/call-me.git

# Go to dir call-me
cd call-me

# Copy the config file
cp public/config.template.js public/config.js

# Copy .env.template to .env
cp .env.template .env

# Install dependencies
npm install

# Start the server
npm start
```

--------------------------------

### Quick start installation

Source: https://docs.mirotalk.com/mirotalk-c2c/self-hosting

Commands to clone the repository, configure the environment, install dependencies, and start the server.

```bash
# Clone the repository
git clone https://github.com/miroslavpejic85/mirotalkc2c.git

# Navigate to the project directory
cd mirotalkc2c

# Copy and customize the environment template
cp .env.template .env

# Install dependencies
npm ci

# Start the server
npm start
```

--------------------------------

### Install dependencies and start server

Source: https://docs.mirotalk.com/mirotalk-sfu/self-hosting

Install project dependencies and start the MiroTalk SFU server.

```bash
# Install dependencies (first run may take a few minutes)
npm ci

# Start the server
npm start
```

--------------------------------

### Install Dependencies and Start Server

Source: https://docs.mirotalk.com/mirotalk-admin/self-hosting

Install the required project dependencies and launch the server. Ensure ADMIN_DASHBOARD_ENABLED is set to true in the .env file before starting.

```bash
# Install dependencies
npm ci

# Start the server
npm start
```

--------------------------------

### Quick Start Installation Commands

Source: https://docs.mirotalk.com/mirotalk-bro/self-hosting

Commands to clone the repository, prepare the environment, install dependencies, and start the MiroTalk BRO server.

```bash
# Clone the repository
git clone https://github.com/miroslavpejic85/mirotalkbro.git

# Navigate to the project directory
cd mirotalkbro

# Copy and customize the environment template
cp .env.template .env

# Install dependencies
npm ci

# Start the server
npm start
```

--------------------------------

### Apache Installation and SSL Setup

Source: https://docs.mirotalk.com/mirotalk-bro/self-hosting

Initial setup for Apache using Certbot and opening the configuration file.

```bash
# Install Apache with Certbot
apt install python3-certbot-apache -y

# Set up SSL
certbot --apache --non-interactive --agree-tos -d YOUR.DOMAIN.NAME -m your.email.address

# Edit the Apache site configuration
sudo vim /etc/apache2/sites-enabled/YOUR.DOMAIN.NAME.conf
```

--------------------------------

### Install and start vsftpd

Source: https://docs.mirotalk.com/utility/ftp

Updates package lists, installs vsftpd, and starts/enables the FTP service.

```bash
# Update package lists
sudo apt update

# Install the FTP server
sudo apt install vsftpd

# Start and enable the FTP service
sudo systemctl start vsftpd
sudo systemctl enable vsftpd
```

--------------------------------

### Install and Start MiroTalk BRO with PM2

Source: https://docs.mirotalk.com/mirotalk-bro/self-hosting

Commands to install PM2, start the server process, save the configuration, and enable auto-start on system boot.

```bash
npm install -g pm2

pm2 start app/server.js --name mirotalkbro

pm2 save

pm2 startup
```

--------------------------------

### Install PM2 and Start MiroTalk WEB

Source: https://docs.mirotalk.com/mirotalk-web/self-hosting

Commands to install PM2 globally, start the MiroTalk WEB server, save the process list, and enable auto-start on boot.

```bash
# Install PM2
npm install -g pm2

# Start the server
pm2 start backend/server.js --name mirotalkweb

# Save the process list
pm2 save

# Enable auto-start on boot
pm2 startup
```

--------------------------------

### Clone and set up backend

Source: https://docs.mirotalk.com/mirotalk-admin/quick-start

Clones the repository, copies configuration templates, installs dependencies, and starts the server.

```bash
git clone https://github.com/miroslavpejic85/mirotalk-admin.git
cd mirotalk-admin
cp backend/config/index.template.js backend/config/index.js
cp .env.template .env
npm ci
npm start

```

--------------------------------

### Install and setup MiroTalk Admin with Docker

Source: https://docs.mirotalk.com/mirotalk-admin/self-hosting

Commands to install Docker, clone the repository, and prepare configuration files.

```bash
sudo apt install -y docker.io
sudo apt install -y docker-compose

git clone https://github.com/miroslavpejic85/mirotalk-admin.git

cd mirotalk-admin

cp backend/config/index.template.js backend/config/index.js

cp .env.template .env
```

--------------------------------

### Using PM2 Process Manager

Source: https://docs.mirotalk.com/mirotalk-cme/self-hosting

Install PM2 globally, start the server, save the process list, and configure startup to persist after reboot.

```Bash
npm install -g pm2
pm2 start app/server.js
pm2 save
pm2 startup
```

--------------------------------

### GET /users Python Example

Source: https://docs.mirotalk.com/mirotalk-cme/api

Initializes the requests library for API interaction.

```python
import requests # pip3 install requests
```

--------------------------------

### GET /stats - JavaScript Example

Source: https://docs.mirotalk.com/mirotalk-sfu/api

JavaScript example using node-fetch to call the GET /stats endpoint. Requires npm i node-fetch. Uses dynamic import for fetch, sends the API key in the authorization header, and prints the response or error.

```JavaScript
"use strict";

// npm i node-fetch

async function getStats() {
  try {
    // Use dynamic import with await
    const { default: fetch } = await import("node-fetch");

    const API_KEY_SECRET = "YOUR_API_KEY_SECRET";
    const MIROTALK_URL = "https://sfu.mirotalk.com/api/v1/stats";

    const response = await fetch(MIROTALK_URL, {
      method: "GET",
      headers: {
        authorization: API_KEY_SECRET,
        "Content-Type": "application/json",
      },
    });
    const data = await response.json();
    if (data.error) {
      console.log("Error:", data.error);
    } else {
      if (data) {
        const formattedData = JSON.stringify(data, null, 2);
        console.log(formattedData);
      }
    }
  } catch (error) {
    console.error("Error fetching data:", error);
  }
}

getStats();

```

--------------------------------

### Quick Start: Clone and Setup MiroTalk WEB

Source: https://docs.mirotalk.com/mirotalk-web/self-hosting

Commands to clone the MiroTalk WEB repository, navigate into the project directory, and copy the environment and config templates. Replace placeholder values in the copied files with your actual domain names.

```bash
# Clone the repository
git clone https://github.com/miroslavpejic85/mirotalkwebrtc.git

# Navigate to the project directory
cd mirotalkwebrtc

# Copy and customize the environment template
cp .env.template .env

# Copy and customize the config template
cp backend/config.template.js backend/config.js
```

--------------------------------

### Setup MiroTalk BRO with Docker

Source: https://docs.mirotalk.com/mirotalk-bro/self-hosting

Commands to install Docker dependencies, clone the repository, and prepare the environment and compose files.

```bash
sudo apt install -y docker.io
sudo apt install -y docker-compose

git clone https://github.com/miroslavpejic85/mirotalkbro.git

cd mirotalkbro

cp .env.template .env

cp docker-compose.template.yml docker-compose.yml
```

--------------------------------

### Manage Process with PM2

Source: https://docs.mirotalk.com/mirotalk-admin/self-hosting

Install PM2 globally and use it to start the MiroTalk Admin server as a managed process.

```bash
# Install PM2
npm install -g pm2

# Start the server
pm2 start backend/server.js --name mirotalk-admin
```

--------------------------------

### Start MediaMTX

Source: https://docs.mirotalk.com/mirotalk-bro/rtmp

Starts MediaMTX with its configuration file.

```bash
mediamtx mediamtx.yml

```

--------------------------------

### Install mkcert and generate local certificates on Linux

Source: https://docs.mirotalk.com/mirotalk-admin/quick-start

Downloads and installs the mkcert binary, installs the local CA, and creates a certificate for localhost and 127.0.0.1. On Fedora/RHEL install nss-tools first; on Arch use nss and mkcert. Ensure libnss3-tools or nss-tools is installed before running mkcert -install for Firefox trust.

```bash
# install the mkcert binary (pick the latest release for your arch)
curl -fsSLo /tmp/mkcert "https://dl.filippo.io/mkcert/latest?for=linux/amd64"
sudo install -m 0755 /tmp/mkcert /usr/local/bin/mkcert
mkcert -install

mkdir -p backend/ssl/dev
cd backend/ssl/dev
mkcert -key-file key.pem -cert-file cert.pem localhost 127.0.0.1 ::1
```

--------------------------------

### Install MkDocs using snap

Source: https://docs.mirotalk.com/mirotalk-docs/self-hosting

Install MkDocs using the snap package manager. This method requires installing snapd first.

```bash
sudo apt update
sudo apt install snapd
sudo snap install mkdocs

```

--------------------------------

### Install Coturn

Source: https://docs.mirotalk.com/scripts/about

Downloads and executes the Coturn installation script.

```bash
# Install Coturn
wget -qO coturn-install.sh https://docs.mirotalk.com/scripts/coturn/coturn-install.sh \
  && chmod +x coturn-install.sh \
  && ./coturn-install.sh
```

--------------------------------

### GET /users PHP Example

Source: https://docs.mirotalk.com/mirotalk-cme/api

Fetches a list of connected users using cURL. Optionally append ?room=Support or ?details=true to the URL.

```php
<?php

// Optionally append ?room=Support or ?details=true
$url = "https://YOUR-DOMAIN-NAME/api/v1/users";

$authorization = "YOUR_API_KEY_SECRET";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    "authorization: $authorization",
    "Content-Type: application/json"
));

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
```

--------------------------------

### GET /users JavaScript Example

Source: https://docs.mirotalk.com/mirotalk-cme/api

Fetches a list of connected users using the Fetch API. Optionally append ?room=Support or ?details=true to the URL.

```javascript
'use strict';

// Optionally append ?room=Support or ?details=true
const url = 'https://YOUR-DOMAIN-NAME/api/v1/users';

const authorization = 'YOUR_API_KEY_SECRET';

fetch(url, {
    method: 'GET',
    headers: {
        Authorization: authorization,
        'Content-Type': 'application/json',
    },
})
    .then((response) => response.json())
    .then((data) => console.log(data))
    .catch((error) => console.error('Error:', error));
```

--------------------------------

### Clone and Prepare Project Files

Source: https://docs.mirotalk.com/mirotalk-sfu/self-hosting

Commands to clone the repository and initialize configuration files from templates.

```bash
git clone https://github.com/miroslavpejic85/mirotalksfu.git
cd mirotalksfu
cp app/src/config.template.js app/src/config.js
cp .env.template .env
cp docker-compose.template.yml docker-compose.yml
```

--------------------------------

### Quick start: clone, build, and deploy MiroTalk docs

Source: https://docs.mirotalk.com/mirotalk-docs/self-hosting

Clone the MiroTalk docs repository, build the site with MkDocs, set ownership for the web server, and move the site to the web root.

```bash
# Clone the repository
git clone https://github.com/miroslavpejic85/mirotalk-docs.git

# Navigate to the project directory
cd mirotalk-docs

# Build the site
mkdocs build

# Set proper ownership for the web server
sudo chown -R www-data:www-data /root/mirotalk-docs/site

# Move the site folder to the web root
sudo mv /root/mirotalk-docs/site /var/www/

```

--------------------------------

### Clone and set up project for PM2

Source: https://docs.mirotalk.com/mirotalk-admin/quick-start

Clones the repository and sets up configuration files without starting the server.

```bash
git clone https://github.com/miroslavpejic85/mirotalk-admin.git
cd mirotalk-admin
cp backend/config/index.template.js backend/config/index.js
cp .env.template .env
npm ci

```

--------------------------------

### GET /stats - PHP Example

Source: https://docs.mirotalk.com/mirotalk-sfu/api

PHP example using cURL to call the GET /stats endpoint. Sends the API key in the authorization header, prints the HTTP status code, and outputs the JSON response formatted with JSON_PRETTY_PRINT.

```PHP
<?php

$API_KEY_SECRET = "YOUR_API_KEY_SECRET";
$MIROTALK_URL = "https://sfu.mirotalk.com/api/v1/stats";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $MIROTALK_URL);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPGET, true);

$headers = [
    'authorization:' . $API_KEY_SECRET,
    'Content-Type: application/json'
];

curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
$httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

curl_close($ch);

echo "Status code: $httpcode \n";

if ($response) {
    echo json_encode(json_decode($response), JSON_PRETTY_PRINT);
} else {
    echo "Failed to retrieve data.\n";
}


```

--------------------------------

### Prepare directories for Node Media Server

Source: https://docs.mirotalk.com/mirotalk-sfu/rtmp

Create the app/rtmp directory and navigate to the node-media-server directory.

```Bash
mkdir -p app/rtmp
cd rtmpServers/node-media-server

```

--------------------------------

### GET /api/v1/vapidPublicKey - Bash Example

Source: https://docs.mirotalk.com/mirotalk-cme/api

Bash example using curl to retrieve the public VAPID key. This endpoint does not require the API secret.

```Bash
#!/bin/bash

url="https://YOUR-DOMAIN-NAME/api/v1/vapidPublicKey"

curl -s -X GET "$url" -H "Content-Type: application/json"
```

--------------------------------

### Prepare Nginx RTMP directories

Source: https://docs.mirotalk.com/mirotalk-sfu/rtmp

Create app/rtmp and navigate to the nginx-rtmp directory.

```Bash
mkdir -p app/rtmp
cd rtmpServers/nginx-rtmp

```

--------------------------------

### GET /stats Python Example

Source: https://docs.mirotalk.com/mirotalk-cme/api

Fetches server statistics using the requests library in Python.

```python
import requests  # pip3 install requests

# Aggregate server statistics: version, uptime, total users, rooms and active calls
url = "https://YOUR-DOMAIN-NAME/api/v1/stats"

authorization = "YOUR_API_KEY_SECRET"

headers = {
    'Authorization': authorization,
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)

print(response.json())
```

--------------------------------

### GET /stats PHP Example

Source: https://docs.mirotalk.com/mirotalk-cme/api

Fetches server statistics using the cURL library in PHP.

```php
<?php

// Aggregate server statistics: version, uptime, total users, rooms and active calls
$url = "https://YOUR-DOMAIN-NAME/api/v1/stats";

$authorization = "YOUR_API_KEY_SECRET";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    "authorization: $authorization",
    "Content-Type: application/json"
));

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
```

--------------------------------

### GET /api/v1/rooms - Bash Example

Source: https://docs.mirotalk.com/mirotalk-cme/api

Bash example using curl to list active rooms with user counts and active call counts. Requires the API key secret in the Authorization header.

```Bash
#!/bin/bash

# List active rooms with user counts and active call counts
url="https://YOUR-DOMAIN-NAME/api/v1/rooms";

authorization="YOUR_API_KEY_SECRET"

response=$(curl -s -X GET "$url" -H "Authorization: $authorization" -H "Content-Type: application/json")

echo "$response"
```

--------------------------------

### Install Docker, Compose, and FFmpeg prerequisites

Source: https://docs.mirotalk.com/mirotalk-sfu/rtmp

Bash commands to install Docker Engine, Docker Compose, and FFmpeg on Ubuntu.

```Bash
sudo apt update
sudo apt install -y docker.io docker-compose ffmpeg

```

--------------------------------

### GET /api/v1/rooms - PHP Example

Source: https://docs.mirotalk.com/mirotalk-cme/api

PHP example using cURL to list active rooms with user counts and active call counts. Requires the API key secret in the Authorization header.

```PHP
<?php

// List active rooms with user counts and active call counts
$url = "https://YOUR-DOMAIN-NAME/api/v1/rooms";

$authorization = "YOUR_API_KEY_SECRET";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    "authorization: $authorization",
    "Content-Type: application/json"
));

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
```

--------------------------------

### Configure .env File

Source: https://docs.mirotalk.com/mirotalk-sfu/self-hosting

Example configuration for the .env file. Ensure SFU_ANNOUNCED_IP is set to your server's public IP or domain.

```bash
ENVIRONMENT=production
SFU_ANNOUNCED_IP=Your-Server-Public-IPv4-or-Domain
SFU_MIN_PORT=40000
SFU_MAX_PORT=40100              # With 40000-40100 (~100 ports), supports about ~50 participants
SFU_NUM_WORKERS=4               # Optional: if unset, defaults to CPU core count (`nproc`)
```

--------------------------------

### GET /api/v1/rooms - JavaScript Example

Source: https://docs.mirotalk.com/mirotalk-cme/api

JavaScript example using fetch to list active rooms with user counts and active call counts. Requires the API key secret in the Authorization header.

```JavaScript
'use strict';

// List active rooms with user counts and active call counts
const url = 'https://YOUR-DOMAIN-NAME/api/v1/rooms';

const authorization = 'YOUR_API_KEY_SECRET';

fetch(url, {
    method: 'GET',
    headers: {
        Authorization: authorization,
        'Content-Type': 'application/json',
    },
})
    .then((response) => response.json())
    .then((data) => console.log(data))
    .catch((error) => console.error('Error:', error));
```

--------------------------------

### Update docker-compose to latest version on Linux

Source: https://docs.mirotalk.com/utility/docker-compose

Removes the existing docker-compose installation, downloads the latest version (v5.4.0 in this example) for Linux x86_64, makes it executable, moves it to /usr/bin, and verifies the installed version.

```bash
# Remove any existing installation of docker-compose
sudo apt remove docker-compose

# Download the latest version of docker-compose (v5.4.0 in this case) for Linux (x86_64 architecture)
wget https://github.com/docker/compose/releases/download/v5.4.0/docker-compose-linux-x86_64

# Make the downloaded docker-compose file executable
chmod +x docker-compose-linux-x86_64

# Move the docker-compose binary to /usr/bin to make it globally accessible
sudo mv docker-compose-linux-x86_64 /usr/bin/docker-compose

# Verify the installed version of docker-compose
docker-compose --version

```

--------------------------------

### GET /meetings - Bash Example

Source: https://docs.mirotalk.com/mirotalk-p2p/api

This Bash script uses curl to send a GET request to the meetings endpoint, including the API key secret and content type headers. It outputs the raw response.

```bash
#!/bin/bash

API_KEY_SECRET="YOUR_API_KEY_SECRET"
MIROTALK_URL="https://p2p.mirotalk.com/api/v1/meetings"

curl $MIROTALK_URL \
    --header "authorization: $API_KEY_SECRET" \
    --header "Content-Type: application/json" \
    --request GET

```

--------------------------------

### Install Docker and Docker Compose

Source: https://docs.mirotalk.com/mirotalk-cme/self-hosting

Commands to install Docker and Docker Compose on a Linux system using apt.

```bash
# Install docker
$ sudo apt install -y docker.io

# Instal docker-compose
$ sudo apt install -y docker-compose
```

--------------------------------

### GET /api/v1/rooms - Python Example

Source: https://docs.mirotalk.com/mirotalk-cme/api

Python example using the requests library to list active rooms with user counts and active call counts. Requires the API key secret in the Authorization header.

```Python
import requests  # pip3 install requests

# List active rooms with user counts and active call counts
url = "https://YOUR-DOMAIN-NAME/api/v1/rooms"

authorization = "YOUR_API_KEY_SECRET"

headers = {
    'Authorization': authorization,
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)

print(response.json())
```

--------------------------------

### Install Docker and Clone Repository

Source: https://docs.mirotalk.com/mirotalk-c2c/self-hosting

Commands to install Docker, clone the MiroTalk C2C repository, and prepare configuration files.

```bash
sudo apt install -y docker.io
sudo apt install -y docker-compose

git clone https://github.com/miroslavpejic85/mirotalkc2c.git

cd mirotalkc2c

cp .env.template .env

cp docker-compose.template.yml docker-compose.yml
```

--------------------------------

### GET /meetings - Python Example

Source: https://docs.mirotalk.com/mirotalk-p2p/api

This example fetches the list of active meetings using Python requests. It uses the API key secret for authorization and expects a JSON response. If the request is successful, it prints the data.

```python
# pip3 install requests
import requests
import json

API_KEY_SECRET = "YOUR_API_KEY_SECRET"
MIROTALK_URL = "https://p2p.mirotalk.com/api/v1/meetings"

headers = {
    "authorization": API_KEY_SECRET,
    "Content-Type": "application/json",
}

response = requests.get(
    MIROTALK_URL,
    headers=headers
)

print("Status code:", response.status_code)

if response.status_code == 200:
    data = response.json()
    pretty_printed_data = json.dumps(data, indent=4)
    print(data)
else:
    print("Failed to retrieve data. Error:", response.text)

```

--------------------------------

### List available Node.js versions

Source: https://docs.mirotalk.com/utility/nvm

Lists all available Node.js versions for installation.

```bash
nvm ls-remote
```

--------------------------------

### GET /api/v1/connected - Bash Example

Source: https://docs.mirotalk.com/mirotalk-cme/api

Bash example using curl to check connected users. Optionally append &room=Support to scope to a specific room; defaults to the public room. Requires the API key secret in the Authorization header.

```Bash
#!/bin/bash

# Optionally scope to a room: append &room=Support (defaults to the public room)
url="https://YOUR-DOMAIN-NAME/api/v1/connected?user=call-me";

authorization="YOUR_API_KEY_SECRET"

response=$(curl -s -X GET "$url" -H "Authorization: $authorization" -H "Content-Type: application/json")

echo "$response"
```

--------------------------------

### Manage server with PM2

Source: https://docs.mirotalk.com/mirotalk-sfu/self-hosting

Use PM2 to install, start, save, and enable auto-start for the MiroTalk SFU server process.

```bash
# Install PM2
npm install -g pm2

# Start the server
pm2 start app/src/Server.js --name mirotalksfu

# Save the process list
pm2 save

# Enable auto-start on boot
pm2 startup
```

--------------------------------

### Configure Node Media Server files

Source: https://docs.mirotalk.com/mirotalk-sfu/rtmp

Copy configuration templates to create config.js and docker-compose.yml.

```Bash
cp src/config.template.js src/config.js
cp docker-compose.template.yml docker-compose.yml

```

--------------------------------

### Python GET /meetings request

Source: https://docs.mirotalk.com/mirotalk-sfu/api

Retrieves a list of meetings using the requests library. Requires the requests package to be installed.

```python
import requests
import json

API_KEY_SECRET = "YOUR_API_KEY_SECRET"
MIROTALK_URL = "https://sfu.mirotalk.com/api/v1/meetings"

headers = {
    "authorization": API_KEY_SECRET,
    "Content-Type": "application/json",
}

response = requests.get(
    MIROTALK_URL,
    headers=headers
)

print("Status code:", response.status_code)

if response.status_code == 200:
    data = response.json()
    pretty_printed_data = json.dumps(data, indent=4)
    print(data)
else:
    print("Failed to retrieve data. Error:", response.text)
```

--------------------------------

### Python: Create a meeting with POST /meeting

Source: https://docs.mirotalk.com/mirotalk-c2c/api

Python example for creating a meeting via the POST /meeting endpoint. The code is incomplete in the source, showing only the opening lines.

```Python

```
Tokens:
Raw