Quick Start

Starting Monibuca

Start with Default Configuration

# Download and run the pre-compiled binary (amd64 example)
wget https://download.m7s.live/bin/monibuca_v6_linux_amd64.tar.gz
tar -xzf monibuca_v6_linux_amd64.tar.gz
chmod +x monibuca_linux_amd64
./monibuca_linux_amd64

Start with a Configuration File

# Use a custom configuration file
./monibuca -c config.yaml

Start with Docker

docker run -d \
  --name monibuca \
  -p 8180:8180 \
  -p 8443:8443 \
  -p 1935:1935 \
  -p 8554:8554 \
  -p 50051:50051 \
  -p 6000:6000/udp \
  -p 9000-9100:9000-9100/udp \
  langhuihui/monibuca:v6

Docker quick path (pull → play)

For a one-command Monibuca + coturn try-out (dual ICE + TURN for WebRTC):

git clone https://github.com/Monibuca/Enterprise.git
cd Enterprise/deploy/compose
docker pull langhuihui/monibuca:v6
cp .env.example .env   # set PUBLIC_IP
docker compose up -d

Publish: ffmpeg -re -i input.mp4 -c copy -f flv rtmp://localhost/live/test
Play: open http://localhost:8180/flv/live/test.flv or http://localhost:8180/demo/live-room in a browser.

Full operator guide (image tags, WHIP/WHEP, firewall): deploy/compose/README.md.

Basic Configuration

Create a config.yaml file:

global:
  loglevel: info
  http:
    listenaddr: ":8180"
    cors: true
  tcp:
    listenaddr: ":50051"
  publish:
    ringsize: 256
  subscribe:
    subtimeout: 10
    waittimeout: 10
  db:
    dsn: "sqlite:m7s.db?mode=rwc"
  admin:
    enablelogin: false

# RTMP - Publish & Subscribe
rtmp:
  enable: true
  tcp:
    listenaddr: ":1935"

# RTSP - Surveillance Device Integration
rtsp:
  enable: true
  tcp:
    listenaddr: ":8554"

# HLS - Widely Compatible Playback
hls:
  enable: true
  segmentduration: 6
  maxsegments: 5

# WebRTC - Ultra-Low Latency
webrtc:
  enable: true
  portrange: "udp:9000-9100"

# SRT - Secure Reliable Transport
srt:
  enable: true
  listenaddr: ":6000"

Minimal Configuration

All Monibuca configuration options have sensible default values. If you only need RTMP publishing and HTTP-FLV playback, you can run it directly without any configuration file.

Ports & firewall

Before public / NAT deployment, allow the inbound ports you use. Full matrix: Ports & Firewall (HTTP 8180, RTMP 1935, RTSP 8554, SRT 6000/udp, WebRTC ICE port_range, cluster QUIC 8002/udp, coturn 3478, and more).

With dual ICE, open both UDP and TCP spans and set public_ip / TURN as needed — see WebRTC.

For a local origin + coturn try-out, use the repo Compose reference: deploy/compose/ (copy .env.example → .env, set PUBLIC_IP, then docker compose up -d).

Publishing Streams

RTMP Publishing

Use FFmpeg to push a video file to Monibuca:

# Publish to the live/test path
ffmpeg -re -i input.mp4 -c copy -f flv rtmp://localhost/live/test

# Publish from camera (macOS)
ffmpeg -f avfoundation -i "0" -c:v libx264 -f flv rtmp://localhost/live/camera

# Publish from desktop (Linux)
ffmpeg -f x11grab -i :0.0 -c:v libx264 -f flv rtmp://localhost/live/screen

Using OBS for publishing:

1. Open OBS → Settings → Stream
2. Service: Custom
3. Server: rtmp://localhost
4. Stream Key: live/test

SRT Publishing

ffmpeg -re -i input.mp4 -c copy -f mpegts \
  "srt://localhost:6000?streamid=publish:/live/test"

WebRTC Publishing (WHIP)

# Publish using the WHIP protocol
# POST http://localhost:8180/webrtc/whip?app=live&stream=test
# Body: SDP Offer (application/sdp)

Stream Playback

After successfully publishing a stream, you can play it through multiple protocols:

HTTP-FLV

# Open in browser or player
http://localhost:8180/flv/live/test.flv

# Play with ffplay
ffplay http://localhost:8180/flv/live/test.flv

HLS

# Open in browser or player
http://localhost:8180/hls/live/test/index.m3u8

# Play with ffplay
ffplay http://localhost:8180/hls/live/test/index.m3u8

WebRTC (WHEP)

# Subscribe using the WHEP protocol
# POST http://localhost:8180/webrtc/whep?app=live&stream=test
# Body: SDP Offer (application/sdp)

SRT

ffplay "srt://localhost:6000?streamid=subscribe:/live/test"

RTSP

ffplay rtsp://localhost:8554/live/test

Admin Panel

Monibuca includes a built-in Web admin panel providing stream management, system monitoring, and more.

Access URL

http://localhost:8180/admin

Demo Access URLs

http://localhost:8180/demo/live-room
http://localhost:8180/demo/meeting-room
http://localhost:8180/demo/customer-service

Key Features

• Stream List: View all currently active streams, including publisher and subscriber information
• System Info: Monitor system resources such as CPU, memory, and network
• Plugin Status: View loaded plugins and their configurations
• Configuration Management: Modify configuration online (via API)

Authentication Configuration

Management APIs (/api/*, /v6/api/*, config writes, etc.) require an admin JWT when a secret is configured. The admin SPA redirects to /login and attaches Authorization: Bearer … automatically.

Recommended YAML:

global:
  auth:
    secret: "your-jwt-secret-key"
    users:
      - username: admin
        password: your_secure_password
        role: admin

Environment variable:

export M7S_AUTH_SECRET="your-jwt-secret-key"

Local development (bypass auth — never in production):

export M7S_ADMIN_DEV_MODE=1

Login: POST /api/auth/login → access_token / refresh_token. The admin UI refreshes tokens and redirects to /login on 401.

Environment Variable Configuration

Monibuca supports overriding configuration file values via environment variables in the following format:

M7S_{PLUGIN}_{FIELD}

All letters are uppercase, and nested fields are separated by underscores.

Examples

# Change RTMP listen port
export M7S_RTMP_TCP_LISTENADDR=":1936"

# Change global log level
export M7S_GLOBAL_LOGLEVEL="debug"

# Change publish timeout
export M7S_GLOBAL_PUBLISH_PUBTIMEOUT="30"

# Change WebRTC ICE servers
export M7S_WEBRTC_ICESERVERS="stun:stun.l.google.com:19302"

Usage in Docker

docker run -d \
  --name monibuca \
  -e M7S_GLOBAL_LOGLEVEL=info \
  -e M7S_RTMP_TCP_LISTENADDR=":1935" \
  -e M7S_GLOBAL_HTTP_LISTENADDR=":8180" \
  -p 8180:8180 \
  -p 1935:1935 \
  langhuihui/monibuca:v6

Common APIs

After startup, you can query the service status through the HTTP API:

# Get system summary
curl http://localhost:8180/api/summary

# Get stream list
curl 'http://localhost:8180/v6/api/streams?page=1&per_page=20'

# Get plugin list
curl http://localhost:8180/api/plugins

Next Steps

• Configuration Guide — Deep dive into the configuration system
• Ports & Firewall — Default ports and allowlist notes
• deploy/compose — Docker Compose: Monibuca + coturn
• System Architecture — Understand Monibuca’s internal design
• Protocol Overview — Detailed usage for each protocol