Skip to content

Commit

Permalink
[MM-54496] Document authentication options to Calls services (#6685)
Browse files Browse the repository at this point in the history 
* Document authentication options to Calls services

* Fix env variable names

* Remove extra space
  • Loading branch information
@streamer45
streamer45 authored Oct 12, 2023
1 parent ab0b9ee commit d7af260
Showing 1 changed file with 23 additions and 13 deletions.
36 changes: 23 additions & 13 deletions source/configure/plugins-configuration-settings.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -432,14 +432,19 @@ RTCD service URL
.. include:: ../_static/badges/ent-selfhosted-only.rst
:start-after: :nosearch:

+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| The URL to a running `rtcd <https://github.com/mattermost/rtcd>`__ service instance that will host the calls. | - System Config path: **Plugins > Calls** |
| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.rtcdserviceurl`` |
| | - Environment variable: N/A |
| When set (non empty) all the calls will be handled by this external service. | |
| | |
| This is an optional field. Changing this setting requires a plugin restart to take effect. | |
+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| The URL to a running `rtcd <https://github.com/mattermost/rtcd>`__ service instance that will host the calls. | - System Config path: **Plugins > Calls** |
| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.rtcdserviceurl`` |
| | - Environment variable: N/A |
| When set (non empty) all the calls will be handled by this external service. | |
| | |
| This is an optional field. Changing this setting requires a plugin restart to take effect. | |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Note**: |
| |
| - The client will self-register the first time it connects to the service and store the authentication key in the database. If no client ID is explicitly provided, the diagnostic ID of the Mattermost installation will be used. |
| - The service URL supports credentials in the form ``http://clientID:authKey@hostname``. Alternatively these can be passed through environment overrides to the Mattermost server, namely ``MM_CALLS_RTCD_CLIENT_ID`` and ``MM_CALLS_RTCD_AUTH_KEY`` |
+---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+

.. config:setting:: plugins-callsmaxcallparticipants
:displayname: Max call participants (Plugins - Calls)
Expand Down Expand Up @@ -670,11 +675,16 @@ Job service URL
.. include:: ../_static/badges/ent-selfhosted-only.rst
:start-after: :nosearch:

+------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| The URL to a running job service where all the processing related to recordings happens. The recorded files produced are stored in Mattermost. | - System Config path: **Plugins > Calls** |
| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.jobserviceurl`` |
| This is a required field. Changing this setting requires a plugin restart to take effect. | |
+------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
+------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| The URL to a running job service where all the processing related to recordings happens. The recorded files produced are stored in Mattermost. | - System Config path: **Plugins > Calls** |
| | - ``config.json`` setting: ``PluginSettings.Plugins.com.mattermost.calls.jobserviceurl`` |
| This is a required field. Changing this setting requires a plugin restart to take effect. | |
+------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| **Note**: |
| |
| - The client will self-register the first time it connects to the service and store the authentication key in the database. If no client ID is explicitly provided, the diagnostic ID of the Mattermost installation will be used. |
| - The service URL supports credentials in the form ``http://clientID:authKey@hostname``. Alternatively these can be passed through environment overrides to the Mattermost server, namely ``MM_CALLS_JOB_SERVICE_CLIENT_ID`` and ``MM_CALLS_JOB_SERVICE_AUTH_KEY``. |
+------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+

.. config:setting:: plugins-maximumcallrecordingduration
:displayname: Maximum call recording duration (Plugins - Calls)
Expand Down

0 comments on commit d7af260

Please sign in to comment.