Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/main/administration-guide/administration-guide-index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Welcome to the Mattermost Administration Guide. This guide is organized into sec
Whether you’re configuring server settings, managing users, monitoring performance, or ensuring compliance, this guide provides all the information you need. Use the navigation below to access detailed instructions and best practices for each topic.

- [Self-hosted billing](/administration-guide/manage/admin/self-hosted-billing) - Billing and payment options for Mattermost self-hosted deployments.
- [Cloud workspace management](/administration-guide/cloud-workspace-management) - Learn how to manage cloud workspaces in Mattermost.
- [Cloud workspace management](/administration-guide/manage/cloud-workspace-management) - Learn how to manage cloud workspaces in Mattermost.
- [Server maintenance](/administration-guide/manage/admin/server-maintenance) - Learn about Mattermost server maintenance and best practices.
- [Server configuration](/administration-guide/manage/admin/server-configuration) - Learn about server configuration and settings.
- [User provisioning](/administration-guide/manage/admin/user-provisioning) - Learn about user provisioning and management.
- [User management](/administration-guide/manage/admin/user-management) - Learn about user management and best practices.
- [Monitoring and performance](/administration-guide/manage/admin/monitoring-and-performance) - Learn about monitoring and performance optimization.
- [Compliance](/administration-guide/compliance-with-mattermost) - Learn about compliance and security best practices.
- [Compliance](/administration-guide/comply/comply-index) - Learn about compliance and security best practices.
- [Migration](/administration-guide/manage/admin/migration) - Learn about migrating to Mattermost.
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Compliance with Mattermost"
sidebar_label: "Comply"
---
Mattermost is purpose-built to help enterprises keep sensitive data safe and compliant in the strictest, most complex environments. Mattermost Enterprise Edition includes features designed to make compliance with all relevant regulations and internal policies easy to achieve and maintain.

