Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions docs/services/bbb/Getting started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Getting started with BigBlueButton (BBB)

## Features

- guestPolicy functionality
- muteOnStart functionality
- allowModsToUnmuteUsers functionality
- welcome functionality

External Expert can join a meeting and will be marked as guest now.
Moderator can mute all participants on start of video conference.
Moderator can allow moderators to unmute users, if they want to.
Moderator can write a welcome message for the Waiting room.

## Local Setup for using the features above in BBB

Add the BBB credentials **HOST** and **SALT** to your env. file, you can find them in 1Password.

Add `FEATURE_VIDEOCONFERENCE_ENABLED=true` in **client** and **server** and
`FEATURE_VIDEOCONFERENCE_WAITING_ROOM_ENABLED=true` to your env. file in the client.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

havent found any reference of FEATURE_VIDEOCONFERENCE_WAITING_ROOM_ENABLED
neither client nor server. What this setting is supposed to do then?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question, i only move the documentations and have the info from yesterday that all of it should be up to date.
Is it is possible to speak with @MartinSchuhmacher to check the details?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FEATURE_VIDEOCONFERENCE_WAITING_ROOM_ENABLED is used within handlebars form-create-videoconference.hbs and teams.js controller to determine the options being shown to the user within the pop up window for creating the conference.


Add the right permission to the role. Permissions they need are `START_MEETING, JOIN_MEETING`.

Add "videoconference" to School features (table school) in MongoDB.

Make sure that the fields below exists in the videoconference ltitool object (MongoDB).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we be more comprehensive, what are the necessary steps to take?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I must put the ball back to you. I have no idea, only move the existing documentation and cleanup obvious points. :D
@MartinSchuhmacher

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is actually meant by this whole area? in my understanding the videoconference is saved within the videoconferences collection and the targetModel describes if its meant for "courses" or "events" (teams) or "video-conference-elements". So this area should definitely be refactored or I missunderstood something here.
@CeEv


> **💡 Tip**
>
> ```
> "isHidden":false,
> "name":"Video-Konferenz mit BigBlueButton",
> "url":"BBB_URL",
> "isLocal":true,
> "logo_url":"/images/tools/bbb/available.png",
> ```

Make sure you started nuxt client.

> FEATURE_VIDEOCONFERENCE_ENABLED=true
> VIDEOCONFERENCE_HOST=https://bbb.staging.messenger.schule/bigbluebutton
> VIDEOCONFERENCE_SALT
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would directly add "(from 1Password)" here if we tell the user already what the other values are.
Also add the note to maybe set FEATURE_COLUMN_BOARD_VIDEOCONFERENCE_ENABLED=true to make the option visible on boards.


## External Experts Waiting room

### Introduction

External experts are currently forbidden from entering BBB conferences due to data protection reasons. However if there is a waiting room and explicit permissions from a moderator (usually a teacher) then they are allowed into such rooms to participate in a video conference.

### Research Results

BBB has built in features to allow for such constellations. It has a waiting room for guests that can be activated and only allows participants to join after a moderator approves it.

These features are currently deactivated in dBildungscloud, but can be activated. In a POC we could confirm that it works as imagined, it just needs to be properly implemented now.

So for future developments we needs the following changes:

**Client:**
- Add an option on room creation, that allows external experts, but puts them in a waiting room

**Server:**
- Add the correct parameters on room creation to allow guests only after moderator permission
- Add a check for external experts to give then the BBB-role "Guest"

Those changes will be most likely done in the legacy code due to delivery timeline reasons.
8 changes: 8 additions & 0 deletions docs/services/bbb/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "BigBlueButton",
"position": 1,
"link": {
"type": "generated-index",
"description": "Learn about the BigBlueButton service."
}
}
2 changes: 1 addition & 1 deletion docs/services/collabora/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Collabora",
"position": 1
"position": 2
}
2 changes: 1 addition & 1 deletion docs/services/etherpad/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Etherpad",
"position": 2,
"position": 3,
"link": {
"type": "generated-index",
"description": "Learn about the etherpad repo."
Expand Down
2 changes: 1 addition & 1 deletion docs/services/files-storage/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Files Storage",
"position": 3,
"position": 4,
"link": {
"type": "generated-index",
"description": "Learn about the files-storage repo."
Expand Down
2 changes: 1 addition & 1 deletion docs/services/h5p/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "H5P",
"position": 4,
"position": 5,
"link": {
"type": "generated-index",
"description": "Learn about the H5P services & modules."
Expand Down
2 changes: 1 addition & 1 deletion docs/services/moin-punkt-schule/_category_ .json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "moin-punkt-schule",
"position": 5,
"position": 6,
"link": {
"type": "generated-index",
"description": "Learn about the moin.schule service."
Expand Down
2 changes: 1 addition & 1 deletion docs/services/nuxt-client/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Nuxt Client",
"position": 6,
"position": 7,
"link": {
"type": "generated-index",
"description": "Learn about the nuxt-client repo."
Expand Down
2 changes: 1 addition & 1 deletion docs/services/provining/_category_ .json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "provining",
"position": 7,
"position": 8,
"link": {
"type": "generated-index",
"description": "Learn about the provining service."
Expand Down
2 changes: 1 addition & 1 deletion docs/services/schulcloud-client/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Schulcloud Client",
"position": 8,
"position": 9,
"link": {
"type": "generated-index",
"description": "Learn about the schulcloud-client repo."
Expand Down
2 changes: 1 addition & 1 deletion docs/services/schulcloud-server/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Schulcloud Server",
"position": 1,
"position": 10,
"link": {
"type": "generated-index",
"description": "Learn about the schulcloud-server repo."
Expand Down
2 changes: 1 addition & 1 deletion docs/services/tldraw-server/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Tldraw Server",
"position": 3,
"position": 11,
"link": {
"type": "generated-index",
"description": "Learn about the tldraw-server repo."
Expand Down
2 changes: 1 addition & 1 deletion docs/services/tsp-sync/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "TSP Synchronisation",
"position": 9,
"position": 12,
"link": {
"type": "generated-index",
"description": "Learn about the Synchronisation of Userdata from the 'Thüringer Schulportal'"
Expand Down