Skip to content

Add docs for autotranslations #8765

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.

Sign up for GitHub

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

Merged
esethna merged 12 commits into from
Mar 9, 2026
Merged

Add docs for autotranslations #8765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
991ef9a
add docs for autotranslations
BenCookie95 Mar 4, 2026
c92dcf4
model info
BenCookie95 Mar 4, 2026
faf8bf0
Address PR review feedback for autotranslation docs
BenCookie95 Mar 6, 2026
d1113b8
Update LibreTranslate link to official installation guide
BenCookie95 Mar 6, 2026
4c39fe4
Add parent Set up Auto-translation heading, nest provider/enable sect…
BenCookie95 Mar 6, 2026
93f0298
Reorder config settings to match System Console UI order
BenCookie95 Mar 6, 2026
0f2342d
Add intro sentence under Configure a translation provider heading
BenCookie95 Mar 6, 2026
070136c
Fix Agents LLM service ID table rendering
BenCookie95 Mar 6, 2026
34996a7
Update server-configuration.rst
esethna Mar 9, 2026
3eb4ef1
Update collaborate-within-channels.rst
esethna Mar 9, 2026
1f49667
Update autotranslate-messages.rst
esethna Mar 9, 2026
f0412c2
Update site-configuration-settings.rst
esethna Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
188 changes: 188 additions & 0 deletions source/administration-guide/configure/site-configuration-settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Review and manage the following site configuration options in the System Console

- `Customization <#customization>`__
- `Localization <#localization>`__
- `Auto-translation <#autotranslation>`__
- `Users and Teams <#users-and-teams>`__
- `Notifications <#notifications>`__
- `System-wide notifications <#system-wide-notifications>`__
Expand Down Expand Up @@ -568,6 +569,193 @@ Enable work in progress languages in Mattermost to review translations and ident

----

.. _autotranslation:

Auto-translation
----------------

.. include:: ../../_static/badges/ent-adv.rst
:start-after: :nosearch:

Access the following configuration settings in the System Console by going to **Site Configuration > Localization**. These settings configure automatic translation of channel messages. See the :doc:`Auto-translation setup guide </administration-guide/manage/admin/autotranslation>` for deployment details.

.. config:setting:: autotranslation-enable
:displayname: Enable autotranslation (Autotranslation)
:systemconsole: Site Configuration > Localization
:configjson: .AutoTranslationSettings.Enable
:environment: MM_AUTOTRANSLATIONSETTINGS_ENABLE
:description: Enable or disable automatic translation of channel messages. Default is **false**.

- **true**: Autotranslation is available and can be enabled per channel.
- **false**: **(Default)** Autotranslation is disabled.

Enable auto-translation
~~~~~~~~~~~~~~~~~~~~~~~

+---------------------------------------------------------------+------------------------------------------------------------------------------------+
| Enable or disable automatic translation of channel messages. | - System Config path: **Site Configuration > Localization** |
| | - ``config.json`` setting: ``AutoTranslationSettings`` > ``Enable`` > ``false`` |
| - **true**: Autotranslation is available and can be enabled | - Environment variable: ``MM_AUTOTRANSLATIONSETTINGS_ENABLE`` |
| per channel. | |
| - **false**: **(Default)** Autotranslation is disabled. | |
+---------------------------------------------------------------+------------------------------------------------------------------------------------+

.. config:setting:: autotranslation-provider
:displayname: Translation provider (Autotranslation)
:systemconsole: Site Configuration > Localization
:configjson: .AutoTranslationSettings.Provider
:environment: MM_AUTOTRANSLATIONSETTINGS_PROVIDER
:description: The translation provider to use for autotranslation. Options are ``libretranslate`` and ``agents``. Default is empty (no provider selected).

Translation provider
~~~~~~~~~~~~~~~~~~~~