Expand Down
3 changes: 2 additions & 1 deletion docs/main/administration-guide/configure/email-templates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,8 @@ The email templates are located in the Mattermost server directory in the `templ
</tr>
<tr>
<td>Button</td>
<td colspan="2">Button for email verification | api.templates.verify_body.button</td>
<td>Button for email verification</td>
<td>api.templates.verify_body.button</td>
</tr>
</tbody>
</table>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ Review and manage the following [experimental](/administration-guide/manage/feat

<Tip>

System admins managing a self-hosted Mattermost deployment can edit the `config.json` file as described in the following tables. Each configuration value below includes a JSON path to access the value programmatically in the `config.json` file using a JSON-aware tool. For example, the `EmailBatchingBufferSize` value is under `EmailSettings`.
System admins managing a self-hosted Mattermost deployment can edit the `config.json` file as described in the following tables. Each configuration value below includes a JSON path to access the value programmatically in the `config.json` file using a JSON-aware tool. For example, the `LinkMetadataTimeoutMilliseconds` value is under `ExperimentalSettings`.

- If using a tool such as [jq](https://stedolan.github.io/jq/), you'd enter: `cat config/config.json | jq '.EmailSettings.EmailBatchingBufferSize'`
- When working with the `config.json` file manually, look for an object such as `EmailSettings`, then within that object, find the key `EmailBatchingBufferSize`.
- If using a tool such as [jq](https://stedolan.github.io/jq/), you'd enter: `cat config/config.json | jq '.ExperimentalSettings.LinkMetadataTimeoutMilliseconds'`
- When working with the `config.json` file manually, look for an object such as `ExperimentalSettings`, then within that object, find the key `LinkMetadataTimeoutMilliseconds`.

</Tip>

Expand Down Expand Up @@ -56,51 +56,6 @@ Adds a configurable timeout for requests made to return link metadata. If the me
</tbody>
</table>

### Email batching buffer size

Specify the maximum number of notifications batched into a single email.

<Note>

- We recommend increasing the buffer size from the default value if you see the following error in the Mattermost logs: `Email batching job's receiving buffer was full. Please increase the EmailBatchingBufferSize. Falling back to sending immediate mail.` Increasing this value will ensure emails are queued up, without impacting server performance.
- Notifications will be sent instantly if the queue of emails exceeds the [email batching interval](#email-batching-interval) configured.

</Note>

<table>
<colgroup>
<col style={{width: '100%'}} />
</colgroup>
<tbody>
<tr>
<td>This feature's <code>config.json</code> setting is <code>EmailBatchingBufferSize</code>: 256`` with numerical input.</td>
</tr>
</tbody>
</table>

### Email batching interval

Specify the maximum frequency, in seconds, which the batching job checks for new notifications.

<Note>

- We recommend decreasing the email batching interval from the default value if you see the following error in the Mattermost logs: `Email batching job's receiving buffer was full. Please increase the EmailBatchingBufferSize. Falling back to sending immediate mail.`.
- Longer batching intervals may increase performance.
- Notifications will be sent instantly if the [queue of emails](#email-batching-buffer-size) exceeds the email batching interval configured.

</Note>

<table>
<colgroup>
<col style={{width: '100%'}} />
</colgroup>
<tbody>
<tr>
<td>This feature's <code>config.json</code> setting is <code>EmailBatchingInterval": 30</code> with numerical input.</td>
</tr>
</tbody>
</table>

### Enable automatic replies

**True**: Users can enable Automatic Replies in **Settings \> Notifications**. Users set a custom message that will be automatically sent in response to Direct Messages.
Expand Down Expand Up @@ -202,23 +157,6 @@ If the team URL of the primary team is `https://example.mattermost.com/myteam/`,
</tbody>
</table>

### Use channel name in email notifications

**True**: Channel and team name appears in email notification subject lines. Useful for servers using only one team.

**False**: Only team name appears in email notification subject line.

<table>
<colgroup>
<col style={{width: '100%'}} />
</colgroup>
<tbody>
<tr>
<td>This feature's <code>config.json</code> setting is <code>"UseChannelInEmailNotifications": false</code> with options <code>true</code> and <code>false</code>.</td>
</tr>
</tbody>
</table>

### Disable data refetching on browser refocus

This setting disables re-fetching of channel and channel members on browser focus.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ See the [navigate boards](/end-user-guide/project-management/navigate-boards) do

## Work with boards

See the [project and task management](/end-user-guide/project-task-management) end user documentation to learn how to align, define, organize, track, and manage work across teams.
See the [project and task management](/end-user-guide/project-management/project-management-index) end user documentation to learn how to align, define, organize, track, and manage work across teams.
Original file line number Diff line number Diff line change
Expand Up @@ -31,37 +31,18 @@ The following optimization areas can alert you to workspace suggestions, warning
<col style={{width: '34%'}} />
<col style={{width: '57%'}} />
</colgroup>
<tbody>
<thead>
<tr>
<td rowspan="2"><blockquote>
<p>Optimization category</p>
</blockquote>
<dl>
<dt>=======================</dt>
<dd>
<p>Mattermost release</p>
</dd>
</dl></td>
<td rowspan="2"><blockquote>
<p>Suggestions, Warnings, or Problems Detected</p>
</blockquote>
<dl>
<dt>==========================================================================================================</dt>
<dd>
<p>Are you on the latest Mattermost release?</p>
</dd>
</dl></td>
<td rowspan="2"><blockquote>
<p>Additional Information |</p>
</blockquote>
<dl>
<dt>======================================================================================================================================================================+</dt>
<dd>
<p>You're notified when updates are available. | See the <a href="/administration-guide/upgrade/upgrading-mattermost-server">Upgrade Mattermost</a> product documentation for details on upgrading your workspace. |</p>
</dd>
</dl></td>
<th>Optimization category</th>
<th>Suggestions, Warnings, or Problems Detected</th>
<th>Additional Information</th>
</tr>
</thead>
<tbody>
<tr>
<td>Mattermost release</td>
<td>Are you on the latest Mattermost release?</td>
<td><p>You're notified when updates are available.</p><p>See the <a href="/administration-guide/upgrade/upgrading-mattermost-server">Upgrade Mattermost</a> product documentation for details on upgrading your workspace.</p></td>
</tr>
<tr>
<td>Configuration issues</td>
Expand All @@ -70,63 +51,30 @@ The following optimization areas can alert you to workspace suggestions, warning
<li><strong>Session Length</strong>: The default value may not provide an optimal user experience.</li>
<li><strong>File Storage</strong>: Write access to the configured file storage location is required.</li>
</ul></td>
<td><dl>
<dt>See the product documentation to learn more: |</dt>
<dd>
<div class="line-block"></div>
</dd>
</dl>
<ul>
<li><a href="/administration-guide/onboard/ssl-client-certificate">Set up SSL</a> |</li>
<li><a href="/administration-guide/configure/environment-configuration-settings#session-lengths">Configure session length</a></li>
<li><dl>
<dt><a href="/administration-guide/configure/environment-configuration-settings#file-storage">Configure file storage</a></dt>
<dd>
<h3 id="section">|</h3>
</dd>
</dl></li>
</ul></td>
<td><p>See the product documentation to learn more:</p><ul><li><a href="/administration-guide/onboard/ssl-client-certificate">Set up SSL</a></li><li><a href="/administration-guide/configure/environment-configuration-settings#session-lengths">Configure session length</a></li><li><a href="/administration-guide/configure/environment-configuration-settings#file-storage">Configure file storage</a></li></ul></td>
</tr>
<tr>
<td>Workspace access</td>
<td>Is the Mattermost workspace accessible to users?</td>
<td>If your web server settings don't pass a live URL test, your workspace may not be accessible to others. | See the <a href="/administration-guide/configure/environment-configuration-settings#web-server">Web server configuration settings</a> product documentation to learn more:</td>
<td>If your web server settings don't pass a live URL test, your workspace may not be accessible to others. See the <a href="/administration-guide/configure/environment-configuration-settings#web-server">Web server configuration settings</a> product documentation to learn more.</td>
</tr>
<tr>
<td>Search performance</td>
<td>As your user base grows, is search getting slower?</td>
<td>See the <a href="/administration-guide/scale/enterprise-search">Enterprise search</a> product documentation to learn more. |</td>
<td>See the <a href="/administration-guide/scale/enterprise-search">Enterprise search</a> product documentation to learn more.</td>
</tr>
<tr>
<td>Data privacy</td>
<td>Do you need more control and insights into your data?</td>
<td><dl>
<dt>See the product documentation to learn more: |</dt>
<dd>
<div class="line-block"></div>
</dd>
</dl>
<ul>
<li><a href="/administration-guide/comply/data-retention-policy">Data Retention</a> |</li>
<li><a href="/administration-guide/comply/compliance-export">Compliance Export</a> |</li>
</ul></td>
<td><p>See the product documentation to learn more:</p><ul><li><a href="/administration-guide/comply/data-retention-policy">Data Retention</a></li><li><a href="/administration-guide/comply/compliance-export">Compliance Export</a></li></ul></td>
</tr>
<tr>
<td>User authentication</td>
<td><ul>
<li><strong>AD/LDAP</strong>: As your user base grows, would you benefit from easier onboarding, automated deactivations, and role assignments?</li>
<li><strong>Guest accounts</strong>: Do you want to control user access to channels and teams with guest accounts?</li>
</ul></td>
<td><dl>
<dt>See the product documentation to learn more: |</dt>
<dd>
<div class="line-block"></div>
</dd>
</dl>
<ul>
<li><a href="/administration-guide/configure/authentication-configuration-settings#adldap">AD/LDAP</a></li>
<li><a href="/administration-guide/onboard/guest-accounts">Guest accounts</a> |</li>
</ul></td>
<td><p>See the product documentation to learn more:</p><ul><li><a href="/administration-guide/configure/authentication-configuration-settings#adldap">AD/LDAP</a></li><li><a href="/administration-guide/onboard/guest-accounts">Guest accounts</a></li></ul></td>
</tr>
</tbody>
</table>
Loading
Loading