BigBlueButton/bigbluebutton-Github
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: 3.0 Added Gladia docs (how to configure) (#20560)

Browse Source 
* docs: 3.0 Gladia docs

* docs: add alpha.6 url
This commit is contained in:
Anton Georgiev 2024-06-20 15:55:01 -04:00 committed by GitHub
parent 1465d3dca3
commit eb15514ed3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/docs/administration/customize.md
View File

@ -1286,6 +1286,31 @@ public:
Restart BigBlueButton with `sudo bbb-conf --restart` and you should now see the options for live captions when joining audio.
### Configuration of gladia.io
To use gladia.io for automatic speech-to-text transcriptions, you first need to obtain an API key from [gladia.io](https://www.gladia.io). You can sign up for free credentials to test the integration.
Next, you must be using BigBlueButton 2.7.4+ (pass `-v focal-270`) or BigBlueButton 3.0.0-alpha.7+ (pass `-v jammy-300`) or later on a BigBlueButton server with a public IP and hostname.
Once you have BigBlueButton installed, run `sudo apt install bbb-transcription-controller` to install BigBlueButton's transcription service which supports gladia.io.
Next, run `sudo bbb-conf --setip <hostname>` where \<hostname\> is the external hostname of the server (same as was passed to bbb-install.sh). This will update the bbb-transcription-controller configuration.
Next, to enable gladia.io, run the following two commands
```
yq e -i '.public.app.audioCaptions.enabled = true' /etc/bigbluebutton/bbb-html5.yml
yq e -i '.public.app.audioCaptions.provider = gladia' /etc/bigbluebutton/bbb-html5.yml
```
Next, set the gladia.io API key using the command below, replacing \<gladia_api_key\> with a glada.io API key obtained above.
```
yq e -i '.gladia.startMessage = "{\"x_gladia_key\": \"<gladia-api-key>\", \"sample_rate\": 0, \"bit_depth\": 16, \"model_type\": \"fast\", \"endpointing\": 10 }"' /usr/local/bigbluebutton/bbb-transcription-controller/config/default.yml
```
Restart the BigBlueButton server with `bbb-conf --restart`. You will now be able to select a speech-to-text option when joining audio (including auto translate). When one or more users have selected the option, a CC button will appear at the bottom and a Transcript panel will also be available.
### Configuration of global settings

3
docs/docs/new-features.md
View File

@ -92,7 +92,7 @@ We upgraded tl;draw from version 1 to version 2.0.0-alpha.19 (the last version o
#### Support for Collabora Online as Document Converter

Collabora Productivity contributed the support for an alternative conversion script where Collabora Online (deployed locally [as a docker container] or running remotely) can be used for document conversion.
Collabora Productivity contributed the support for an alternative conversion script where Collabora Online (deployed locally [as a docker container] or running remotely) can be used for document conversion.
For more information check the [pull request](https://github.com/bigbluebutton/bigbluebutton/pull/18783)
### Experimental
@ -111,6 +111,7 @@ For full details on what is new in BigBlueButton 3.0, see the release notes.
Recent releases:
- [3.0.0-alpha.6](https://github.com/bigbluebutton/bigbluebutton/releases/tag/v3.0.0-alpha.6)
- [3.0.0-alpha.5](https://github.com/bigbluebutton/bigbluebutton/releases/tag/v3.0.0-alpha.5)
- [3.0.0-alpha.4](https://github.com/bigbluebutton/bigbluebutton/releases/tag/v3.0.0-alpha.4)
- [3.0.0-alpha.3](https://github.com/bigbluebutton/bigbluebutton/releases/tag/v3.0.0-alpha.3)