-
Notifications
You must be signed in to change notification settings - Fork 0
Add documentation for BBB. #81
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. havent found any reference of FEATURE_VIDEOCONFERENCE_WAITING_ROOM_ENABLED
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
| Add the right permission to the role. Permissions they need are `START_MEETING, JOIN_MEETING`. | ||
|
|
||
| Add "videoconference" to School features (table school) in MongoDB. | ||
CeEv marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Make sure that the fields below exists in the videoconference ltitool object (MongoDB). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could we be more comprehensive, what are the necessary steps to take?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 |
||
|
|
||
| > **💡 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 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. |
||
|
|
||
| ## 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: | ||
CeEv marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| **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. | ||
| 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." | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| { | ||
| "label": "Collabora", | ||
| "position": 1 | ||
| "position": 2 | ||
| } |
Uh oh!
There was an error while loading. Please reload this page.