Michelle/bbb-plugin-test
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ref: Update template to use the new plugin manifest structure (#10)

Browse Source 
* [manifest-structure] - added manifest structure to template

* Update README.md

Co-authored-by: Anton Georgiev <antobinary@users.noreply.github.com>

---------

Co-authored-by: Anton Georgiev <antobinary@users.noreply.github.com>
This commit is contained in:
Guilherme Pereira Leme
2024-10-29 17:12:23 -03:00
committed by GitHub
parent 1a8d354945
commit 3eba8525da
7 changed files with 10380 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -2,16 +2,31 @@
## Description
A brief description of the plugin including a screenshot or a short video.
## Running the Plugin From Source Code
A brief description of the plugin including a screenshot and/or a short video.
## Building the Plugin
To build the plugin for production use, follow these steps:
## Background
```bash
cd $HOME/src/plugin-template
npm ci
npm run build-bundle
```
BigBlueButton added supports for plugins in 2024 with BBB 3.0.
Check the official [documentation website](https://docs.bigbluebutton.org) for more information.
The above command will generate the `dist` folder, containing the bundled JavaScript file named `<plugin-name>.js`. This file can be hosted on any HTTPS server along with its `manifest.json`.
This plugin repository was created using the plugin [template repository for BigBlueButton](https://github.com/bigbluebutton/plugin-template) hosted on GitHub.
If you install the Plugin separated to the manifest, remember to change the `javascriptEntrypointUrl` in the `manifest.json` to the correct endpoint.
To use the plugin in BigBlueButton, send this parameter along in create call:
```
pluginManifests=[{"url":"<your-domain>/path/to/manifest.json"}]
```
Or additionally, you can add this same configuration in the `.properties` file from `bbb-web` in `/usr/share/bbb-web/WEB-INF/classes/bigbluebutton.properties`
## Development mode
As for development mode (running this plugin from source), please, refer back to https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk section `Running the Plugin from Source`