Skip to content

Commit

Permalink
[INF-208] docs: Updated BigBlueButton configuration doc (#2091)
Browse files Browse the repository at this point in the history 
* docs: Updated BigBlueButton configuration doc

* docs: changed image size

Co-authored-by: ARBISOFT <arbisoft@A006-00483.local>
  • Loading branch information
@ayub02
ayub02 and ARBISOFT committed Nov 29, 2022
1 parent 5956146 commit 3f4433b
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 38 deletions.
90 changes: 52 additions & 38 deletions en_us/shared/course_assets/course_live.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@
Course Live
###########################

Live app can be used to configure video conferencing LTI tools like Zoom. These tools
will help connect educators and learners within the platform.
Live app can be used to configure video conferencing LTI tools like Zoom
and BigBlueButton. These tools will help connect educators and learners
within the platform.

***********************************
Enable or disable course live app
***********************************
Once course live app has been enabled, and an LTI provider has been successfully configured, that provider
will be accessible in "Live" tab in course navigation.
Once course live app has been enabled, and an LTI provider has been
successfully configured, that provider will be accessible in "Live"
tab in course navigation.

1. Go to "Pages & Resources" page and click gear icon on the "Live" configuration card.

Expand All @@ -25,11 +27,12 @@ will be accessible in "Live" tab in course navigation.
:width: 300
:alt: Image of Live app configurations

3. Add credentials (if needed) for the selected LTI provider.
3. Select the LTI provider and add credentials (if needed).

4. Click "Save" to enable the selected LTI provider.

Once successfully enabled, the LTI provider will be accessible in "Live" tab in course navigation.
Once successfully enabled, the LTI provider will be accessible in
"Live" tab in course navigation.


********************************
Expand All @@ -45,12 +48,13 @@ Zoom setup

`Zoom LTI pro app <https://marketplace.zoom.us/apps/f8JUB3eeQv2lXsjKq5B2FA>`_
can be used to integrate Zoom video conferencing at the course level.
Course authors will need to generate their own credentials for the Zoom LTI pro app and
add those credentials in Live app configuration for Zoom.
Course authors will need to generate their own credentials for the Zoom LTI pro
app and add those credentials in Live app configuration for Zoom.

Instructors can use the the LTI Pro app to schedule and start Zoom meetings and students can
see and join these meetings to attend classes, office hours, study groups etc. Learn more about
the app `here <https://marketplace.zoom.us/apps/f8JUB3eeQv2lXsjKq5B2FA>`_.
Instructors can use the the LTI Pro app to schedule and start Zoom meetings and
students can see and join these meetings to attend classes, office hours, study
groups etc. Learn more about the app
`here <https://marketplace.zoom.us/apps/f8JUB3eeQv2lXsjKq5B2FA>`_.

To generate LTI credentials in LTI pro app:

Expand All @@ -69,55 +73,65 @@ To generate LTI credentials in LTI pro app:
b. Add "https://learning.edx.org" to `Approved Domains` setting.


To configure Zoom, navigate to Live app configurations (see `Enable or disable course live app`):
To configure Zoom, navigate to Live app configurations
(see `Enable or disable course live app`):


1. Copy LTI URL, LTI Secret, and LTI Key from LTI pro app and paste in LTI input fields
in Live app configuration for Zoom.
1. Copy LTI URL, LTI Secret, and LTI Key from LTI pro app and paste in LTI input
fields in Live app configuration for Zoom.

2. Add the email associated with your Zoom account, in "Launch Email" field.

Once successfully enabled, Zoom will be accessible in "Live" tab in course navigation.

.. image:: ../../../shared/images/Zoom_in_Live_tab.png
:width: 600
:alt: Image of Zoom rendered in Live tab
:alt: Screenshot of Zoom rendered in Live tab in course navigation


Big Blue Button setup
=====================

`Big blue button <https://bigbluebutton.org/>`_ can be used to integrate video conferencing tool with multiple features.
`Big blue button <https://bigbluebutton.org/>`_ can be used to create virtual classrooms
for a course.

Instructors can use the big blue button to schedule and start meetings and students can
see and join these meetings to attend classes. Learn more about
Instructors can use the big blue button to schedule and start meetings and students
can see and join these meetings to attend classes. Learn more about
the app on `Big Blue button site <https://bigbluebutton.org/teachers/features/>`_.

BBB is available in multiple variants, which are discussed below.
Configuration options for BBB are presented below:

#. If the organization has configured the free tier for the Big blue button,
you can select the Free tier and save the settings. No further configuration is required.
#. **Free tier**: You can use BBB for free with certain limitations. See this
`document <https://bigbluebutton.org/free-bigbluebutton-service-for-edx/>`_
to learn more about the free tier. To configure, select the *Free* option in
*Select a plan* dropdown menu and click *Save*. No further configuration
is required.

.. image:: ../../../shared/images/course_live_bbb_free.png

#. If the Free tier is not configured or you do not want to use free tier,
you can deploy BBB on your own server or use third-party hosting providers.
Please find more information on features available for free tier and commercial
version in this `document <https://bigbluebutton.org/free-bigbluebutton-service-for-edx/>`_.

#. You can use the services listed on the link below. These services provide complete
BBB deployment and support.

https://bigbluebutton.org/commercial-support/
.. image:: ../../../shared/images/course_live_bbb_free.png
:width: 300

#. If you want to deploy BBB on your server please follow this documentation provided by BBB.
#. **Commercial/self-hosted**: You can deploy BBB on your own server or use
third-party hosting providers. Please find more information on features
available in commercial tier in this
`document <https://bigbluebutton.org/free-bigbluebutton-service-for-edx/>`_. You
can use the services listed on this
`link <https://bigbluebutton.org/commercial-support/>`_. These services provide
complete BBB deployment and support.
Once you have obtained LTI credentials for BBB from your own deployment or via
a third-party provider, select the *Commercial/self-hosted* option in
*Select a plan* dropdown menu, add LTI credentials in respective input fields
and click *Save*.

https://docs.bigbluebutton.org/2.5/install.html
If you want to deploy your own server of BBB, please the documentation provided
by BBB in the links below.

https://docs.bigbluebutton.org/admin/lti.html
https://docs.bigbluebutton.org/2.5/install.html

To configure Big blue button, navigate to Live app configurations (see `Enable or disable course live app`):
https://docs.bigbluebutton.org/admin/lti.html

After deployment and creating LTI credentials Copy LTI URL, LTI Secret, and LTI Key from LTI pro app and paste in LTI input fields in Live app configuration for BBB.
Once successfully configured and enabled, BBB will be
accessible in *Live* tab in course navigation.

Once successfully enabled, BBB will be accessible in "Live" tab in course navigation.
.. image:: ../../../shared/images/BBB_in_live_tab.png
:width: 600
:alt: Screenshot of BBB rendered in Live tab in course navigation
Binary file added en_us/shared/images/BBB_in_live_tab.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3f4433b

Please sign in to comment.