mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-04 05:53:43 +00:00 
			
		
		
		
	docs: Merge Zoom and BBB configuration pages.
This commit is contained in:
		@@ -1,30 +0,0 @@
 | 
				
			|||||||
# Big Blue Button video calling configuration
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
To use the [Big Blue Button](https://bigbluebutton.org/) video call
 | 
					 | 
				
			||||||
integration on a self-hosted Zulip installation, you'll need to have a
 | 
					 | 
				
			||||||
Big Blue Button server and configure it:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
1. Get the Shared Secret using the `bbb-conf --secret` command on your
 | 
					 | 
				
			||||||
   Big Blue Button Server. See also [the Big Blue Button
 | 
					 | 
				
			||||||
   documentation](https://docs.bigbluebutton.org/2.2/customize.html#extract-the-shared-secret).
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
2. Get the URL to your Big Blue Button API. The URL has the form of
 | 
					 | 
				
			||||||
   `https://bigbluebutton.example.com/bigbluebutton/` and can also be
 | 
					 | 
				
			||||||
   found using the `bbb-conf --secret` command.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
You can then configure your Zulip server to use that Big Blue Button
 | 
					 | 
				
			||||||
Server as follows:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
1. In `/etc/zulip/zulip-secrets.conf`, set `big_blue_button_secret`
 | 
					 | 
				
			||||||
   to be your Big Blue Button Server's shared secret.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
2. In `/etc/zulip/settings.py`, set `BIG_BLUE_BUTTON_URL` to your
 | 
					 | 
				
			||||||
   to be your Big Blue Button Server's API URL.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
3. Restart the Zulip server with
 | 
					 | 
				
			||||||
   `/home/zulip/deployments/current/scripts/restart-server`.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
This enables Big Blue Button support in your Zulip server.  Finally, [configure
 | 
					 | 
				
			||||||
Big Blue Button as the video call
 | 
					 | 
				
			||||||
provider](https://zulip.com/help/start-a-call) in the Zulip
 | 
					 | 
				
			||||||
organization(s) where you want to use it.
 | 
					 | 
				
			||||||
@@ -21,5 +21,4 @@ Zulip in production
 | 
				
			|||||||
   email
 | 
					   email
 | 
				
			||||||
   deployment
 | 
					   deployment
 | 
				
			||||||
   email-gateway
 | 
					   email-gateway
 | 
				
			||||||
   zoom-configuration
 | 
					   video-calls
 | 
				
			||||||
   big-blue-button-configuration
 | 
					 | 
				
			||||||
 
 | 
				
			|||||||
@@ -100,7 +100,7 @@ Some popular settings in `/etc/zulip/settings.py` include:
 | 
				
			|||||||
  tweets.
 | 
					  tweets.
 | 
				
			||||||
* The [email gateway](../production/email-gateway.md), which lets
 | 
					* The [email gateway](../production/email-gateway.md), which lets
 | 
				
			||||||
  users send emails into Zulip.
 | 
					  users send emails into Zulip.
 | 
				
			||||||
* The [Zoom video call integration](zoom-configuration.md).
 | 
					* The [Video call integrations](video-calls.md).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Zulip announcement list
 | 
					## Zulip announcement list
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										77
									
								
								docs/production/video-calls.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										77
									
								
								docs/production/video-calls.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,77 @@
 | 
				
			|||||||
 | 
					# Video call providers
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					This page documents the server-level configuration required to support
 | 
				
			||||||
 | 
					non-default [video call integration
 | 
				
			||||||
 | 
					options](https://zulip.com/help/start-a-call) on a self-hosted Zulip
 | 
				
			||||||
 | 
					server.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Zoom
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					To use the [Zoom](https://zoom.us) integration on a self-hosted
 | 
				
			||||||
 | 
					installation, you'll need to register a custom Zoom app as follows:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. Select [**Build App**](https://marketplace.zoom.us/develop/create)
 | 
				
			||||||
 | 
					   at the Zoom Marketplace.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. Create an app with the **OAuth** type.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					   * Choose an app name such as "ExampleCorp Zulip".
 | 
				
			||||||
 | 
					   * Select **User-managed app**.
 | 
				
			||||||
 | 
					   * Disable the option to publish the app on the Marketplace.
 | 
				
			||||||
 | 
					   * Click **Create**.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. Inside of the Zoom app management page:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					   * On the **App Credentials** tab, set both the **Redirect URL for
 | 
				
			||||||
 | 
					     OAuth** and the **Whitelist URL** to
 | 
				
			||||||
 | 
					     `https://zulip.example.com/calls/zoom/complete` (replacing
 | 
				
			||||||
 | 
					     `zulip.example.com` by your main Zulip hostname).
 | 
				
			||||||
 | 
					   * On the **Scopes** tab, add the `meeting:write` scope.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					You can then configure your Zulip server to use that Zoom app as
 | 
				
			||||||
 | 
					follows:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. In `/etc/zulip/zulip-secrets.conf`, set `video_zoom_client_secret`
 | 
				
			||||||
 | 
					   to be your app's "Client Secret".
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. In `/etc/zulip/settings.py`, set `VIDEO_ZOOM_CLIENT_ID` to your
 | 
				
			||||||
 | 
					   app's "Client ID".
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. Restart the Zulip server with
 | 
				
			||||||
 | 
					   `/home/zulip/deployments/current/scripts/restart-server`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					This enables Zoom support in your Zulip server.  Finally, [configure
 | 
				
			||||||
 | 
					Zoom as the video call
 | 
				
			||||||
 | 
					provider](https://zulip.com/help/start-a-call) in the Zulip
 | 
				
			||||||
 | 
					organization(s) where you want to use it.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Big Blue Button
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					To use the [Big Blue Button](https://bigbluebutton.org/) video call
 | 
				
			||||||
 | 
					integration on a self-hosted Zulip installation, you'll need to have a
 | 
				
			||||||
 | 
					Big Blue Button server and configure it:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. Get the Shared Secret using the `bbb-conf --secret` command on your
 | 
				
			||||||
 | 
					   Big Blue Button Server. See also [the Big Blue Button
 | 
				
			||||||
 | 
					   documentation](https://docs.bigbluebutton.org/2.2/customize.html#extract-the-shared-secret).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					2. Get the URL to your Big Blue Button API. The URL has the form of
 | 
				
			||||||
 | 
					   `https://bigbluebutton.example.com/bigbluebutton/` and can also be
 | 
				
			||||||
 | 
					   found using the `bbb-conf --secret` command.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					You can then configure your Zulip server to use that Big Blue Button
 | 
				
			||||||
 | 
					Server as follows:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. In `/etc/zulip/zulip-secrets.conf`, set `big_blue_button_secret`
 | 
				
			||||||
 | 
					   to be your Big Blue Button Server's shared secret.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					2. In `/etc/zulip/settings.py`, set `BIG_BLUE_BUTTON_URL` to your
 | 
				
			||||||
 | 
					   to be your Big Blue Button Server's API URL.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					3. Restart the Zulip server with
 | 
				
			||||||
 | 
					   `/home/zulip/deployments/current/scripts/restart-server`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					This enables Big Blue Button support in your Zulip server.  Finally, [configure
 | 
				
			||||||
 | 
					Big Blue Button as the video call
 | 
				
			||||||
 | 
					provider](https://zulip.com/help/start-a-call) in the Zulip
 | 
				
			||||||
 | 
					organization(s) where you want to use it.
 | 
				
			||||||
@@ -1,39 +0,0 @@
 | 
				
			|||||||
# Zoom video calling OAuth configuration
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
To use the [Zoom](https://zoom.us) integration on a self-hosted
 | 
					 | 
				
			||||||
installation, you'll need to register a custom Zoom app as follows:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
1. Select [**Build App**](https://marketplace.zoom.us/develop/create)
 | 
					 | 
				
			||||||
   at the Zoom Marketplace.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
1. Create an app with the **OAuth** type.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
   * Choose an app name such as "ExampleCorp Zulip".
 | 
					 | 
				
			||||||
   * Select **User-managed app**.
 | 
					 | 
				
			||||||
   * Disable the option to publish the app on the Marketplace.
 | 
					 | 
				
			||||||
   * Click **Create**.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
1. Inside of the Zoom app management page:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
   * On the **App Credentials** tab, set both the **Redirect URL for
 | 
					 | 
				
			||||||
     OAuth** and the **Whitelist URL** to
 | 
					 | 
				
			||||||
     `https://zulip.example.com/calls/zoom/complete` (replacing
 | 
					 | 
				
			||||||
     `zulip.example.com` by your main Zulip hostname).
 | 
					 | 
				
			||||||
   * On the **Scopes** tab, add the `meeting:write` scope.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
You can then configure your Zulip server to use that Zoom app as
 | 
					 | 
				
			||||||
follows:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
1. In `/etc/zulip/zulip-secrets.conf`, set `video_zoom_client_secret`
 | 
					 | 
				
			||||||
   to be your app's "Client Secret".
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
1. In `/etc/zulip/settings.py`, set `VIDEO_ZOOM_CLIENT_ID` to your
 | 
					 | 
				
			||||||
   app's "Client ID".
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
1. Restart the Zulip server with
 | 
					 | 
				
			||||||
   `/home/zulip/deployments/current/scripts/restart-server`.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
This enables Zoom support in your Zulip server.  Finally, [configure
 | 
					 | 
				
			||||||
Zoom as the video call
 | 
					 | 
				
			||||||
provider](https://zulip.com/help/start-a-call) in the Zulip
 | 
					 | 
				
			||||||
organization(s) where you want to use it.
 | 
					 | 
				
			||||||
@@ -39,10 +39,9 @@ just set `JITSI_SERVER_URL` in `/etc/zulip/settings.py`.
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
{tab|bigbluebutton}
 | 
					{tab|bigbluebutton}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Using Big Blue Button as a video chat provider is currently only possible on
 | 
					Using Big Blue Button as a video chat provider is currently only
 | 
				
			||||||
self-hosted Zulip installations.
 | 
					possible on self-hosted Zulip installations.  See the [detailed
 | 
				
			||||||
 | 
					configuration instructions][big-blue-button-configuration].
 | 
				
			||||||
For specifics on configuring Big Blue Button on a self hosted installation see [here][big-blue-button-configuration].
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
{tab|zoom}
 | 
					{tab|zoom}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -76,4 +75,5 @@ setting the provider to "None".
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
{end_tabs}
 | 
					{end_tabs}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
[zoom-configuration]: https://zulip.readthedocs.io/en/latest/production/zoom-configuration.html
 | 
					[big-blue-button-configuration]: https://zulip.readthedocs.io/en/latest/production/video-calls.html#big-blue-button
 | 
				
			||||||
 | 
					[zoom-configuration]: https://zulip.readthedocs.io/en/latest/production/video-calls.html#zoom
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user