https://github.com/bigbluebutton/plugin-template
A template repository reused for most BigBlueButton plugins
https://github.com/bigbluebutton/plugin-template
Last synced: 10 months ago
JSON representation
A template repository reused for most BigBlueButton plugins
- Host: GitHub
- URL: https://github.com/bigbluebutton/plugin-template
- Owner: bigbluebutton
- License: lgpl-3.0
- Created: 2024-06-10T15:23:17.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T19:36:46.000Z (almost 2 years ago)
- Last Synced: 2024-07-19T03:36:42.368Z (almost 2 years ago)
- Language: JavaScript
- Size: 16.6 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Repository of a plugin for BigBlueButton
## Description
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:
```bash
cd $HOME/src/plugin-template
npm ci
npm run build-bundle
```
The above command will generate the `dist` folder, containing the bundled JavaScript file named `.js`. This file can be hosted on any HTTPS server along with its `manifest.json`.
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":"/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`