BigBlueButton - Revision history

Merenber: Add recording instructions

2022-10-26T03:45:47Z

Add recording instructions

@@ Line 60: / Line 60: @@
 <li>
 To set a custom logo in the top left corner, go to 'Site Settings', and replace the branding image URL. I'm using a small CSC logo hosted on our git server in the csc-propaganda repo.
 </li>
 </ol>

Merenber: /* Installation */

2021-10-29T03:27:27Z

Installation

← Older revision		Revision as of 22:27, 28 October 2021
Line 2:		Line 2:

	== Installation ==		== Installation ==
	BBB is currently running in an ~~LXC container~~ on xylitol. Here are the steps that were performed to install it.		BBB and Greenlight (the web UI) are currently running in podman containers on xylitol (they are in the same pod, so they share a network namespace). Here are the steps that were performed to install it.

	=== Prerequisites ===		=== Prerequisites ===
	The container in which BBB is running should have:		The container in which BBB is running should have:
	* Ubuntu 16. ~~This~~ is the ~~only~~ Linux distro supported by BBB.		* Ubuntu 18. As of this writing, this is the most recent Linux distro supported by BBB.
	* A FQDN (bbb.csclub.uwaterloo.ca).		* A FQDN (bbb.csclub.uwaterloo.ca).
	* A public IPv4 address (and optionally an IPv6 address).		* A public IPv4 address (and optionally an IPv6 address).
