CLI & Server Options

Complete reference for all configuration options and CLI commands.

CLI Commands (Coming Soon)

The MikroRoom CLI provides installation and management commands.

`mikroroom install`

Download and install the latest MikroRoom version.

mikroroom install

Downloads from https://releases.mikroroom.com/mikroroom_latest.zip.

`mikroroom init`

Initialize MikroRoom in the current directory.

mikroroom init

Creates:

mikroroom.config.json - Frontend configuration
app/ - Web application files (if available)

`mikroroom start [options]`

Start the MikroRoom server.

# Basic start
mikroroom start

# With custom port
PORT=8080 mikroroom start

# Pass arguments to Node.js
mikroroom start --inspect

`mikroroom upgrade`

Upgrade to the latest version.

mikroroom upgrade

Checks for updates and installs if available.

`mikroroom version`

Show installed version.

mikroroom version
# Output: MikroRoom v1.0.0

`mikroroom uninstall`

Remove MikroRoom from your system.

mikroroom uninstall

Removes installation files but preserves your configuration.

`mikroroom docs`

Open documentation in your browser.

mikroroom docs

Environment Variables

Configure the server via .env file or environment variables.

Server Configuration

`PORT`

Server port number.

Type: Number
Default: 3000
Example: PORT=8080

PORT=8080 npm start

`USE_HTTPS`

Enable HTTPS server.

Type: Boolean (true or false)
Default: false
Requires: SSL_CERT_PATH and SSL_KEY_PATH

USE_HTTPS=true

`SSL_CERT_PATH`

Path to SSL certificate file.

Type: String (file path)
Required when: USE_HTTPS=true
Example: /etc/letsencrypt/live/yourdomain.com/fullchain.pem

SSL_CERT_PATH=/path/to/cert.pem

`SSL_KEY_PATH`

Path to SSL private key file.

Type: String (file path)
Required when: USE_HTTPS=true
Example: /etc/letsencrypt/live/yourdomain.com/privkey.pem

SSL_KEY_PATH=/path/to/key.pem

TURN Server Configuration

`TURN_SERVER_URL`

TURN server URL for NAT traversal.

Type: String (URL)
Format: turn:hostname:port or turns:hostname:port
Example: turn:turn.example.com:3478

TURN_SERVER_URL=turn:turn.yourdomain.com:3478

`TURN_SERVER_USERNAME`

TURN server authentication username.

Type: String
Required with: TURN_SERVER_URL

TURN_SERVER_USERNAME=mikroroom

`TURN_SERVER_CREDENTIAL`

TURN server authentication password.

Type: String
Required with: TURN_SERVER_URL
Security: Keep secret, don’t commit to git

TURN_SERVER_CREDENTIAL=your-secure-password

Room Management

`MAX_LATENT_ROOMS`

Maximum number of pre-created empty rooms.

Type: Number
Default: 10
Range: 1-1000

MAX_LATENT_ROOMS=20

`LATENT_ROOM_MAX_AGE_HOURS`

Hours before empty pre-created rooms are cleaned up.

Type: Number (hours)
Default: 24
Range: 1-168 (1 week)

LATENT_ROOM_MAX_AGE_HOURS=48

Frontend Configuration

Configure via static/mikroroom.config.json or dist/app/mikroroom.config.json.

`apiUrl`

WebSocket URL for signaling server.

Type: String (WebSocket URL)
Required: Yes
Format: ws:// or wss://

{
  "apiUrl": "wss://api.yourdomain.com/ws"
}

Examples:

Development: "ws://localhost:3000/ws"
Production: "wss://yourdomain.com/ws"
Separate API: "wss://api.yourdomain.com/ws"

`iceServers`

Array of STUN/TURN servers for WebRTC.

Type: Array of ICE server objects
Optional: Yes (uses default STUN if omitted)

{
  "iceServers": [
    { "urls": "stun:stun.cloudflare.com:3478" },
    {
      "urls": "turn:turn.yourdomain.com:3478",
      "username": "mikroroom",
      "credential": "password"
    }
  ]
}

ICE Server Object:

