mynaparrot/plugnmeet-server

Plug-N-Meet - 可扩展的开源网络会议系统

Plug-N-Meet是一款基于高性能WebRTC基础设施https://github.com/livekit/livekit-server开发的开源网络会议系统。

概述

Plug-N-Meet是一款基于WebRTC技术栈的开源网络会议解决方案，旨在提供稳定、高效的在线协作体验。该系统采用Go语言开发，具备高性能和可扩展性，可作为单一二进制文件分发，支持多设备访问，且易于与现有系统集成及定制。

核心功能与特性

1. 兼容所有设备，推荐浏览器：Google Chrome、Firefox；iOS设备推荐Safari。
2. 基于WebRTC的安全加密通信。
3. 采用Go语言开发的可扩展高性能系统，支持以https://github.com/mynaparrot/plugNmeet-server/releases形式分发。
4. Simulcast（联播） 和 Dynacast（动态流） 特性，确保在网络连接较差时仍能维持会议流畅进行。
5. 易于与任何现有网站或系统集成。
6. 支持功能、URL、logo及品牌颜色的自定义配置。
7. 高清音视频通话。
8. 高清屏幕共享。
9. 会议锁定设置。
10. 举手功能。
11. 聊天及文件共享。
12. MP4格式录制。
13. RTMP直播。

系统组件

1. https://github.com/mynaparrot/plugNmeet-server：核心后端服务，使用Go语言开发。
2. https://github.com/mynaparrot/plugNmeet-client：前端界面，基于React和Redux构建。
3. https://github.com/mynaparrot/plugNmeet-recorder：录制/RTMP直播模块，基于TypeScript开发的Node.js组件。

使用场景与适用范围

• 企业远程会议：支持高清音视频、屏幕共享及文件协作，满足团队日常沟通需求。
• 在线教育：结合举手、聊天功能，实现师生互动；支持录制功能，方便课程回放。
• 网络研讨会：通过RTMP直播扩展受众范围，支持多设备访问。
• 远程协作：提供安全加密通信，确保团队敏感信息传输安全。

环境要求

1. 已配置Redis的Livekit服务。
2. plugNmeet-server需配置与Livekit相同的Redis实例。
3. Mariadb数据库用于数据存储。

可通过https://github.com/mynaparrot/plugNmeet-install脚本快速安装所有必要组件，全程约5分钟。

SDK与工具

SDK

• https://github.com/mynaparrot/plugNmeet-sdk-php

扩展插件

• https://github.com/mynaparrot/plugNmeet-joomla
• https://github.com/mynaparrot/plugNmeet-moodle
• https://github.com/mynaparrot/plugNmeet-wordpress

Docker镜像

• https://hub.docker.com/r/mynaparrot/plugnmeet-server

API示例

• https://github.com/mynaparrot/plugNmeet-server/wiki/API-Information-(examples)

使用方法

手动配置

1. 从https://raw.githubusercontent.com/mynaparrot/plugNmeet-server/main/config_sample.yaml下载配置文件模板，修改为`config.yaml`并配置必要信息。

Docker部署

单容器运行

bash
docker run --rm -p 8080:8080 \
    -v $PWD/config.yaml:/config.yaml \
    docker.xuanyuan.run/mynaparrot/plugnmeet-server \
    --config /config.yaml

Docker Compose部署

1. 下载https://raw.githubusercontent.com/mynaparrot/plugNmeet-server/main/docker-compose_sample.yaml并保存为`docker-compose.yaml`。
2. 运行以下命令启动服务：

bash
docker-compose up --build

手动下载

可从https://github.com/mynaparrot/plugNmeet-server/releases直接下载服务器二进制文件。

开发指南

1. 克隆项目并进入目录，确保本地已安装Docker（https://www.docker.com/products/docker-desktop）。
2. 复制配置文件模板：

bash
cp config_sample.yaml config.yaml
cp livekit_sample.yaml livekit.yaml
cp docker-compose_sample.yaml docker-compose.yaml

3. 构建并启动服务：

bash
docker-compose up --build

首次运行可能出现错误，按control + c或ctrl + c终止后重新执行上述命令。

本地直接运行（需安装Go环境）

bash
go run ./cmd/server/*.go