Skip to content

Commit

Permalink
fix: few updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@jibon57
jibon57 committed Jan 20, 2025
1 parent 82447d7 commit 3944420
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 24 deletions.
15 changes: 6 additions & 9 deletions Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,20 @@ BINDIR=bin
FILE_PATH=main.go
# The -w and -s flags reduce binary sizes by excluding unnecessary symbols and debug info
# The -buildid= flag makes builds reproducible
GOBUILD=CGO_ENABLED=0 go build -ldflags '-w -s -buildid='
GOBUILD=CGO_ENABLED=0 go build -trimpath -ldflags '-w -s -buildid='

linux-amd64:
GOARCH=amd64 GOOS=linux $(GOBUILD) -o $(BINDIR)/$(NAME)-$@ $(FILE_PATH)

linux-arm64:
GOARCH=arm64 GOOS=linux $(GOBUILD) -o $(BINDIR)/$(NAME)-$@ $(FILE_PATH)

win64:
GOARCH=amd64 GOOS=windows $(GOBUILD) -o $(BINDIR)/$(NAME)-$@.exe $(FILE_PATH)

releases: linux-amd64 linux-arm64 win64
releases: linux-amd64 linux-arm64
chmod +x $(BINDIR)/$(NAME)-*
zip -m -j $(BINDIR)/$(NAME)-linux-amd64.zip $(BINDIR)/$(NAME)-linux-amd64
zip -m -j $(BINDIR)/$(NAME)-linux-arm64.zip $(BINDIR)/$(NAME)-linux-arm64
zip -m -j $(BINDIR)/$(NAME)-win64.zip $(BINDIR)/$(NAME)-win64.exe
cp config_sample.yaml $(BINDIR)/
zip -m -j $(BINDIR)/$(NAME)-linux-amd64.zip $(BINDIR)/$(NAME)-linux-amd64 $(BINDIR)/config_sample.yaml
cp config_sample.yaml $(BINDIR)/
zip -m -j $(BINDIR)/$(NAME)-linux-arm64.zip $(BINDIR)/$(NAME)-linux-arm64 $(BINDIR)/config_sample.yaml

