help: Split out call provider config into separate page.

This commit is contained in:
Alya Abbott
2025-03-04 16:50:37 -08:00
committed by Tim Abbott
parent fc1275ab17
commit 931dc92f93
6 changed files with 82 additions and 72 deletions

View File

@@ -0,0 +1,57 @@
# Configure call provider
{!admin-only.md!}
By default, Zulip integrates with
[Jitsi Meet](https://jitsi.org/jitsi-meet/), a fully-encrypted, 100% open
source video conferencing solution. Organization administrators can also
change the organization's call provider. The call providers
supported by Zulip are:
* [Jitsi Meet](/integrations/doc/jitsi)
* [Zoom integration](/integrations/doc/zoom)
* [BigBlueButton integration](/integrations/doc/big-blue-button)
!!! tip ""
You can disable the video and voice call buttons for your organization
by setting the **call provider** to "None".
## Configure your organization's call provider
{start_tabs}
{settings_tab|organization-settings}
1. Under **Compose settings**, select the desired provider from the
**Call provider** dropdown.
{!save-changes.md!}
{end_tabs}
## Use a self-hosted instance of Jitsi Meet
Zulip uses the [cloud version of Jitsi Meet](https://meet.jit.si/)
as its default call provider. You can also use a self-hosted
instance of Jitsi Meet.
{start_tabs}
{settings_tab|organization-settings}
1. Under **Compose settings**, select **Custom URL** from the
**Jitsi server URL** dropdown.
1. Enter the URL of your self-hosted Jitsi Meet server.
{!save-changes.md!}
{end_tabs}
## Related articles
* [Start a call](/help/start-a-call)
* [Jitsi Meet integration](/integrations/doc/jitsi)
* [Zoom integration](/integrations/doc/zoom)
* [BigBlueButton integration](/integrations/doc/big-blue-button)

View File

@@ -244,6 +244,7 @@
## Organization settings
* [Configure organization language](/help/configure-organization-language)
* [Custom emoji](/help/custom-emoji)
* [Configure call provider](/help/configure-call-provider)
* [Add a custom linkifier](/help/add-a-custom-linkifier)
* [Require topics in channel messages](/help/require-topics)
* [Disable message edit history](/help/disable-message-edit-history)

View File

@@ -2,7 +2,8 @@
Zulip makes it convenient to add a video or voice call link to any message,
using the call provider (Jitsi, Zoom, etc.)
[configured](#change-your-call-provider) by your organization's administrators.
[configured](/help/configure-call-provider) by your organization's
administrators.
## Start a video call
@@ -77,57 +78,6 @@ using the call provider (Jitsi, Zoom, etc.)
{end_tabs}
## Change your call provider
{!admin-only.md!}
By default, Zulip integrates with
[Jitsi Meet](https://jitsi.org/jitsi-meet/), a fully-encrypted, 100% open
source video conferencing solution. Organization administrators can also
change the organization's call provider. The call providers
supported by Zulip are:
* [Jitsi Meet](/integrations/doc/jitsi)
* [Zoom integration](/integrations/doc/zoom)
* [BigBlueButton integration](/integrations/doc/big-blue-button)
!!! tip ""
You can disable the video and voice call buttons for your organization
by setting the **call provider** to "None".
### Change your organization's call provider
{start_tabs}
{settings_tab|organization-settings}
1. Under **Compose settings**, select the desired provider from the
**Call provider** dropdown.
{!save-changes.md!}
{end_tabs}
### Use a self-hosted instance of Jitsi Meet
Zulip uses the [cloud version of Jitsi Meet](https://meet.jit.si/)
as its default call provider. You can also use a self-hosted
instance of Jitsi Meet.
{start_tabs}
{settings_tab|organization-settings}
1. Under **Compose settings**, select **Custom URL** from the
**Jitsi server URL** dropdown.
1. Enter the URL of your self-hosted Jitsi Meet server.
{!save-changes.md!}
{end_tabs}
## Unlink your Zoom account from Zulip
If you linked your Zoom account to Zulip, and no longer want it to be connected,
@@ -149,7 +99,8 @@ you can unlink it.
## Related articles
* [Configure call provider](/help/configure-call-provider)
* [Jitsi Meet integration](/integrations/doc/jitsi)
* [Zoom integration integration](/integrations/doc/zoom)
* [Zoom integration](/integrations/doc/zoom)
* [BigBlueButton integration](/integrations/doc/big-blue-button)
* [Insert a link](/help/insert-a-link)

View File

@@ -162,7 +162,7 @@
<tr>
<td class="comparison-table-feature">
<a href="/help/start-a-call">Voice and video calls (1:1)</a>
<div class="comparison-table-feature-desc">Choose a call provider (Zoom, Jitsi, etc.)</div>
<div class="comparison-table-feature-desc"><a href="/help/configure-call-provider">Choose a call provider</a> (Zoom, Jitsi, etc.)</div>
</td>
<td class="comparison-value-positive cloud-cell"><i class="icon icon-infinity"></i></td>
<td class="comparison-value-positive cloud-cell"><i class="icon icon-infinity"></i></td>
@@ -176,7 +176,7 @@
<tr>
<td class="comparison-table-feature">
<a href="/help/start-a-call">Voice and video calls (group)</a>
<div class="comparison-table-feature-desc">Choose a call provider (Zoom, Jitsi, etc.)</div>
<div class="comparison-table-feature-desc"><a href="/help/configure-call-provider">Choose a call provider</a> (Zoom, Jitsi, etc.)</div>
</td>
<td class="comparison-value-positive cloud-cell"><i class="icon icon-infinity"></i></td>
<td class="comparison-value-positive cloud-cell"><i class="icon icon-infinity"></i></td>
@@ -511,7 +511,7 @@
</tr>
<tr>
<td class="comparison-table-feature">
<a href="/help/start-a-call#change-your-video-call-provider">
<a href="/help/configure-call-provider">
Configurable call provider
</a>
<div class="comparison-table-feature-desc">Zoom, Jitsi, BigBlueButton, etc.</div>

View File

@@ -76,7 +76,7 @@
<div class="input-group">
<label for="id_realm_video_chat_provider" class="settings-field-label">
{{t 'Call provider' }}
{{> ../help_link_widget link="/help/start-a-call" }}
{{> ../help_link_widget link="/help/configure-call-provider" }}
</label>
<select name="realm_video_chat_provider" class ="setting-widget prop-element settings_select bootstrap-focus-style" id="id_realm_video_chat_provider" data-setting-widget-type="number">
{{#each realm_available_video_chat_providers}}
@@ -88,7 +88,7 @@
<div>
<label for="id_realm_jitsi_server_url" class="settings-field-label">
{{t "Jitsi server URL" }}
{{> ../help_link_widget link="/help/start-a-call#configure-a-self-hosted-instance-of-jitsi-meet" }}
{{> ../help_link_widget link="/help/configure-call-provider#use-a-self-hosted-instance-of-jitsi-meet" }}
</label>
<select name="realm_jitsi_server_url" id="id_realm_jitsi_server_url" class="setting-widget prop-element settings_select bootstrap-focus-style" data-setting-widget-type="jitsi-server-url-setting">
{{#if server_jitsi_server_url}}

View File

@@ -1020,9 +1020,10 @@ paths:
}
- type: object
description: |
Event sent to a user's clients when the user completes the
OAuth flow for the [Zoom integration](/help/start-a-call). Clients need
to know whether initiating Zoom OAuth is required before creating a Zoom call.
Event sent to a user's clients when the user completes the OAuth flow
for the [Zoom integration](/help/configure-call-provider). Clients need
to know whether initiating Zoom OAuth is required before creating a Zoom
call.
properties:
id:
$ref: "#/components/schemas/EventIdSchema"
@@ -5269,7 +5270,7 @@ paths:
video_chat_provider:
type: integer
description: |
The configured [video call provider](/help/start-a-call) for the
The configured [video call provider](/help/configure-call-provider) for the
organization.
- 0 = None
@@ -16190,9 +16191,10 @@ paths:
description: |
Present if `video_calls` is present in `fetch_event_types`.
A boolean which signifies whether the user has a zoom token and has thus completed
OAuth flow for the [Zoom integration](/help/start-a-call). Clients need
to know whether initiating Zoom OAuth is required before creating a Zoom call.
A boolean which signifies whether the user has a Zoom token and has thus
completed OAuth flow for the [Zoom integration](/help/configure-call-provider).
Clients need to know whether initiating Zoom OAuth is required before
creating a Zoom call.
giphy_api_key:
type: string
description: |
@@ -17455,7 +17457,7 @@ paths:
realm_video_chat_provider:
type: integer
description: |
The configured [video call provider](/help/start-a-call) for the
The configured [video call provider](/help/configure-call-provider) for the
organization.
- 0 = None
@@ -17779,13 +17781,12 @@ paths:
description: |
Present if `realm` is present in `fetch_event_types`.
Dictionary where each entry describes a supported
[video call provider](/help/start-a-call)
that is configured on this server and could be selected by an
organization administrator.
Dictionary where each entry describes a supported [video call
provider](/help/configure-call-provider) that is configured on this
server and could be selected by an organization administrator.
Useful for administrative settings UI that allows changing the
realm setting `video_chat_provider`.
Useful for administrative settings UI that allows changing the realm
setting `video_chat_provider`.
additionalProperties:
description: |
`{provider_name}`: Dictionary containing the details of the