mynaparrot/plugnmeet-server repository overview

⁠Plug-N-Meet - Scalable, Open source web conferencing system.

Plug-N-Meet is an open source web conferencing system based on high performance WebRTC infrastructure livekit⁠.

⁠Features:

1. Compatible with all devices. Browser recommendation: Google Chrome, Firefox. For iOS: Safari.

2. WebRTC based secured & encrypted communication.

3. Scalable and high performance system written in Go programming language which made it possible to distributed as a single binary⁠ file!

4. Simulcast and Dynacast features will allow you to continue online conferencing even if your internet connection is slow!

5. Easy integration with any existing website or system.

6. Easy customization with functionality, URL, logo, and branding colors.

7. HD audio and video call.

8. HD Screensharing.

9. Lock settings.

10. Raise hand.

11. Chatting with File sharing.

12. MP4 Recordings.

13. RTMP Broadcasting

And many more!

The components of Plug-N-Meet are as follows:

1. plugNmeet-server⁠, the main backend server written in go.

2. plugNmeet-client⁠, which is the main interface/frontend. It's built with React and Redux.

3. plugNmeet-recoder⁠, a node module for recording/rtmp broadcasting which is written in TypeScript.

Demo:

https://demo.plugnmeet.com/login.html⁠

⁠Requirements

1. Livekit configured with Redis.

2. plugNmeet-server configured with same Redis instance using for livekit.

3. Mariadb server for data storage.

We've created an easy to install script which can be used to install all the necessary components in 5 minutes. Check plugNmeet-install⁠ repo.

⁠SDKs & Tools

SDK

1. PHP⁠

Following ready to use extensions:

1. Joomla component⁠

2. Moodle Plugin⁠

3. Wordpress Plugin⁠

Docker:

1. plugnmeet-server⁠

Examples:

1. Example of API⁠

⁠Manually

Create config.yaml from config_sample.yaml⁠ & change necessary info

Using docker

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

You can also follow docker-compose_sample.yaml⁠ file.

You can manually download server from release⁠ page too.

⁠Development

1. Clone the project & navigate to the directory. Make sure you've docker install in your PC. https://www.docker.com/products/docker-desktop⁠

2. Copy to rename this files:

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

1. Now run docker-compose up --build & wait to finish process. If you're running this first time then you may see some errors. Hit control + c or ctrl + c & re-run docker-compose up --build. Everytime need to run this command to boot servers.

Or you can build or run directly if you've go language install in your PC.

go run ./cmd/server/*.go