Line 24:		Line 24:
	</li>		</li>
	<li>		<li>
	I wrote an Ansible playbook [https://git.csclub.uwaterloo.ca/merenber/bbb-setup here] which automates most of the setup		I wrote an Ansible playbook [https://git.csclub.uwaterloo.ca/merenber/bbb-setup here] which automates most of the setup (steps adapted from [https://docs.bigbluebutton.org/2.2/install.html here]).
	(steps adapted from [https://docs.bigbluebutton.org/2.2/install.html here]). This also takes care of installing Greenlight, which is the
	web frontend for BBB.
	<br>		<br>
	Git clone the repo into a folder, say <code>/root/ansible</code>. Take a look over the files and customize any		Git clone the repo into a folder, say <code>/root/ansible</code>. Take a look over the files and customize any
	values as you see fit. Once you are satisfied, run <code>ansible-playbook playbook.yml</code>.		values as you see fit. Once you are satisfied, run <code>ansible-playbook playbook.yml</code>.
	</li>
	<li>
	Once the playbook has finished, open <code>/opt/greenlight/.env</code> and set the value of <code>DB_PASSWORD</code>.
	</li>		</li>
	<li>		<li>
Line 42:		Line 37:
	</li>		</li>
	<li>		<li>
			Run a podman container for Greenlight (the BBB devs already created one) in the same pod as BBB. Create a .env file and pass it to the --environment-file option.
	At some point you may need to run the <code>bundle</code> command as the greenlight user, especially if you are customizing Greenlight.
	Add the following to <code>/opt/greenlight/.profile</code>:
	<pre>
	export PATH=$HOME/.gem/ruby/2.7.0/bin:$PATH
	export $(grep -v '^#' ~/.env)
	export RAILS_ENV=production
	export BUNDLE_APP_CONFIG=~/.bundle
	</pre>
	This will allow you to run <code>bundle</code> after logging in as the greenlight user.
	</li>
	<li>
	Enable and run the systemd service for Greenlight:
	<pre>
	systemctl enable greenlight
	systemctl start greenlight
	</pre>
	</li>		</li>
	<li>		<li>
Line 79:		Line 59:
	</li>		</li>
	<li>		<li>
	To set a custom logo in the top left corner, go to 'Site Settings',		To set a custom logo in the top left corner, go to 'Site Settings', and replace the branding image URL. I'm using a small CSC logo hosted on our git server in the csc-propaganda repo.
	and replace the branding image URL. I'm using a small CSC logo hosted
	on our git server in the csc-propaganda repo [https://git.csclub.uwaterloo.ca/?p=public/csc-propaganda.git;a=blob_plain;f=csc-logos/csc-logo-small.png;hb=HEAD].
	</li>		</li>
	</ol>		</ol>

	=== Upgrading ===
	When upgrading Greenlight, make sure to run the DB migrations before restarting the systemd service:
	<pre>
	su - greenlight
	bundle exec rake db:migrate
	</pre>

	=== Some notes about TURN ===		=== Some notes about TURN ===

Merenber: /* Instructions */

2021-06-22T01:00:44Z

Instructions

← Older revision		Revision as of 20:00, 21 June 2021
Line 24:		Line 24:
	</li>		</li>
	<li>		<li>
	I wrote an Ansible playbook [https://git.csclub.uwaterloo.ca/~~?p=~~merenber/bbb-setup~~.git;a=summary~~ here] which automates most of the setup		I wrote an Ansible playbook [https://git.csclub.uwaterloo.ca/merenber/bbb-setup here] which automates most of the setup
	(steps adapted from [https://docs.bigbluebutton.org/2.2/install.html here]). This also takes care of installing Greenlight, which is the		(steps adapted from [https://docs.bigbluebutton.org/2.2/install.html here]). This also takes care of installing Greenlight, which is the
	web frontend for BBB.		web frontend for BBB.

Merenber at 22:19, 12 May 2021

2021-05-12T22:19:24Z

← Older revision		Revision as of 17:19, 12 May 2021
Line 84:		Line 84:
	</li>		</li>
	</ol>		</ol>

			=== Upgrading ===
			When upgrading Greenlight, make sure to run the DB migrations before restarting the systemd service:
			<pre>
			su - greenlight
			bundle exec rake db:migrate
			</pre>

	=== Some notes about TURN ===		=== Some notes about TURN ===

Merenber: /* Instructions */

2021-05-12T22:17:52Z

Instructions

← Older revision		Revision as of 17:17, 12 May 2021
Line 45:		Line 45:
	Add the following to <code>/opt/greenlight/.profile</code>:		Add the following to <code>/opt/greenlight/.profile</code>:
	<pre>		<pre>
	export PATH=$HOME/.gem/ruby/2.5.0/bin:$PATH		export PATH=$HOME/.gem/ruby/2.7.0/bin:$PATH
	export $(grep -v '^#' ~/.env)		export $(grep -v '^#' ~/.env)
	export RAILS_ENV=production		export RAILS_ENV=production

Merenber at 08:11, 14 March 2021

2021-03-14T08:11:30Z

← Older revision		Revision as of 03:11, 14 March 2021
Line 84:		Line 84:
	</li>		</li>
	</ol>		</ol>

			=== Some notes about TURN ===
			The BBB docs suggest [https://docs.bigbluebutton.org/2.2/setup-turn-server.html running your own TURN server]. TURN is used for bypassing NATs
			and firewalls by basically relaying UDP traffic. I did not install one because I didn't think it was necessary, but if we have some users
			in restrictive firewalled environments, we may have to install our TURN server. Make sure to ask IST for the appropriate port exceptions
			and update <code>turn-stun-servers.xml</code>.

Merenber at 08:07, 14 March 2021

2021-03-14T08:07:15Z

@@ Line 60: / Line 60: @@
 </li>
 <li>
-Now we will need to create an administrator account.
+Now we will need to create an administrator account. There is theoretically a
 </li>
 </ol>

Merenber at 07:58, 14 March 2021

2021-03-14T07:58:13Z

@@ Line 11: / Line 11: @@
 * Firewall exceptions for TCP ports 80 and 443 and UDP ports 16384 - 32768.
 * Ansible installed. This can be done via <code>apt install ansible</code>.
-* An SSL key pair. See [[SSL]]. In this tutorial they are called <code>csclub-wildcard-chain.crt</code>
+* An SSL key pair. See [[SSL]]. In this tutorial they are called <code>csclub-wildcard-chain.crt</code> and <code>csclub-wildcard.key</code>.
 === Instructions ===
@@ Line 41: / Line 40: @@
 <li>
 Restart BBB by running <code>bbb-conf --restart</code>.
 </li>
 </ol>

Merenber at 07:54, 14 March 2021

2021-03-14T07:54:40Z

← Older revision		Revision as of 03:54, 14 March 2021
Line 11:		Line 11:
	* Firewall exceptions for TCP ports 80 and 443 and UDP ports 16384 - 32768.		* Firewall exceptions for TCP ports 80 and 443 and UDP ports 16384 - 32768.
	* Ansible installed. This can be done via <code>apt install ansible</code>.		* Ansible installed. This can be done via <code>apt install ansible</code>.
			* An SSL key pair. See [[SSL]]. In this tutorial they are called <code>csclub-wildcard-chain.crt</code>
			and <code>csclub-wildcard.key</code>.

	=== Instructions ===		=== Instructions ===
Line 27:		Line 29:
	web frontend for BBB.		web frontend for BBB.
	<br>		<br>
	Git clone the repo into a folder, say <code>/root/ansible</code>, ~~then~~ ~~run~~ ~~<code>ansible-playbook~~ ~~playbook.yml</code>.~~		Git clone the repo into a folder, say <code>/root/ansible</code>. Take a look over the files and customize any
			values as you see fit. Once you are satisfied, run <code>ansible-playbook playbook.yml</code>.
	</li>		</li>
	<li>		<li>
	Once the playbook has finished, open <code>/opt/greenlight/.env</code> and set the value of <code>DB_PASSWORD</code>.		Once the playbook has finished, open <code>/opt/greenlight/.env</code> and set the value of <code>DB_PASSWORD</code>.
			</li>
			<li>
			Place copies of <code>csclub-wildcard-chain.crt</code> and <code>csclub-wildcard.key</code>
			in the directory <code>/etc/nginx/ssl</code>. The key file must have permissions 0600.
			</li>
			<li>
			Restart BBB by running <code>bbb-conf --restart</code>.
	</li>		</li>
	</ol>		</ol>

Merenber at 07:46, 14 March 2021

2021-03-14T07:46:59Z

← Older revision		Revision as of 03:46, 14 March 2021
Line 1:		Line 1:
	We run an instance of [https://bigbluebutton.org BigBlueButton] at https://bbb.csclub.uwaterloo.ca.		We run an instance of [https://bigbluebutton.org BigBlueButton] at https://bbb.csclub.uwaterloo.ca. BigBlueButton is a free and open source videoconferencing platform with many features such as multi-user whiteboards, embedded videos, and interactive polls. You can check out some tutorial videos [https://bigbluebutton.org/html5 here].

			== Installation ==
			BBB is currently running in an LXC container on xylitol. Here are the steps that were performed to install it.

			=== Prerequisites ===
			The container in which BBB is running should have:
			* Ubuntu 16. This is the only Linux distro supported by BBB.
			* A FQDN (bbb.csclub.uwaterloo.ca).
			* A public IPv4 address (and optionally an IPv6 address).
			* Firewall exceptions for TCP ports 80 and 443 and UDP ports 16384 - 32768.
			* Ansible installed. This can be done via <code>apt install ansible</code>.

			=== Instructions ===
			<ol>
			<li>
			First we will setup the database. Login to coffee as the <code>postgres</code> user, run <code>psql</code>, then run the following:
			<pre>
			CREATE USER greenlight WITH PASSWORD 'replace_this_password';
			CREATE DATABASE greenlight;
			ALTER DATABASE greenlight OWNER TO greenlight;
			</pre>
			</li>
			<li>
			I wrote an Ansible playbook [https://git.csclub.uwaterloo.ca/?p=merenber/bbb-setup.git;a=summary here] which automates most of the setup
			(steps adapted from [https://docs.bigbluebutton.org/2.2/install.html here]). This also takes care of installing Greenlight, which is the
			web frontend for BBB.
			<br>
			Git clone the repo into a folder, say <code>/root/ansible</code>, then run <code>ansible-playbook playbook.yml</code>.
			</li>
			<li>
			Once the playbook has finished, open <code>/opt/greenlight/.env</code> and set the value of <code>DB_PASSWORD</code>.
			</li>
			</ol>