urls (string or array): STUN/TURN server URLs
username (string, optional): Authentication username
credential (string, optional): Authentication password

Common STUN servers:

stun:stun.cloudflare.com:3478
stun:stun.l.google.com:19302
stun:stun1.l.google.com:19302

NPM Scripts

Available scripts for development and production.

Development

# Watch mode (auto-rebuild on changes)
npm run dev

# Watch client only
npm run dev:client

# Watch server only
npm run dev:server

Building

# Full production build
npm run build

# Development build (no minification)
npm run build:dev

# Build client only
npm run build:client

# Build server only
npm run build:server

Quality

# Run all tests
npm test

# Tests with coverage
npm run test:coverage

# Check code style
npm run lint

# Fix code style issues
npm run lint:fix

# TypeScript type checking
npm run typecheck

Release

# Create release bundles
npm run release

# Clean build artifacts
npm run clean

Deployment

# Start production server
npm start

# Build Docker image
npm run docker:build

# Run Docker container
npm run docker:run

Configuration Examples

Development

.env:

PORT=3000

mikroroom.config.json:

{
  "apiUrl": "ws://localhost:3000/ws"
}

Production (Basic)

.env:

PORT=8080

mikroroom.config.json:

{
  "apiUrl": "wss://meet.yourdomain.com/ws"
}

Production (With TURN)

.env:

PORT=443
USE_HTTPS=true
SSL_CERT_PATH=/etc/letsencrypt/live/yourdomain.com/fullchain.pem
SSL_KEY_PATH=/etc/letsencrypt/live/yourdomain.com/privkey.pem
TURN_SERVER_URL=turn:turn.yourdomain.com:3478
TURN_SERVER_USERNAME=mikroroom
TURN_SERVER_CREDENTIAL=strong-password-here
MAX_LATENT_ROOMS=20
LATENT_ROOM_MAX_AGE_HOURS=48

mikroroom.config.json:

{
  "apiUrl": "wss://meet.yourdomain.com/ws",
  "iceServers": [
    { "urls": "stun:stun.cloudflare.com:3478" },
    {
      "urls": "turn:turn.yourdomain.com:3478",
      "username": "mikroroom",
      "credential": "strong-password-here"
    }
  ]
}

Behind Reverse Proxy

.env (Server runs on HTTP internally):

PORT=3000
TURN_SERVER_URL=turn:turn.yourdomain.com:3478
TURN_SERVER_USERNAME=mikroroom
TURN_SERVER_CREDENTIAL=password

mikroroom.config.json (Public-facing is HTTPS):

{
  "apiUrl": "wss://meet.yourdomain.com/ws",
  "iceServers": [
    { "urls": "stun:stun.cloudflare.com:3478" },
    {
      "urls": "turn:turn.yourdomain.com:3478",
      "username": "mikroroom",
      "credential": "password"
    }
  ]
}

Security Considerations

Environment Variables

Never commit .env to git (already in .gitignore)
Use strong passwords for TURN credentials
Rotate credentials regularly
Use environment-specific .env files

SSL/TLS

Use TLS 1.2+ only
Keep certificates up to date
Use Let’s Encrypt for auto-renewal
Configure HSTS headers

Rate Limiting

Built-in rate limits:

WebSocket: 10 connections/minute per IP
Room creation: 10 requests/minute per IP

For additional protection, use:

Reverse proxy rate limiting (Nginx, Cloudflare)
CDN with DDoS protection
IP allowlisting for admin endpoints

Performance Tuning

Node.js Options

# Increase memory limit
NODE_OPTIONS="--max-old-space-size=4096" npm start

# Enable debugging
node --inspect dist/api/mikroroom.mjs

PM2 Configuration

module.exports = {
  apps: [{
    name: 'mikroroom',
    script: './dist/api/mikroroom.mjs',
    instances: 'max',
    exec_mode: 'cluster',
    env: {
      NODE_ENV: 'production',
      PORT: 3000
    }
  }]
}

Start with PM2:

pm2 start ecosystem.config.js

Next Steps

API Reference - HTTP and WebSocket API documentation
Configuration Guide - Detailed configuration examples