cloud_bbb/README.md

109 lines
4.8 KiB
Markdown
Raw Normal View History

2020-04-26 11:36:41 +02:00
# BigBlueButton™ integration for Nextcloud
2021-02-13 18:48:21 +01:00
![Static analysis](https://github.com/sualko/cloud_bbb/workflows/Static%20analysis/badge.svg)
![PHP Tests](https://github.com/sualko/cloud_bbb/workflows/PHP%20Tests/badge.svg)
![Lint](https://github.com/sualko/cloud_bbb/workflows/Lint/badge.svg)
2020-04-29 12:03:40 +02:00
![Downloads](https://img.shields.io/github/downloads/sualko/cloud_bbb/total.svg)
![GitHub release](https://img.shields.io/github/release/sualko/cloud_bbb.svg)
2020-06-18 16:03:16 +02:00
2020-06-18 11:11:40 +02:00
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/sualko)
2020-04-29 12:03:40 +02:00
This app allows to create meetings with an external installation of [BigBlueButton](https://bigbluebutton.org).
:clap: Developer wanted! If you have time it would be awesome if you could help to enhance this application.
__This app uses BigBlueButton and is not endorsed or certified by BigBlueButton Inc. BigBlueButton and the BigBlueButton Logo are trademarks of BigBlueButton Inc.__
2020-04-30 09:54:25 +02:00
![Screenshot configuration](https://github.com/sualko/cloud_bbb/raw/master/docs/screenshot-configuration.png)
2020-04-29 12:03:40 +02:00
## :heart_eyes: Features
This integration provides the following features:
* **Room setup** Create multiple room configurations with name, welcome message, ...
* **Share guest link** Share the room link with all your guests
2020-09-01 10:03:40 +02:00
* **Share rooms** Share rooms with members, groups or circles
2020-04-29 12:03:40 +02:00
* **Custom presentation** Start a room with a selected presentation from your file browser
2020-05-17 12:07:24 +02:00
* **Manage recordings** View, share and delete recordings for your rooms
2020-09-01 10:03:40 +02:00
* **Restrictions** Restrict room creation to certain groups
2020-09-24 14:19:54 +02:00
* **Activities** Get an overview of your room activities
2020-04-29 12:03:40 +02:00
## :rocket: Install it
The easiest way to install this app is by using the [Nextcloud app store](https://apps.nextcloud.com/apps/bbb).
If you like to build from source, please continue reading.
2020-04-26 11:36:41 +02:00
To install it change into your Nextcloud's apps directory:
cd nextcloud/apps
Then run:
2020-04-26 13:26:34 +02:00
git clone https://github.com/sualko/cloud_bbb.git bbb
2020-04-26 11:36:41 +02:00
Then install the dependencies using:
make build
2020-04-29 12:03:40 +02:00
## :gear: Configure it
2020-04-29 12:12:15 +02:00
Get your BBB API url and secret by executing `sudo bbb-conf --secret` on your
BBB server.
2020-04-29 12:12:15 +02:00
```
$ sudo bbb-conf --secret
URL: https://bbb.your.domain/bigbluebutton/
Secret: abcdefghijklmnopqrstuvwxyz012345679
Link to the API-Mate:
https://mconf.github.io/api-mate/#server=https://...
```
Enter these values in the additional settings section on the admin
configuration page of your Nextcloud instance.
2021-02-13 19:20:26 +01:00
![Screenshot admin section](https://github.com/sualko/cloud_bbb/raw/master/docs/screenshot-admin.png)
2020-04-29 12:03:40 +02:00
## Create your first room
2020-04-29 12:12:15 +02:00
Go to the BigBlueButton section inside your personal settings page and enter a
2020-04-29 12:03:40 +02:00
room name. That's it. You can now distribute the room url.
2020-04-29 12:03:40 +02:00
## Enter a room from files
Use the ... menu and select the desired BBB configuration to enter the room.
Beware that if the room is already running the presentation will **not** be
2020-04-30 09:54:25 +02:00
updated. Entering a room with a defined presentation works only if link shares
are enabled and do not require authentication. See [#1](https://github.com/sualko/cloud_bbb/issues/1)
for details.
2020-04-29 12:03:40 +02:00
![Screenshot file browser](https://github.com/sualko/cloud_bbb/raw/master/docs/screenshot-file-browser.png)
2020-05-17 12:07:24 +02:00
## :notebook: Notes
2020-05-17 12:04:35 +02:00
- By using the [Link Editor](https://apps.nextcloud.com/apps/files_linkeditor)
2020-04-30 09:54:25 +02:00
you can share rooms as any other file
2020-05-17 12:07:24 +02:00
## :pick: Troubleshooting
2020-04-30 09:54:25 +02:00
- Before installing, make sure your BBB is running correctly
- If the room doesn't appear in the ... menu of files, a browser/cache reload
2020-04-29 12:03:40 +02:00
might help
2020-05-17 12:04:35 +02:00
2020-05-17 12:07:24 +02:00
## :heart: Sponsors
2020-05-17 12:04:35 +02:00
Writing such an application is a lot of work and therefore we are specially
thankful for people and organisations who are sponsoring features or bug fixes:
- [Medienwerkstatt Minden-Lübbecke e.V.](https://www.medienwerkstatt.org) manage recordings ([#19])
2020-06-18 16:03:16 +02:00
- [Deutscher Bundesjugendring](https://www.dbjr.de) version [0.4.0], version [0.5.0]
2020-08-29 14:53:11 +02:00
- [Graz University of Technology](https://www.tugraz.at) form action ([#47]), navigation entry ([#31]), restrictions ([#43], [#53]), circles ([#61])
2021-01-27 15:16:47 +01:00
- [Arawa](https://www.arawa.fr) UX audit
- [Niedersächsisches Landesinstitut für schulische Qualitätsentwicklung Netzwerk Medienberatung](https://nlq.niedersachsen.de/) moderator url, UX improvements
2020-05-17 12:04:35 +02:00
If you are looking for other ways to contribute to this project, you are welcome
to look at our [contributor guidelines]. Every contribution is valuable :tada:.
[contributor guidelines]: https://github.com/sualko/cloud_bbb/blob/master/.github/contributing.md
2020-06-10 17:27:10 +02:00
[#19]: https://github.com/sualko/cloud_bbb/issues/19
2020-08-29 14:53:11 +02:00
[#47]: https://github.com/sualko/cloud_bbb/issues/47
[#31]: https://github.com/sualko/cloud_bbb/issues/31
[#43]: https://github.com/sualko/cloud_bbb/issues/43
[#53]: https://github.com/sualko/cloud_bbb/issues/53
[#61]: https://github.com/sualko/cloud_bbb/issues/61
2020-06-18 16:03:16 +02:00
[0.4.0]: https://github.com/sualko/cloud_bbb/releases/tag/v0.4.0
[0.5.0]: https://github.com/sualko/cloud_bbb/releases/tag/v0.5.0