mirror of
https://github.com/hanzoai/team.git
synced 2026-09-30 01:57:35 +00:00
b5f007d35e
* docs: resolve cross-file anchor mismatches from RST-to-MDX migration
The Sphinx-to-Docusaurus migration converted `:ref:`/`{ref}` links using
naive text-slugification, so anchors that pointed to headings in a
different file (e.g. release-summary tables linking into their
respective changelog pages) were emitted as same-page fragments and
silently resolved to nothing.
Built a label registry from the original Sphinx `.. _label:` / `(label)=`
targets to recover the true source file for each cross-reference, then
rewrote the affected links to point at the correct file + heading
anchor. Fixes 282 broken cross-file anchors, primarily in the mobile/
desktop/server release-summary pages, plus assorted same-page anchor
mismatches caught by re-auditing after the prior admonition/anchor fix.
* docs: manually resolve remaining anchor mismatches after cross-file audit
Hand-verified fixes for anchors that fuzzy-matching alone couldn't
safely resolve (confirmed against actual heading text/context, and in a
few cases against the original RST source, before applying):
- Typos and dropped words carried over from the original Sphinx docs
(e.g. "bot-acocunts", "auto-follow-all-new-channel-threads" ->
"follow-all-new-channel-threads").
- Sphinx auto-generated duplicate-heading IDs (#id1/#id3/#id4) resolved
to their real target headings.
- Numbered-step TOC links in enterprise-roll-out-checklist.mdx that
dropped the leading "N. " used in the actual heading slugs.
- Push-notification docs pointing at the wrong file entirely
(environment-configuration-settings instead of
push-notification-server-configuration-settings).
- SAML "saml-enterprise" label resolved to its true cross-file target
(authentication-configuration-settings#saml-2-0), recovered from the
original RST label definition that the automated registry missed
because it sat after an RST transition marker.
- sso-saml-technical references converted from broken same-page/
malformed-path anchors to correct page links.
* docs: fix SAML 2.0 anchor slug (saml-2-0 -> saml-20)
github-slugger strips periods rather than hyphenating them, so "SAML
2.0" slugifies to saml-20, not saml-2-0 as previously fixed.
* docs: fix broken path links found during docs/main migration cleanup
* docs: convert div.tab blocks to Docusaurus Tabs/TabItem components
* docs: restore missing Kubernetes deployment architecture diagrams
The RST-to-MDX migration never copied over the AWS/Azure/Oracle
architecture diagrams referenced by the deployment-architecture-at-scale
page, leaving broken images in each Tabs/TabItem.
* docs: fix 7 anchor mismatches from the fragment/heading audit
Covers three root causes from the anchor mismatch breakdown:
- Fragment repeated the target page's own title instead of a real
heading, so the link is simplified to point at the bare page.
- Heading exists verbatim but lives on a sibling settings page
(experimental-configuration-settings, push-notification-server-
configuration-settings) rather than environment-configuration-settings.
- A page path was mistakenly pasted into a same-page #fragment instead
of being used as a real cross-page link.
* docs: fix 8 anchor slugs that were close but didn't match the real heading
Repoints links whose fragment was a plausible guess (typo, reworded
heading, or wrong section) at the actual auto-generated slug of the
target heading, confirmed by inspecting each target page directly.
* docs: merge split Tabs blocks so tabs render horizontally
The div.tab conversion script split some sibling tab groups into
separate single-item Tabs blocks whenever a stray blockquote marker
sat between them, causing them to render stacked instead of as one
horizontal tab bar. Merges the MySQL/PostgreSQL and Team/Enterprise
Edition tab groups back into single Tabs blocks.
* docs: remove Azure tab and restore Kubernetes deploy content
The Mattermost Operator, Azure, and Oracle platform tabs on the
Kubernetes deployment guide were split across two separate Tabs
blocks (rendering stacked instead of as one tab bar) and all three
tab bodies were empty because the migration never flattened the
original RST include directives. Removes the unsupported Azure tab
and restores the Mattermost Operator and Oracle content from the
pre-migration RST sources as a single merged Tabs block.
* addresscoderabbitreview
* docs: unify Linux/Kubernetes/Containers deploy pages and fix FIPS/STIG placement
Kubernetes and Containers duplicated full install content across a top-level
page (Tabs) and orphaned sidebar subpages that nothing linked to. Reworked
both to follow the Linux page's pattern: shared content on the landing page,
platform-specific instructions live once in their own subpage.
Also removed configure-fips-at-install-time.mdx, which claimed FIPS is
available for native Linux installs — FIPS/STIG in Mattermost is a container
image property (Chainguard-based build), not available outside Docker/
Kubernetes. Consolidated all FIPS/STIG references onto
containers/fips-stig.mdx and pointed the Mattermost Operator subpage (not
Oracle OKE, which doesn't expose image selection) at it.
* docs: fix review findings — image alt text, Important callout markup, typo
- Replace generic alt="image" on scaling diagrams with descriptive text
identifying cloud provider and user scale.
- Convert raw div.important markup in deploy-containers.mdx to the
repo's <Important> component, matching usage elsewhere in the file.
- Fix "Matermost" typo in manage-your-display-options.mdx.
---------
Co-authored-by: Hanzo Dev <[email protected]>
184 lines
11 KiB
Plaintext
184 lines
11 KiB
Plaintext
---
|
||
title: "Deploy using an EMM provider"
|
||
---
|
||
<PlanAvailability slug="entry-ent" />
|
||
|
||
You can enhance mobile security by deploying the Mattermost mobile app with [Enterprise Mobility Management (EMM)](https://en.wikipedia.org/wiki/Enterprise_mobility_management) and Mattermost AppConfig compatibility to secure mobile endpoints with management application configuration.
|
||
|
||
You can use an EMM to:
|
||
|
||
- Enforce users to download the Mattermost pre-built or custom apps managed by your organization.
|
||
- Set default server url address.
|
||
- Restrict users from changing servers.
|
||
- Enforce security policies.
|
||
|
||
An EMM provider pushes Mattermost Mobile apps to EMM-enrolled devices. This approach is recommended for organizations that typically use EMM solutions to deploy Mobile apps to meet security and compliance policies.
|
||
|
||
## Manage app configuration using AppConfig
|
||
|
||
AppConfig is our recommended approach for app configuration and management. It was introduced by the [AppConfig Community](https://www.appconfig.org/), a group of leading EMM providers and app developers who have come together to make it easier for developers and customers to drive mobility in business.
|
||
|
||
AppConfig provides an easy way to configure enterprise mobile apps with any EMM providers listed on the [AppConfig website](https://www.appconfig.org/). Using AppConfig, you can manage default settings and security controls on public app stores and custom-built mobile clients. For example, you can pre-configure your Mattermost server URL and username.
|
||
|
||
### Mattermost AppConfig values
|
||
|
||
The following table shows all the configuration options that can be sent from the EMM provider of your choice to the Mattermost mobile apps. You can also [download an XML template](https://github.com/mattermost/docs/blob/master/source/samples/mattermost-specfile.xml) of the configuration file for use with your EMM provider.
|
||
|
||
<style>
|
||
table.mattermost-plans {
|
||
border-collapse: collapse;
|
||
width: 100%;
|
||
font-size: 0.95em;
|
||
}
|
||
table.mattermost-plans th, table.mattermost-plans td {
|
||
border: 1px solid #888;
|
||
padding: 6px 8px;
|
||
vertical-align: top;
|
||
}
|
||
/* Dark mode border color */
|
||
body:not([data-custom-theme="light"]) table.mattermost-plans th,
|
||
body:not([data-custom-theme="light"]) table.mattermost-plans td {
|
||
border-color: #666;
|
||
}
|
||
table.mattermost-plans th {
|
||
background: #f2f2f2;
|
||
font-weight: bold;
|
||
text-align: left;
|
||
}
|
||
/* Dark mode support for table headers */
|
||
body:not([data-custom-theme="light"]) table.mattermost-plans th {
|
||
background: #444;
|
||
color: #fff;
|
||
}
|
||
</style>
|
||
|
||
<table class="mattermost-plans">
|
||
<thead>
|
||
<tr>
|
||
<th>Key</th>
|
||
<th>Description</th>
|
||
<th>Default/Valid Values</th>
|
||
<th>iOS Support</th>
|
||
<th>Android for Work Support</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><strong><code>inAppPinCode</code></strong><br /><em>String</em></td>
|
||
<td>Require users to authenticate as the device owner before using the app. Prompts for fingerprint or passcode when the app first opens and when the app has been in the background for more than five minutes.</td>
|
||
<td>Default: <code>false</code><br />Valid: <code>true | false</code></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong><code>blurApplicationScreen</code></strong><br /><em>String</em></td>
|
||
<td>Blur the app when it's set to background to protect any confidential on-screen information. On Android, it also prevents taking screenshots of the app.</td>
|
||
<td>Default: <code>false</code><br />Valid: <code>true | false</code></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong><code>jailbreakDetection</code></strong><br /><em>String</em></td>
|
||
<td>Disable app launch on jailbroken or rooted devices.</td>
|
||
<td>Default: <code>false</code><br />Valid: <code>true | false</code></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong><code>copyAndPasteProtection</code></strong><br /><em>String</em></td>
|
||
<td>Disable the ability to copy from or paste into any text inputs in the app.</td>
|
||
<td>Default: <code>false</code><br />Valid: <code>true | false</code></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /> (since v1.24.0)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong><code>serverUrl</code></strong><br /><em>String</em></td>
|
||
<td>Set a default Mattermost server URL. Supports a single server only while v2.0 of the mobile app supports multiple server connections.</td>
|
||
<td>Valid: URL</td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong><code>serverName</code></strong><br /><em>String</em></td>
|
||
<td>Automatically populates the server display name for the URL specified in serverURL.</td>
|
||
<td>Valid: alphanumeric or empty</td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong><code>allowOtherServers</code></strong><br /><em>String</em></td>
|
||
<td>Allow the user to change the above server URL. If set to <code>true</code>, users can connect to multiple servers that aren't specified in the server URL setting. If set to <code>false</code>, users can only connect to a single defined server.</td>
|
||
<td>Default: <code>true</code><br />Valid: <code>true | false</code></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong><code>username</code></strong><br /><em>String</em></td>
|
||
<td>Set the username or email address to use to authenticate against the Mattermost Server.</td>
|
||
<td></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong><code>useVPN</code></strong><br /><em>String</em></td>
|
||
<td>Enable connection to the Mattermost Server to use a per-app VPN or VPN on-demand.</td>
|
||
<td>Default: <code>false</code><br />Valid: <code>true | false</code></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong><code>timeoutVPN</code></strong><br /><em>String</em></td>
|
||
<td>Set how long the request waits (in milliseconds) for an initial VPN connection to establish before timeout.</td>
|
||
<td>Default: 30000</td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong><code>vendor</code></strong><br /><em>String</em></td>
|
||
<td>Name of the EMM vendor or company deploying the app. Used in help text when prompting for passcodes so users are aware why the app is being protected.</td>
|
||
<td>Default: Mattermost</td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
</tr>
|
||
<tr>
|
||
<td><strong><code>inAppSessionAuth</code></strong><br /><em>String</em></td>
|
||
<td>Use the app's internal browser for SSO instead of an external browser. From Mattermost v10.2 and mobile v2.2.1, deprecated in favor of the <a href="../../administration-guide/configure/site-configuration-settings.html#mobile-external-browser">mobile external browser</a> server configuration setting.</td>
|
||
<td>Default: <code>false</code><br />Valid: <code>true | false</code></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
<td><img src="../../_static/images/check-circle-green.svg" /></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
### Other AppConfig settings
|
||
|
||
As part of AppConfig, EMM administrators can set the following additional configuration options for the Mattermost mobile apps:
|
||
|
||
1. **App Tunnel:** Leverage the "Per-app VPN" capabilities in most commercial VPN solutions.
|
||
2. **Prevent App Backup:** Prevent users from backing up app data.
|
||
3. **Enforce App Encryption:** Set security policies such as requiring encryption.
|
||
4. **Remotely Wipe App:** Use the EMM tool to distribute the app to devices as a managed application so it can be remotely wiped. If the app was previously installed, mark it so the EMM converts the app to a managed app.
|
||
|
||
Other configurations may be available depending on your EMM provider.
|
||
|
||
<Important>
|
||
|
||
\- Mattermost only supports the AppConfig standard for securing Mattermost mobile apps via an EMM provider due to incompatibilities with app wrapping and React Native applications. Different EMM vendors refer to “wrapping” in different ways, but it ultimately comes down to unpacking the mobile client bundle, injecting additional SDKs, and re-packaging/re-signing. React Native is the technology used to develop the Mattermost mobile apps. - Mattermost doesn’t support app wrapping, and Mattermost mobile apps won't function properly when using app wrapping (e.g., Websockets for real-time messaging will break). Use app wrapping/containerization technology at your own risk. - A Mattermost Enterprise subscription plan (or a legacy Enterprise Edition license) is required to request assistance or troubleshooting help from [Mattermost Customer Support](https://mattermost.com/support/) when building and deploying custom mobile apps. Customers on other Mattermost subscription plans can develop and deploy custom mobile apps, but can't request technical support assistance through Mattermost Customer Support. - With the release of Mattermost mobile app v2.0, mobile app v1.55 becomes the official [extended support mobile release](/product-overview/mattermost-mobile-releases), and will be supported for an extended timeframe.
|
||
|
||
</Important>
|
||
|
||
## Enroll devices
|
||
|
||
When building your own custom versions or deploying the pre-built Mattermost Mobile apps, consider your organization’s mobile policy:
|
||
|
||
- Can users bring their own device (BYOD) If so, what devices will be used?
|
||
- Are devices company-owned and company-issued?
|
||
- Are both options supported?
|
||
- What operating systems do you want to start testing?
|
||
|
||
Once you know what possible device configurations you’ll be supporting, consider creating a sample configuration, then running validation tests against each configuration item.
|
||
|
||
## Generate and assign device profiles
|
||
|
||
Generate and assign a device profile for device-wide configurations through the EMM provider.
|