+---------------------------------------------------------------+------------------------------------------------------------------------------------+
| The translation provider to use for autotranslation. | - System Config path: **Site Configuration > Localization** |
| | - ``config.json`` setting: ``AutoTranslationSettings`` > ``Provider`` |
| - ``libretranslate``: Use a self-hosted LibreTranslate | - Environment variable: ``MM_AUTOTRANSLATIONSETTINGS_PROVIDER`` |
| server for translations. | |
| - ``agents``: Use the Mattermost Agents plugin with an | |
| LLM backend for translations. | |
| | |
| Default is ``""`` (no provider selected). | |
+---------------------------------------------------------------+------------------------------------------------------------------------------------+

.. config:setting:: autotranslation-libretranslate-url
:displayname: LibreTranslate URL (Autotranslation)
:systemconsole: Site Configuration > Localization
:configjson: .AutoTranslationSettings.LibreTranslate.URL
:environment: MM_AUTOTRANSLATIONSETTINGS_LIBRETRANSLATE_URL
:description: The URL of the LibreTranslate server used for translations.

LibreTranslate URL
~~~~~~~~~~~~~~~~~~

+---------------------------------------------------------------+------------------------------------------------------------------------------------+
| The URL of the LibreTranslate server used for translations. | - System Config path: **Site Configuration > Localization** |
| The Mattermost server must be able to reach this URL. | - ``config.json`` setting: ``AutoTranslationSettings`` > ``LibreTranslate`` |
| | > ``URL`` |
| String value. | - Environment variable: ``MM_AUTOTRANSLATIONSETTINGS_LIBRETRANSLATE_URL`` |
+---------------------------------------------------------------+------------------------------------------------------------------------------------+

.. config:setting:: autotranslation-libretranslate-apikey
:displayname: LibreTranslate API key (Autotranslation)
:systemconsole: Site Configuration > Localization
:configjson: .AutoTranslationSettings.LibreTranslate.APIKey
:environment: MM_AUTOTRANSLATIONSETTINGS_LIBRETRANSLATE_APIKEY
:description: The API key for authenticated access to the LibreTranslate server. Optional if the server doesn't require authentication.

LibreTranslate API key
~~~~~~~~~~~~~~~~~~~~~~

+---------------------------------------------------------------+------------------------------------------------------------------------------------+
| The API key for authenticated access to the LibreTranslate | - System Config path: **Site Configuration > Localization** |
| server. Leave blank if the LibreTranslate server doesn't | - ``config.json`` setting: ``AutoTranslationSettings`` > ``LibreTranslate`` |
| require authentication. | > ``APIKey`` |
| | - Environment variable: ``MM_AUTOTRANSLATIONSETTINGS_LIBRETRANSLATE_APIKEY`` |
| String value. | |
+---------------------------------------------------------------+------------------------------------------------------------------------------------+

.. config:setting:: autotranslation-agents-llmserviceid
:displayname: Agents LLM service ID (Autotranslation)
:systemconsole: Site Configuration > Localization
:configjson: .AutoTranslationSettings.Agents.LLMServiceID
:environment: MM_AUTOTRANSLATIONSETTINGS_AGENTS_LLMSERVICEID
:description: The service ID of the LLM configured in the Mattermost Agents plugin to use for translations.

Agents LLM service ID
~~~~~~~~~~~~~~~~~~~~~

+---------------------------------------------------------------+------------------------------------------------------------------------------------+
| The service ID of the LLM configured in the Mattermost | - System Config path: **Site Configuration > Localization** |
| Agents plugin to use for translations. Configure LLM | - ``config.json`` setting: ``AutoTranslationSettings`` > ``Agents`` |
| services in the Agents plugin settings. | > ``LLMServiceID`` |
| | - Environment variable: ``MM_AUTOTRANSLATIONSETTINGS_AGENTS_LLMSERVICEID`` |
| String value. | |
+---------------------------------------------------------------+------------------------------------------------------------------------------------+

.. config:setting:: autotranslation-target-languages
:displayname: Languages allowed (Autotranslation)
:systemconsole: Site Configuration > Localization
:configjson: .AutoTranslationSettings.TargetLanguages
:environment: MM_AUTOTRANSLATIONSETTINGS_TARGETLANGUAGES
:description: The languages that all messages in autotranslation-enabled channels are translated into. Every message is translated into each language in this list. Default is **["en"]**.

Languages allowed
~~~~~~~~~~~~~~~~~

