Merge pull request #20332 from antobinary/port-docs-27

docs: Various fixes by @MBM1607
This commit is contained in:
Anton Georgiev 2024-05-24 12:04:03 -04:00 committed by GitHub
commit ee873794e9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
16 changed files with 35 additions and 27 deletions

View File

@ -630,7 +630,7 @@ mediaThresholds:
perUser: 0 perUser: 0
``` ```
For example, the following settings would limit the overall number of media across all meetings to 1000 streams, the maximum number of webcam streams per meeting to 300, and no limit on the number of webcam streams per user. For example, the following settings would limit the overall number of media accross all meetings to 1000 streams, the maximum number of webcam streams per meeting to 300, and no limit on the number of webcam streams per user.
``` ```
mediaThresholds: mediaThresholds:
@ -1457,7 +1457,7 @@ Useful tools for development:
| `userdata-bbb_skip_check_audio=` | If set to `true`, the user will not see the "echo test" prompt when sharing audio | `false` | | `userdata-bbb_skip_check_audio=` | If set to `true`, the user will not see the "echo test" prompt when sharing audio | `false` |
| `userdata-bbb_skip_check_audio_on_first_join=` | (Introduced in BigBlueButton 2.3) If set to `true`, the user will not see the "echo test" when sharing audio for the first time in the session. If the user stops sharing, next time they try to share audio the echo test window will be displayed, allowing for configuration changes to be made prior to sharing audio again | `false` | | `userdata-bbb_skip_check_audio_on_first_join=` | (Introduced in BigBlueButton 2.3) If set to `true`, the user will not see the "echo test" when sharing audio for the first time in the session. If the user stops sharing, next time they try to share audio the echo test window will be displayed, allowing for configuration changes to be made prior to sharing audio again | `false` |
| `userdata-bbb_override_default_locale=` | (Introduced in BigBlueButton 2.3) If set to `de`, the user's browser preference will be ignored - the client will be shown in 'de' (i.e. German) regardless of the otherwise preferred locale 'en' (or other) | `null` | | `userdata-bbb_override_default_locale=` | (Introduced in BigBlueButton 2.3) If set to `de`, the user's browser preference will be ignored - the client will be shown in 'de' (i.e. German) regardless of the otherwise preferred locale 'en' (or other) | `null` |
| `userdata-bbb_hide_presentation_on_join` | (Introduced in BigBlueButton 2.6) If set to `true` it will make the user enter the meeting with presentation minimized (Only for non-presenters), not peremanent. | `false` | | `userdata-bbb_hide_presentation_on_join` | (Introduced in BigBlueButton 2.6) If set to `true` it will make the user enter the meeting with presentation minimized (Only for non-presenters), not permanent. | `false` |
| `userdata-bbb_direct_leave_button` | (Introduced in BigBlueButton 2.7) If set to `true` it will make a button to leave the meeting appear to the left of the Options menu. | `false` | | `userdata-bbb_direct_leave_button` | (Introduced in BigBlueButton 2.7) If set to `true` it will make a button to leave the meeting appear to the left of the Options menu. | `false` |
| `userdata-bbb_show_animations_default` | (Introduced in BigBlueButton 2.7.4) If set to `false` the default value for the Animations toggle in Settings will be 'off' | `true` | | `userdata-bbb_show_animations_default` | (Introduced in BigBlueButton 2.7.4) If set to `false` the default value for the Animations toggle in Settings will be 'off' | `true` |
@ -1502,7 +1502,7 @@ Useful tools for development:
| `userdata-bbb_presenter_tools=` | Pass in an array of permitted tools from `settings.yml` | all enabled | | `userdata-bbb_presenter_tools=` | Pass in an array of permitted tools from `settings.yml` | all enabled |
| `userdata-bbb_multi_user_tools=` | Pass in an array of permitted tools for non-presenters from `settings.yml` | all enabled | | `userdata-bbb_multi_user_tools=` | Pass in an array of permitted tools for non-presenters from `settings.yml` | all enabled |
#### Themeing & styling parameters #### Theming & styling parameters
| Parameter | Description | Default value | | Parameter | Description | Default value |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------- | | -------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------- |

View File

