Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MM-57874] Calls: Live captions docs #7102

Closed
wants to merge 12 commits into from
27 changes: 10 additions & 17 deletions source/configure/calls-deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,7 @@ Calls self-hosted deployment
.. include:: ../_static/badges/allplans-cloud-selfhosted.rst
:start-after: :nosearch:

This document provides information on how to successfully make the Calls plugin work on self-hosted deployments. It also outlines some of the most common deployment strategies with example diagrams, and also provides the deployment guidelines for the recording and transcription service.

- `Terminology <#terminology>`__
- `Plugin components <#plugin-components>`__
- `Requirements <#requirements>`__
- `Limitations <#limitations>`__
- `Configuration <#configuration>`__
- `Performance <#performance>`__
- `RTCD Service <#the-rtcd-service>`__
- `Configure recording and transcriptions <#configure-recording-and-transcriptions>`__
- `Kubernetes deployments <#kubernetes-deployments>`__
- `Frequently asked questions <#frequently-asked-questions>`__
- `Troubleshooting <#troubleshooting>`__
This document provides information on how to successfully make the Calls plugin work on self-hosted deployments. It also outlines some of the most common deployment strategies with example diagrams, and provides the deployment guidelines for the recording, transcription, and live captions service.

Terminology
-----------
Expand Down Expand Up @@ -336,10 +324,10 @@ The expected requirements are the following:
Load balancing is done at the call level. This means that a single call will always live on a single ``rtcd`` instance.
There's currently no support for spreading sessions belonging to the same call across a fleet of instances.

Configure recording and transcriptions
--------------------------------------
Configure recording, transcriptions, and live captions
------------------------------------------------------

Before you can start recording and transcribing calls, you need to configure the ``calls-offloader`` job service. You can read about how to do that `here <https://github.com/mattermost/calls-offloader/blob/master/docs/getting_started.md>`__. Performance and scalability recommendations related to this service can be found in `here <https://github.com/mattermost/calls-offloader/blob/master/docs/performance.md>`__.
Before you can start recording, transcribing, and live captioning calls, you need to configure the ``calls-offloader`` job service. You can read about how to do that `here <https://github.com/mattermost/calls-offloader/blob/master/docs/getting_started.md>`__. Performance and scalability recommendations related to this service can be found in `here <https://github.com/mattermost/calls-offloader/blob/master/docs/performance.md>`__.

.. note::
If deploying the service in a Kubernetes cluster, refer to the later section on `Helm charts <#helm-charts>`__.
Expand All @@ -352,6 +340,11 @@ Call transcriptions can be enabled through the :ref:`Enable call transcriptions
.. note::
The call transcriptions functionality is available starting in Calls version v0.22.0

Live captions can be enabled through the :ref:`Enable live captions <configure/plugins-configuration-settings:enable live captions (experimental)>` config setting.

.. note::
The live captions functionality is available starting in Calls version v0.26.2

Kubernetes deployments
----------------------

Expand Down Expand Up @@ -467,4 +460,4 @@ On the server side, run the following:

sudo tcpdump -n port 8443

This command will output information (i.e. source and destination addresses) for all the network packets being sent or received through port ``8443``. This is a good way to check whether data is getting in and out of the instance and can be used to quickly identify network configuration issues.
This command will output information (i.e. source and destination addresses) for all the network packets being sent or received through port ``8443``. This is a good way to check whether data is getting in and out of the instance and can be used to quickly identify network configuration issues.
Loading
Loading