Difference between revisions of "Big Blue Button"
m (→Troubleshooting) |
(→Server Migration: Add notes on how to migrate server.) |
||
(10 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{stub}} | {{stub}} | ||
+ | |||
+ | == Configuring TURN == | ||
+ | *[[Setting up a TURN server]] | ||
+ | *https://docs.bigbluebutton.org/2.2/setup-turn-server.html#configure-bigbluebutton-to-use-your-turn-server | ||
+ | |||
+ | == Configuration == | ||
+ | The configuration files can be found on the BBB Configuration page. | ||
+ | |||
+ | === Disable Echo Test === | ||
+ | Edit '''/etc/bigbluebutton/bbb-html5.yml''' - if this file does not exist then run: | ||
+ | <source lang="bash"> | ||
+ | cp /usr/share/meteor/bundle/programs/server/assets/app/config/settings.yml /etc/bigbluebutton/bbb-html5.yml | ||
+ | </source> | ||
+ | Then edit the properties you want. | ||
+ | |||
+ | === Testing configuration === | ||
+ | Run the configuration test script to see some potential issues and solutions. | ||
+ | <source lang="bash"> | ||
+ | sudo bbb-conf --check | ||
+ | </source> | ||
+ | |||
+ | == Nextcloud integration == | ||
+ | BBB has a [[Nextcloud]] integration that makes organising calls much easier if you already use a Nextcloud instance. It adds a new icon on the taskbar (shown at the top of the image below) that takes you to a page where you can manage rooms. Each room can be configured with a lot of useful options such as automatic private rooms for your Nextcloud users. The room is entered by simply clicking the play button for the appropriate room. You can copy a link for inviting other users too. | ||
+ | |||
+ | [[File:Bbb-nc.jpg]] | ||
+ | |||
+ | |||
+ | Note that by default a room you create will not show up in the list for any of the other users in your Nextcloud. You need to add them as moderators and then click the ''share'' icon to the right of each moderator to make them all admins for the room. | ||
+ | |||
+ | [[File:Bbb-nc-share.jpg]] | ||
== Troubleshooting == | == Troubleshooting == | ||
− | After initial installation, room members couldn't activate video, all getting <tt>Connection failed: ICE error 1107</tt>, which is a known issue in [https://github.com/bigbluebutton/bigbluebutton/issues/7443 Github]. | + | |
+ | === ICE error 1107, video not working === | ||
+ | After initial installation, room members couldn't activate video, all getting <tt>Connection failed: ICE error 1107</tt>, which is a known issue in [https://github.com/bigbluebutton/bigbluebutton/issues/7443 Github]. This is most likely that UDP is not getting through to the server. You can test UDP as follows: | ||
+ | |||
+ | On the target machine being tested: | ||
+ | <source lang="bash"> | ||
+ | nc -ulp PORT | ||
+ | </source> | ||
+ | |||
+ | And on the machine sending the tests: | ||
+ | <source lang="bash"> | ||
+ | nc -u SERVER PORT | ||
+ | </source> | ||
+ | Then type text and hit enter, it should be echoed on the server. | ||
+ | |||
+ | If it's not, check the firewall status and disable: | ||
+ | <source lang="bash"> | ||
+ | ufw status | ||
+ | ufw disable | ||
+ | </source> | ||
+ | |||
+ | If you still are having issues, setup a TURN server which should significantly improve reliability. | ||
+ | |||
+ | == Query String API == | ||
+ | |||
+ | === Security === | ||
+ | You will need access to the shared secret in BBB's configuration: | ||
+ | # First prepend the name of the API call to the string to the query string (no '?' at the start but '&' between parameters). | ||
+ | # Secondly append the shared secret to the the end of the query string | ||
+ | # Hash the resulting string with SHA1 | ||
+ | # Add '''checksum=<SHA1>''' to the original query string parameters. | ||
+ | |||
+ | * https://docs.bigbluebutton.org/dev/api.html#usage | ||
+ | |||
+ | == Server Migration == | ||
+ | |||
+ | Server migration is easy if you are using an application such as NextCloud since you can point it to the domain/shared secret. | ||
+ | |||
+ | === Recordings === | ||
+ | |||
+ | Recordings are located in '''/var/bigbluebutton''' or if you are using docker '''/var/lib/docker/volumes/bbb-docker_bigbluebutton/_data'''. Copy these files over to the new server and if your domain has been changed you will need to modify the meta-data: | ||
+ | |||
+ | <source lang="bash"> | ||
+ | find <BBB_PATH> -name '*metadata.xml' | xargs sed -i 's/<OLD_DOMAIN>/<NEW_DOMAIN>/g' | ||
+ | </source> | ||
== Resources == | == Resources == | ||
Line 9: | Line 83: | ||
== See also == | == See also == | ||
+ | *[[Setting up a TURN server]] | ||
*[[Jitsi]] | *[[Jitsi]] | ||
*[[Matrix]] | *[[Matrix]] | ||
[[Category:Libre software]] | [[Category:Libre software]] |
Latest revision as of 22:41, 31 May 2023
Contents
Configuring TURN
- Setting up a TURN server
- https://docs.bigbluebutton.org/2.2/setup-turn-server.html#configure-bigbluebutton-to-use-your-turn-server
Configuration
The configuration files can be found on the BBB Configuration page.
Disable Echo Test
Edit /etc/bigbluebutton/bbb-html5.yml - if this file does not exist then run:
cp /usr/share/meteor/bundle/programs/server/assets/app/config/settings.yml /etc/bigbluebutton/bbb-html5.yml
Then edit the properties you want.
Testing configuration
Run the configuration test script to see some potential issues and solutions.
sudo bbb-conf --check
Nextcloud integration
BBB has a Nextcloud integration that makes organising calls much easier if you already use a Nextcloud instance. It adds a new icon on the taskbar (shown at the top of the image below) that takes you to a page where you can manage rooms. Each room can be configured with a lot of useful options such as automatic private rooms for your Nextcloud users. The room is entered by simply clicking the play button for the appropriate room. You can copy a link for inviting other users too.
Note that by default a room you create will not show up in the list for any of the other users in your Nextcloud. You need to add them as moderators and then click the share icon to the right of each moderator to make them all admins for the room.
Troubleshooting
ICE error 1107, video not working
After initial installation, room members couldn't activate video, all getting Connection failed: ICE error 1107, which is a known issue in Github. This is most likely that UDP is not getting through to the server. You can test UDP as follows:
On the target machine being tested:
nc -ulp PORT
And on the machine sending the tests:
nc -u SERVER PORT
Then type text and hit enter, it should be echoed on the server.
If it's not, check the firewall status and disable:
ufw status
ufw disable
If you still are having issues, setup a TURN server which should significantly improve reliability.
Query String API
Security
You will need access to the shared secret in BBB's configuration:
- First prepend the name of the API call to the string to the query string (no '?' at the start but '&' between parameters).
- Secondly append the shared secret to the the end of the query string
- Hash the resulting string with SHA1
- Add checksum=<SHA1> to the original query string parameters.
Server Migration
Server migration is easy if you are using an application such as NextCloud since you can point it to the domain/shared secret.
Recordings
Recordings are located in /var/bigbluebutton or if you are using docker /var/lib/docker/volumes/bbb-docker_bigbluebutton/_data. Copy these files over to the new server and if your domain has been changed you will need to modify the meta-data:
find <BBB_PATH> -name '*metadata.xml' | xargs sed -i 's/<OLD_DOMAIN>/<NEW_DOMAIN>/g'