clean:
rm $(BINDIR)/*
Expand All @@ -29,4 +27,3 @@ GITHUB_UPLOAD_URL=$(shell echo $${GITHUB_RELEASE_UPLOAD_URL%\{*})
upload: releases
curl -H "Authorization: token $(GITHUB_TOKEN)" -H "Content-Type: application/zip" --data-binary @$(BINDIR)/$(NAME)-linux-amd64.zip "$(GITHUB_UPLOAD_URL)?name=$(NAME)-linux-amd64.zip"
curl -H "Authorization: token $(GITHUB_TOKEN)" -H "Content-Type: application/zip" --data-binary @$(BINDIR)/$(NAME)-linux-arm64.zip "$(GITHUB_UPLOAD_URL)?name=$(NAME)-linux-arm64.zip"
curl -H "Authorization: token $(GITHUB_TOKEN)" -H "Content-Type: application/zip" --data-binary @$(BINDIR)/$(NAME)-win64.zip "$(GITHUB_UPLOAD_URL)?name=$(NAME)-win64.zip"
33 changes: 18 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Plug-N-Meet - Scalable, Open source web conferencing system.
# Plug-N-Meet - Scalable, Easily customizable, Open source web conferencing system.

Plug-N-Meet is an open source web conferencing system based on high performance WebRTC
infrastructure [livekit](https://github.com/livekit/livekit-server).
Its interface is highly [customizable](https://www.plugnmeet.org/docs/developer-guide/design-customisation)
and [integrates easily](https://www.plugnmeet.org/docs/api/get-client-files) with any website or system.

Please join us [on Discord](https://discord.gg/2X2ZaCHu4C)
to discuss your suggestions and/or any issues you may be experiencing.

Expand All @@ -10,15 +13,15 @@ to discuss your suggestions and/or any issues you may be experiencing.
## 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
2) WebRTC-based secured and encrypted communication;
3) Scalable and high performance system written in Go programming language which made it possible to distribute as a
[single binary](https://github.com/mynaparrot/plugNmeet-server/releases) file!;
4) **Simulcast** and **Dynacast** features will allow you to continue online conferencing even if your internet;
connection is slow! Supported video codecs: `H264`, `VP8`, `VP9` and `AV1`;
5) Easy integration with any existing website or system;
6) Easy customization with functionality, URL, logo, and branding colors;
5) [Easy **integration**](https://www.plugnmeet.org/docs/api/get-client-files) with any existing website or system;
6) [Easy **customization**](https://www.plugnmeet.org/docs/developer-guide/design-customisation) with functionality, URL, logo, and branding colors;
7) HD audio, video call and Screen sharing. **Virtual background** for webcams;
8) **Shared notepad** and **Whiteboard** for live collaboration. Can upload, draw & share various office file (pdf, docx, pptx, xlsx, txt etc.) in whiteboard directly;
8) **Shared notepad** and **Whiteboard** for live collaboration. Can upload, draw and share various office files (pdf, docx, pptx, xlsx, txt etc.) in whiteboard directly;
9) Easy to use **Polls** & voting;
10) Customizable **waiting room**;
11) Various **Lock & control** settings;
Expand All @@ -28,7 +31,7 @@ to discuss your suggestions and/or any issues you may be experiencing.
15) MP4 Recordings;
16) RTMP Broadcasting & RTMP ingress;
17) Speech to text/translation (Powered by [Microsoft Azure](https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/get-started-text-to-speech?pivots=programming-language-go&tabs=linux%2Cterminal#prerequisites));
18) **End-to-End encryption (E2EE)** (`Supported browsers: browser based on Chromium 83+, Google Chrome, Microsoft Edge, Safari, Firefox 117+`);
18) **End-to-End encryption (E2EE)** (`Supported browsers: browser based on Chromium 83+, Google Chrome, Microsoft Edge, Safari, Firefox 117+`) both media (video, audio) and messages (chat, whiteboard);
19) A detailed **analytics report** to assess students' performance in the online classroom;

And many more!
Expand All @@ -40,16 +43,15 @@ The components of Plug-N-Meet are as follows:
2) [plugNmeet-client](https://github.com/mynaparrot/plugNmeet-client), which is the main interface/frontend. It's built
with **React** and **Redux**.

3) [plugNmeet-recoder](https://github.com/mynaparrot/plugNmeet-recorder), a **NodeJS** application for recording/rtmp broadcasting
which is written in **TypeScript**.
3) [plugNmeet-recoder](https://github.com/mynaparrot/plugNmeet-recorder), an application for recording and rtmp broadcasting which is written in **Go** (Golang).

#### Demo

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

## Installation
We've created an easy to install script which can be used to install all the necessary components in few minutes.
Please follow installation guide from here: https://www.plugnmeet.org/docs/installation
We've created an easy-to-install script which can be used to install all the necessary components in few minutes.
Please follow the installation guide from here: https://www.plugnmeet.org/docs/installation

## SDKs & Tools

Expand All @@ -62,17 +64,18 @@ Following ready to use extensions/solutions:

1) [Joomla component](https://github.com/mynaparrot/plugNmeet-joomla)
2) [Moodle Plugin](https://github.com/mynaparrot/moodle-mod_plugnmeet)
3) [Wordpress Plugin](https://github.com/mynaparrot/plugNmeet-wordpress)
3) [WordPress Plugin](https://github.com/mynaparrot/plugNmeet-wordpress)
4) [LTI](https://www.plugnmeet.org/docs/user-guide/lti)

Docker:

1. [plugnmeet-server](https://hub.docker.com/r/mynaparrot/plugnmeet-server)
2. [plugNmeet-etherpad](https://hub.docker.com/r/mynaparrot/plugnmeet-etherpad)
2. [plugnmeet-etherpad](https://hub.docker.com/r/mynaparrot/plugnmeet-etherpad)
3. [plugnmeet-recorder](https://hub.docker.com/r/mynaparrot/plugnmeet-recorder)

Server API information can be found in [API doc](https://www.plugnmeet.org/docs/api/intro) section.

## Manually installation
## Manual installation

**Requirements:**
1) Livekit configured properly.
Expand Down Expand Up @@ -106,4 +109,4 @@ Please follow [this article](https://www.plugnmeet.org/docs/developer-guide/setu
## Contributing

We welcome your suggestions for improving plugNmeet!
Let's chat [on Discord](https://discord.gg/2X2ZaCHu4C) to discuss your suggestions and/or PRs.
Let's chat [on Discord](https://discord.gg/2X2ZaCHu4C) to discuss your suggestions and/or PRs.

0 comments on commit 3944420

Please sign in to comment.