@ -75,7 +75,7 @@ BigBlueButton web application is a Java-based application written in Scala. It i
The BigBlueButton API provides a third-party integration (such as the [BigBlueButtonBN plugin](https://moodle.org/plugins/mod_bigbluebuttonbn) for Moodle) with an endpoint to control the BigBlueButton server. The BigBlueButton API provides a third-party integration (such as the [BigBlueButtonBN plugin](https://moodle.org/plugins/mod_bigbluebuttonbn) for Moodle) with an endpoint to control the BigBlueButton server.
Every access to BigBlueButton comes through a front-end portal (we refer to as a third-party application). BigBlueButton integrates Moodle, Wordpress, Canvas, Sakai, MatterMost, and others (see [third-party integrations](https://bigbluebutton.org/integrations/)). BigBlueButton comes with its own front-end called [Greenlight](/greenlight/v3/install). When using a learning management system (LMS) such as Moodle, teachers can setup BigBlueButton rooms within their course and students can access the rooms and their recordings. Every access to BigBlueButton comes through a front-end portal (we refer to as a third-party application). BigBlueButton integrates Moodle, Wordpress, Canvas, Sakai, MatterMost, and others (see [third-party integrations](https://bigbluebutton.org/schools/integrations/)). BigBlueButton comes with its own front-end called [Greenlight](/greenlight/v3/install). When using a learning management system (LMS) such as Moodle, teachers can setup BigBlueButton rooms within their course and students can access the rooms and their recordings.
The BigBlueButton comes with some simple [API demos](/administration/install#install). Regardless of which front-end you use, they all use the [API](/development/api) under the hood. The BigBlueButton comes with some simple [API demos](/administration/install#install). Regardless of which front-end you use, they all use the [API](/development/api) under the hood.
@ -132,11 +132,11 @@ The conversion process sends progress messages to the client through the Redis p
The diagram below describes the flow of the presentation conversion. We take in consideration the configuration for enabling and disabling SWF, SVG and PNG conversion. The diagram below describes the flow of the presentation conversion. We take in consideration the configuration for enabling and disabling SWF, SVG and PNG conversion.
![General Conversion Flow](/img/diagrams/Presentation Conversion Diagram-General Conversion Flow.png) ![General Conversion Flow](/img/diagrams/presentation-conversion-diagram-general-conversion-flow.png)
Then below the SVG conversion flow. It covers the conversion fallback. Sometimes we detect that the generated SVG file is heavy to load by the browser, we use the fallback to put a rasterized image inside the SVG file and make its loading light for the browser. Then below the SVG conversion flow. It covers the conversion fallback. Sometimes we detect that the generated SVG file is heavy to load by the browser, we use the fallback to put a rasterized image inside the SVG file and make its loading light for the browser.
![SVG Conversion Flow](/img/diagrams/Presentation Conversion Diagram-SVG Conversion Flow.png) ![SVG Conversion Flow](/img/diagrams/presentation-conversion-diagram-svg-conversion-flow.png)
### Internal network connections ### Internal network connections

View File

@ -195,4 +195,4 @@ When a user joins a session, a dialogue box will appear signifying which auto ro
<hr/> <hr/>
If you have any questions or feedback, please join [the BigBlueButton community](https://bigbluebutton.org/support/community/) and post them to the [bigbluebutton-dev](https://groups.google.com/forum/#!forum/bigbluebutton-dev) mailing list. We look forward to hearing from you. If you have any questions or feedback, please join [the BigBlueButton community](https://bigbluebutton.org/community-support/) and post them to the [bigbluebutton-dev](https://groups.google.com/forum/#!forum/bigbluebutton-dev) mailing list. We look forward to hearing from you.

View File

@ -17,7 +17,7 @@ BigBlueButton records all the events and media data generated during a BigBlueBu
If you want to see the Record and Playback (RaP) feature in action, there is a [demo](https://demo.bigbluebutton.org/gl) where you can record a BigBlueButton session and play it back after it is listed under "Recorded Sessions" on the same page. This demo is also available on your server if you have [installed it](/administration/install#6.-install-api-demos). Processing and publishing the media for playback after the end of your session may take a few minutes. If you want to see the Record and Playback (RaP) feature in action, there is a [demo](https://demo.bigbluebutton.org/gl) where you can record a BigBlueButton session and play it back after it is listed under "Recorded Sessions" on the same page. This demo is also available on your server if you have [installed it](/administration/install#6.-install-api-demos). Processing and publishing the media for playback after the end of your session may take a few minutes.
Like BigBlueButton sessions, the management of recordings should be handled by [third-party software](https://bigbluebutton.org/integrations/). Third-party software consumes the [BigBlueButton API](/development/api) to accomplish that. As a user, you may want to use third-party software which sets the right value to the parameter "record". As a developer, you may want to use a (not official) library that implements the API calls in your preferred language or implement it by yourself. Like BigBlueButton sessions, the management of recordings should be handled by [third-party software](https://bigbluebutton.org/schools/integrations/). Third-party software consumes the [BigBlueButton API](/development/api) to accomplish that. As a user, you may want to use third-party software which sets the right value to the parameter "record". As a developer, you may want to use a (not official) library that implements the API calls in your preferred language or implement it by yourself.
From a technical point of view, in the BigBlueButton API, when you pass the parameter `record=true` with [create](/development/api#create), BigBlueButton will create a session that has recording enabled. In this case, it will add a new button to the toolbar at the top of the window with a circle icon which a moderator in the session can use to indicate sections of the meeting to be recorded. From a technical point of view, in the BigBlueButton API, when you pass the parameter `record=true` with [create](/development/api#create), BigBlueButton will create a session that has recording enabled. In this case, it will add a new button to the toolbar at the top of the window with a circle icon which a moderator in the session can use to indicate sections of the meeting to be recorded.
@ -27,7 +27,7 @@ After the session finishes, the BigBlueButton server will run an archive script
After the recording is archived, BigBlueButton will run one (or more) ingest and processing scripts, named workflows, that will _process_ and _publish_ the captured data into a format for _playback_. After the recording is archived, BigBlueButton will run one (or more) ingest and processing scripts, named workflows, that will _process_ and _publish_ the captured data into a format for _playback_.
![Record and Playback - Overview](/img/diagrams/Record and Playback Service Diagram-RAP - Overview.png) ![Record and Playback - Overview](/img/diagrams/record-and-playback-service-diagram-rap-overview.png)
## Record and Playback Phases ## Record and Playback Phases
@ -50,26 +50,26 @@ Whiteboard, cursor, chat and other events are stored on Redis. Webcam videos (.f
The Archive phase involves placing the captured media and events into a **raw** directory. That directory contains ALL the necessary media and files to work with. The Archive phase involves placing the captured media and events into a **raw** directory. That directory contains ALL the necessary media and files to work with.
![Record and Playback - Archive](/img/diagrams/Record and Playback Service Diagram-RAP - Archive.png) ![Record and Playback - Archive](/img/diagrams/record-and-playback-service-diagram-rap-archive.png)
### Sanity ### Sanity
The Sanity phase involves checking that all the archived files are _valid_ for processing. For example The Sanity phase involves checking that all the archived files are _valid_ for processing. For example
that media files have not zero length and events were archived. that media files have not zero length and events were archived.
![Record and Playback - Sanity](/img/diagrams/Record and Playback Service Diagram-RAP - Sanity.png) ![Record and Playback - Sanity](/img/diagrams/record-and-playback-service-diagram-rap-sanity.png)
### Process ### Process
The Process phase involves processing the valid archived files of the recording according to the workflow (e.g., presentation). Usually, it involves parsing the archived events, converting media files to other formats or concatenating them, etc. The Process phase involves processing the valid archived files of the recording according to the workflow (e.g., presentation). Usually, it involves parsing the archived events, converting media files to other formats or concatenating them, etc.
![Record and Playback - Process](/img/diagrams/Record and Playback Service Diagram-RAP - Process.png) ![Record and Playback - Process](/img/diagrams/record-and-playback-service-diagram-rap-process.png)
### Publish ### Publish
The Publish phase involves generating metadata and taking many or all the processed files and placing them in a directory exposed publicly for later playback. The Publish phase involves generating metadata and taking many or all the processed files and placing them in a directory exposed publicly for later playback.
![Record and Playback - Publish](/img/diagrams/Record and Playback Service Diagram-RAP - Publish.png) ![Record and Playback - Publish](/img/diagrams/record-and-playback-service-diagram-rap-publish.png)
### Post-Scripts ### Post-Scripts
@ -87,7 +87,15 @@ Some examples of things you might use the post-scripts to do:
The Playback phase involves taking the published files (audio, webcam, deskshare, chat, events, notes, captions, polls, metadata) and playing them in the browser. The Playback phase involves taking the published files (audio, webcam, deskshare, chat, events, notes, captions, polls, metadata) and playing them in the browser.
Using the workflow **presentation**, playback is handled by HTML, CSS, and Javascript libraries; it is fully available in Mozilla Firefox and Google Chrome (also in Android devices). In other browsers like Opera or Safari the playback will work without all its functionality, e.g., thumbnails won't be shown. There is not a unique video file for playback, there is not an available button or link to download the recording. We have opened an [issue](https://github.com/bigbluebutton/bigbluebutton/issues/1969) for this enhancement. Using the workflow **presentation**, playback is handled by HTML, CSS, and Javascript libraries;
it is fully available in Mozilla Firefox and Google Chrome (also on Android devices). In other
browsers like Opera or Safari the playback will work without all its functionality, e.g.,
thumbnails won't be shown.
There is not a unique video file for playback in the **presentation** workflow.
However, the **video** workflow can be used to generate that unique video file.
This workflow is not enabled by default. [See section below](#deploying-other-formats) to
learn how to enable it.
## Media storage ## Media storage

View File

@ -446,7 +446,7 @@ Additionally, you can see [commercial support](https://bigbluebutton.org/commerc
Since BigBlueButton is controlled by its [API](/development/api), there isn't an administrative panel for BigBlueButton. Most of the server maintenance functions are handled by [bbb-conf](/administration/bbb-conf). Since BigBlueButton is controlled by its [API](/development/api), there isn't an administrative panel for BigBlueButton. Most of the server maintenance functions are handled by [bbb-conf](/administration/bbb-conf).
The most common way to use BigBlueButton is to use an existing application that has a plugin. See [list of integrations](https://bigbluebutton.org/integrations/). The most common way to use BigBlueButton is to use an existing application that has a plugin. See [list of integrations](https://bigbluebutton.org/schools/integrations/).
BigBlueButton also comes with an easy-to-use front-end called [Greenlight](/greenlight/v3/install). BigBlueButton also comes with an easy-to-use front-end called [Greenlight](/greenlight/v3/install).
@ -526,7 +526,7 @@ Absolutely. To see an example of this, check out [GreenLight on our pool of demo
#### How do I setup new classrooms in BigBlueButton #### How do I setup new classrooms in BigBlueButton
If you are using Sakai, Moodle, Drupal, Joomla, Wordpress or other systems that already have a [BigBlueButton integration](https://bigbluebutton.org/support), then installing the integration provides the easiest way to enable your users to access BigBlueButton sessions. If you are using Sakai, Moodle, Drupal, Joomla, Wordpress or other systems that already have a [BigBlueButton integration](https://bigbluebutton.org/schools/integrations/), then installing the integration provides the easiest way to enable your users to access BigBlueButton sessions.
Alternatively, you can set up [Greenlight](/greenlight/v3/install) to be able to easily manage classrooms. Alternatively, you can set up [Greenlight](/greenlight/v3/install) to be able to easily manage classrooms.
@ -883,7 +883,7 @@ Log and configuration file information can be found [here](/administration/confi
#### When will feature X be implemented #### When will feature X be implemented
BigBlueButton is built by a group of (very determined) open source developers that volunteer their time to the project. Some of us also work for companies that provide [commercial support](https://bigbluebutton.org/support) for BigBlueButton. BigBlueButton is built by a group of (very determined) open source developers that volunteer their time to the project. Some of us also work for companies that provide [commercial support](https://bigbluebutton.org/commercial-support) for BigBlueButton.
We want to make BigBlueButton the leading open source web conferencing system for on-line learning. That's no small task, but we've been focused since 2008 on this goal. Today, BigBlueButton is used all around the world and localized into over 50 languages. We want to make BigBlueButton the leading open source web conferencing system for on-line learning. That's no small task, but we've been focused since 2008 on this goal. Today, BigBlueButton is used all around the world and localized into over 50 languages.
@ -905,7 +905,7 @@ If your feature belongs in category (3), you have options. BigBlueButton is an o
The BigBlueButton project does not accept donations. We think it's a poor business model for running an open source project as it suggests the developers are working for charity. The BigBlueButton project does not accept donations. We think it's a poor business model for running an open source project as it suggests the developers are working for charity.
If you want to help the project financially, you can approach some of the companies offering [commercial support](https://bigbluebutton.org/support) for BigBlueButton and engage their services. Doing so creates a healthy ecosystem around the project where companies are encouraged to contribute their resources to improve the project to create a larger pool of potential customers wanting their services. If you want to help the project financially, you can approach some of the companies offering [commercial support](https://bigbluebutton.org/commercial-support) for BigBlueButton and engage their services. Doing so creates a healthy ecosystem around the project where companies are encouraged to contribute their resources to improve the project to create a larger pool of potential customers wanting their services.
We appreciate positive feedback on our project as well. If you are on Twitter, send us a tweet to `@bigbluebutton`. That helps raise awareness of our project so others can benefit from it as well. We appreciate positive feedback on our project as well. If you are on Twitter, send us a tweet to `@bigbluebutton`. That helps raise awareness of our project so others can benefit from it as well.

View File

@ -12,7 +12,7 @@ keywords:
Have you encountered a problem with BigBluebutton? Have you encountered a problem with BigBluebutton?
If you need the problem to be solved quickly or lack the requirded technical knowledge, we suggest you [reach out to the companies](https://bigbluebutton.org/commercial-support/) that provide commercial support. The revenue they earn helps to improve BigBlueButton for everyone. If you need the problem to be solved quickly or lack the required technical knowledge, we suggest you [reach out to the companies](https://bigbluebutton.org/commercial-support/) that provide commercial support. The revenue they earn helps to improve BigBlueButton for everyone.
If you otherwise wish to tackle the problem yourself, the BigBlueButton project provides detailed documentation (what you are reading now), tutorial videos, [issues database](https://github.com/bigbluebutton/bigbluebutton/issues), and [public mailing lists](https://bigbluebutton.org/community-support/). If you otherwise wish to tackle the problem yourself, the BigBlueButton project provides detailed documentation (what you are reading now), tutorial videos, [issues database](https://github.com/bigbluebutton/bigbluebutton/issues), and [public mailing lists](https://bigbluebutton.org/community-support/).

View File

@ -160,7 +160,7 @@ For example:
No. Scalability improves a lot with mediasoup, but there are still a couple of bottlenecks that can be hit as far **as far as the media stack is concerned**. Namely: No. Scalability improves a lot with mediasoup, but there are still a couple of bottlenecks that can be hit as far **as far as the media stack is concerned**. Namely:
- The signaling server (bbb-webrtc-sfu): it does not scale vertically indefinitely. - The signaling server (bbb-webrtc-sfu): it does not scale vertically indefinitely.
- The mediasoup worker balancing algorithm implemented by bbb-webrtc-sfu is still focused on multiparty meetings with a restrained number of users. If your goal is thousand-user 1-N (streaming-like) meetings, you may max out CPU usage on certain mediasoup workers even though there are other idle oworkers free. - The mediasoup worker balancing algorithm implemented by bbb-webrtc-sfu is still focused on multiparty meetings with a restrained number of users. If your goal is thousand-user 1-N (streaming-like) meetings, you may max out CPU usage on certain mediasoup workers even though there are other idle workers free.
### bbb-webrtc-sfu fails to start with a SETSCHEDULER error ### bbb-webrtc-sfu fails to start with a SETSCHEDULER error

View File

@ -228,7 +228,7 @@ You should now have presenter capabilities and presenter icon should appear over
5. Click the webcam's fullscreen button again. 5. Click the webcam's fullscreen button again.
6. Click the undo fulscreen button ("Undo [user name] fullscreen"). 6. Click the undo fullscreen button ("Undo [user name] fullscreen").
7. The webcam should exit the fullscreen and go back to normal size. 7. The webcam should exit the fullscreen and go back to normal size.
@ -471,7 +471,7 @@ The screen sharing stops, a sound effect of disconnection is heard and the prese
2. Inside the breakout rooms control panel ("Breakout Rooms" button in the left-hand panel), select the "Breakout options" dropdown and choose "Destroy breakouts". 2. Inside the breakout rooms control panel ("Breakout Rooms" button in the left-hand panel), select the "Breakout options" dropdown and choose "Destroy breakouts".
3. All of the breaout rooms should end and all users should get back to the main room. If users already got the audio on, they shouldn't get propmted for the audio modal. 3. All of the breakout rooms should end and all users should get back to the main room. If users already got the audio on, they shouldn't get prompted for the audio modal.
### Edit the duration of a breakout room ### Edit the duration of a breakout room
@ -519,7 +519,7 @@ The screen sharing stops, a sound effect of disconnection is heard and the prese
4. Change the microphone and speaker using the dropdowns (if applicable). 4. Change the microphone and speaker using the dropdowns (if applicable).
5. Press "Stop audio feedback button" and verify that you dont hear your audio anymore, while the audio stream volume bar is still functional. Clicking that button again should turn on the audio feedback again. 5. Press "Stop audio feedback button" and verify that you don't hear your audio anymore, while the audio stream volume bar is still functional. Clicking that button again should turn on the audio feedback again.
6. Click "Yes". 6. Click "Yes".
@ -1116,7 +1116,7 @@ Share notes should export and download in the chosen format.
8. Moderator: demote another moderator (click on the user name in the user list and select "Demote to viewer"). 8. Moderator: demote another moderator (click on the user name in the user list and select "Demote to viewer").
9. Demoted moderator: shouldn't be able to send private chat messages to viewrs. 9. Demoted moderator: shouldn't be able to send private chat messages to viewers.
10. Moderator: promote a viewer (click on the user name in the user list and select "Promote to moderator"). 10. Moderator: promote a viewer (click on the user name in the user list and select "Promote to moderator").
@ -1222,7 +1222,7 @@ Share notes should export and download in the chosen format.
4. Moderator: toggle one of the lock setting (it becomes "Locked"), click "Apply". 4. Moderator: toggle one of the lock setting (it becomes "Locked"), click "Apply".
5. Moderator: click on a vewer's user name in the user list, then select "Unlock User [user name]". 5. Moderator: click on a viewer's user name in the user list, then select "Unlock User [user name]".
6. Unlocked user: should be able to use the features that were previously unlocked. 6. Unlocked user: should be able to use the features that were previously unlocked.
@ -1470,7 +1470,7 @@ Note :
1. Join meeting. 1. Join meeting.
2. Click on the "Options" button in the top-right corver of the client (three dots icon). 2. Click on the "Options" button in the top-right corner of the client (three dots icon).
3. Dropdown list should appear with a list of available options. 3. Dropdown list should appear with a list of available options.
@ -1667,7 +1667,7 @@ Note :
10. Moderator: type in the textbox, press Enter or click "Send" button. The message should be visible to all waiting viewers on their lobby screens (as well as in the moderator's waiting users panel). 10. Moderator: type in the textbox, press Enter or click "Send" button. The message should be visible to all waiting viewers on their lobby screens (as well as in the moderator's waiting users panel).
11. Moderator: click "Message" for a specific viewer in the list, type in the textbox, press Enter or click "Send" button. The message should appear only for that cpecific viewer. 11. Moderator: click "Message" for a specific viewer in the list, type in the textbox, press Enter or click "Send" button. The message should appear only for that specific viewer.
- Click "Deny everyone". All the waiting viewers should see the message "Guest denied of joining the meeting" and should soon be redirected to the home page. All new viewers should not be effected by this, but instead they should be placed in the waiting lobby. - Click "Deny everyone". All the waiting viewers should see the message "Guest denied of joining the meeting" and should soon be redirected to the home page. All new viewers should not be effected by this, but instead they should be placed in the waiting lobby.

View File

Before

Width:  |  Height:  |  Size: 130 KiB

After

Width:  |  Height:  |  Size: 130 KiB

View File

Before

Width:  |  Height:  |  Size: 130 KiB

After

Width:  |  Height:  |  Size: 130 KiB

View File

Before

Width:  |  Height:  |  Size: 109 KiB

After

Width:  |  Height:  |  Size: 109 KiB