Skip to content

Installation

ItemRequirement
Operating SystemLinux (recommended), macOS
CPU Architecturex86_64, aarch64
MemoryDepends on concurrency scale, minimum 1GB recommended
DiskDepends on recording requirements at runtime

Download the archive for your platform (Linux, macOS, Windows) from Downloads. For the admin panel and demos, also download the frontend ZIP bundles and extract them into your working directory.

After downloading and extracting, start Monibuca from your working directory:

Terminal window
# Linux amd64 example (binary name inside the archive may vary)
tar -xzf monibuca_v6_linux_amd64.tar.gz
chmod +x monibuca_linux_amd64
./monibuca_linux_amd64 -c config.yaml

On macOS the binary is monibuca_darwin_*; on Windows run monibuca.exe.

After extracting the frontend ZIPs, you can access:

  • http://<host>:8180/admin
  • http://<host>:8180/demo/live-room
  • http://<host>:8180/demo/meeting-room
  • http://<host>:8180/demo/customer-service
Terminal window
# Full version (includes FFmpeg)
docker pull langhuihui/monibuca:v6
# Lightweight version (without FFmpeg, based on Alpine)
docker pull monibuca/v6:latest
Terminal window
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 \
-v $(pwd)/config.yaml:/etc/monibuca/config.yaml \
langhuihui/monibuca:v6

The container image includes the following static asset ZIPs (consistent with CI artifacts):

  • admin.zip (zh-CN), admin-en.zip (en)
  • demo-live-room.zip (zh-CN), demo-live-room-en.zip (en)
  • demo-meeting-room.zip (zh-CN), demo-meeting-room-en.zip (en)
  • demo-customer-service.zip (zh-CN), demo-customer-service-en.zip (en)
PortProtocolDescription
8180TCPHTTP service (API, FLV, HLS, WebRTC, admin panel)
8443TCPHTTPS service
1935TCPRTMP
8554TCPRTSP
6000UDPSRT
9000-9100UDPWebRTC media ports
50051TCPgRPC
docker-compose.yml
services:
monibuca:
image: langhuihui/monibuca:v6
ports:
- "8180:8180"
- "8443:8443"
- "1935:1935"
- "8554:8554"
- "50051:50051"
- "6000:6000/udp"
- "9000-9100:9000-9100/udp"
volumes:
- ./config.yaml:/etc/monibuca/config.yaml
- ./data:/monibuca/data
environment:
- M7S_GLOBAL_LOGLEVEL=info
restart: unless-stopped

After startup, visit the following addresses to verify the service is running properly:

Terminal window
# HTTP API
curl http://localhost:8180/api/summary
# Admin panel (open in browser)
# http://localhost:8180/admin
# Live Room Demo
# http://localhost:8180/demo/live-room

Monibuca provides a standalone monibuca-sdk crate. You can develop custom plugins based on the SDK and run them in dynamic loading or WASM sandbox mode.

For detailed plugin development guides, see Plugin Development.


Installation complete? Continue reading Quick Start to learn the basic usage.