Installation

Get MikroRoom running in minutes with your preferred method.

Prerequisites

• Node.js 24+ - Download
• npm or yarn - Comes with Node.js
• (Optional) Docker - For containerized deployment

Quick Start

Option 1: Direct Installation

Clone and run:

# Clone the repository
git clone https://github.com/mikaelvesavuori/mikroroom.git
cd mikroroom

# Install dependencies
npm install

# Development mode (HTTP, localhost:3000)
npm run dev

Then open http://localhost:3000 in your browser.

Option 2: CLI Installation (Coming Soon)

For production deployments, use the MikroRoom CLI:

# Install CLI
curl -sSL https://releases.mikroroom.com/install.sh | bash

# Install MikroRoom
mikroroom install

# Initialize in your project directory
mkdir my-meeting && cd my-meeting
mikroroom init

# Start the server
mikroroom start

Option 3: Docker

Note: Docker requires building from source. For production deployments without Docker, use Option 2 (CLI Installation).

Run with Docker:

# Build image from GitHub
docker build -t mikroroom https://github.com/mikaelvesavuori/mikroroom.git

# Run container
docker run -d -p 3000:3000 mikroroom

Visit http://localhost:3000 to access your meeting room.

Development Setup

For local development with hot reload:

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

# Run tests
npm test

# Lint code
npm run lint

Building for Production

Create optimized production builds:

# Full production build
npm run build

# Start production server
npm start

# Or specify a port
PORT=8080 npm start

Verify Installation

After starting the server, verify it’s working:

1. Health Check: Visit http://localhost:3000/health
2. Main App: Open http://localhost:3000 in your browser
3. Create a Meeting: Enter your name and click “New Meeting”

You should see a meeting room with your camera/microphone controls.

Troubleshooting

Camera/Microphone Not Working

Problem: Browser blocks camera/microphone access

Solution:

• Use HTTPS in production (required for camera access)
• For localhost development, HTTP is fine
• Check browser permissions for the domain

Port Already in Use

Problem: Port 3000 is already taken

Solution:

PORT=8080 npm start

Build Fails

Problem: Node.js version too old

Solution:

# Check your version
node -v

# Should be v24.0.0 or higher
# Upgrade if needed: https://nodejs.org/

Next Steps

Now that MikroRoom is installed, configure it for your needs:

• Configuration Guide - Set up HTTPS, TURN servers, and more
• Deployment Guide - Deploy to production