+---------------------------------------------------------------+------------------------------------------------------------------------------------+
| The languages that all messages in autotranslation-enabled | - System Config path: **Site Configuration > Localization** |
| channels are translated into. Every message is translated | - ``config.json`` setting: ``AutoTranslationSettings`` > ``TargetLanguages`` |
| into each language in this list, regardless of who is in | - Environment variable: ``MM_AUTOTRANSLATIONSETTINGS_TARGETLANGUAGES`` |
| the channel. Specify languages as an array of language codes. | |
| | |
| Default is ``["en"]``. | |
+---------------------------------------------------------------+------------------------------------------------------------------------------------+

.. config:setting:: autotranslation-timeout
:displayname: Translation timeout (Autotranslation)
:systemconsole: Site Configuration > Localization
:configjson: .AutoTranslationSettings.TimeoutMs
:environment: MM_AUTOTRANSLATIONSETTINGS_TIMEOUTMS
:description: The maximum time in milliseconds to wait for a translation to complete. Default is **5000**.

Translation timeout
~~~~~~~~~~~~~~~~~~~

+---------------------------------------------------------------+------------------------------------------------------------------------------------+
| The maximum time in milliseconds to wait for a translation | - System Config path: **Site Configuration > Localization** |
| to complete. If a translation exceeds this timeout, it is | - ``config.json`` setting: ``AutoTranslationSettings`` > ``TimeoutMs`` > ``5000`` |
| skipped. | - Environment variable: ``MM_AUTOTRANSLATIONSETTINGS_TIMEOUTMS`` |
| | |
| Numerical value. Default is **5000** (5 seconds). | |
+---------------------------------------------------------------+------------------------------------------------------------------------------------+

.. config:setting:: autotranslation-restrict-dm-gm
:displayname: Restrict autotranslation in direct and group messages (Autotranslation)
:systemconsole: Site Configuration > Localization
:configjson: .AutoTranslationSettings.RestrictDMAndGM
:environment: MM_AUTOTRANSLATIONSETTINGS_RESTRICTDMANDGM
:description: Restrict autotranslation from being enabled in direct and group messages. Default is **false**.

- **true**: Autotranslation can't be enabled in direct or group messages.
- **false**: **(Default)** Autotranslation can be enabled in direct and group messages.

Restrict autotranslation in direct and group messages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

+---------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| Restrict autotranslation from being enabled in direct and | - System Config path: **Site Configuration > Localization** |
| group messages. | - ``config.json`` setting: ``AutoTranslationSettings`` > ``RestrictDMAndGM`` > ``false`` |
| | - Environment variable: ``MM_AUTOTRANSLATIONSETTINGS_RESTRICTDMANDGM`` |
| - **true**: Autotranslation can't be enabled in direct or | |
| group messages. | |
| - **false**: **(Default)** Autotranslation can be enabled | |
| in direct and group messages. | |
+---------------------------------------------------------------+---------------------------------------------------------------------------------------------+

.. config:setting:: autotranslation-workers
:displayname: Translation workers (Autotranslation)
:systemconsole: N/A
:configjson: .AutoTranslationSettings.Workers
:environment: MM_AUTOTRANSLATIONSETTINGS_WORKERS
:description: The number of concurrent translation workers per node. This setting is not available in the System Console and can only be set via ``mmctl``, ``config.json``, or environment variable. Default is **6**.

Translation workers
~~~~~~~~~~~~~~~~~~~

+---------------------------------------------------------------+------------------------------------------------------------------------------------+
| The number of concurrent translation workers per node. | - ``config.json`` setting: ``AutoTranslationSettings`` > ``Workers`` > ``6`` |
| Higher values increase translation throughput but use | - Environment variable: ``MM_AUTOTRANSLATIONSETTINGS_WORKERS`` |
| more resources. This setting is not available in the System | |
| Console and can only be set via ``mmctl``, ``config.json``, | |
| or environment variable. | |
| | |
| Numerical value. Default is **6**. | |
+---------------------------------------------------------------+------------------------------------------------------------------------------------+

----

Users and teams
---------------

Expand Down
Loading