diff --git a/scripts/migrate_badges.py b/scripts/migrate_badges.py new file mode 100644 index 00000000000..a8bfcc19cff --- /dev/null +++ b/scripts/migrate_badges.py @@ -0,0 +1,166 @@ +#!/usr/bin/env python3 +import os +import re +from pathlib import Path + +ROOT = Path(__file__).resolve().parents[1] +SRC = ROOT / "source" +BADGES_DIR = SRC / "_static" / "badges" + +# Allowed final badge basenames +ALLOWED = {"all-commercial", "entry-ent", "pro-plus", "ent-plus", "ent-adv", "ent-cloud-dedicated"} + +# Patterns to find include directives in .rst and .md +# Allow any relative depth before _static/badges/ +RST_INCLUDE_RE = re.compile(r"(^\s*\.\.\s+include::\s+)(.+/_static/badges/)([\w\-]+)(\.(?:rst|md))\s*$") +MD_INCLUDE_RE = re.compile(r"(^\s*```\{include\}\s+)(.+/_static/badges/)([\w\-]+)(\.(?:rst|md))\s*$") + + +def map_badge(basename: str, page_text: str) -> str: + # Preserve these as-is + if basename in {"ent-cloud-dedicated"}: + return basename + + # Normalize prior migration outputs and deployment-only leftovers + if basename in {"entry-plus", "cloud-only", "cloud-selfhosted", "selfhosted-only", "ent-selfhosted"}: + basename = "all-commercial" + + # All Plans -> all-commercial + if basename.startswith("allplans"): + return "all-commercial" + + # Generic deployment-only labels + if basename in {"cloud-selfhosted", "selfhosted-only"}: + return "entry-plus" + + # ent-adv family -> ent-adv + if basename.startswith("ent-adv"): + return "ent-adv" + + # ent-pro family -> pro-plus + if basename.startswith("ent-pro") or basename.startswith("entpro"): + return "pro-plus" + + # Remaining ent-* -> ent-plus + if basename.startswith("ent-") or basename == "ent": + # Avoid overriding preserved ones handled above + return "ent-plus" + + # Exception keyword rules from page content + text_lower = page_text.lower() + entry_ent_keywords = [ + "kubernetes", "performance monitoring", "advanced logging", "ldap group", "ldap channel", + "ldap team sync", "id-only push notifications", "boards", "ms teams", "microsoft teams", "shared channels" + ] + ent_plus_keywords = [ + "high availability", "scaling for enterprise", "enterprise search", "rtcd", "offloader", + "delegated granular admin", "data retention", "legal hold", "compliance export", "e-discovery", "ediscovery", + "channel export", "custom end user terms of service", "emm", "appconfig" + ] + + if any(k in text_lower for k in entry_ent_keywords): + return "entry-ent" + if any(k in text_lower for k in ent_plus_keywords): + return "ent-plus" + + # If previously set to entry-ent but no entry-ent keywords present, default to all-commercial + if basename == "entry-ent": + return "all-commercial" + + # Fallback: keep original basename if we didn't match any rule + return basename + + +def desired_ext_for_file(file_path: Path) -> str: + return ".md" if file_path.suffix == ".md" else ".rst" + + +def process_file(path: Path): + changed = False + content = path.read_text(encoding="utf-8") + lines = content.splitlines(True) + new_lines = [] + for line in lines: + m = RST_INCLUDE_RE.match(line) + md = MD_INCLUDE_RE.match(line) + if path.suffix == ".rst" and m: + prefix, base_dir, name, ext = m.groups() + new_name = map_badge(name, content) + new_ext = desired_ext_for_file(path) + # Preserve academy and other non-plan badges + if name.startswith("academy-"): + new_lines.append(line) + continue + if new_name != name or ext != new_ext: + new_line = f"{prefix}{base_dir}{new_name}{new_ext}\n" + new_lines.append(new_line) + changed = True + else: + new_lines.append(line) + elif path.suffix == ".md" and md: + prefix, base_dir, name, ext = md.groups() + new_name = map_badge(name, content) + new_ext = desired_ext_for_file(path) + if name.startswith("academy-"): + new_lines.append(line) + continue + if new_name != name or ext != new_ext: + new_line = f"{prefix}{base_dir}{new_name}{new_ext}\n" + new_lines.append(new_line) + changed = True + else: + new_lines.append(line) + else: + new_lines.append(line) + + # Removed one-badge-per-page enforcement; preserve all includes + + if changed: + path.write_text("".join(new_lines), encoding="utf-8") + return changed + + +def main(): + changed_files = [] + for root, _dirs, files in os.walk(SRC): + for fn in files: + if fn.endswith((".rst", ".md")): + p = Path(root) / fn + if process_file(p): + changed_files.append(str(p.relative_to(ROOT))) + + # Verify includes + invalid_includes = [] + missing_md_badges = set() + include_re = re.compile(r"_static/badges([/\\])/([\w\-]+)\.(rst|md)") + for root, _dirs, files in os.walk(SRC): + for fn in files: + if fn.endswith((".rst", ".md")): + p = Path(root) / fn + txt = p.read_text(encoding="utf-8") + for m in include_re.finditer(txt): + name = m.group(2) + ext = m.group(3) + if name.startswith("academy-"): + continue + if name not in ALLOWED: + invalid_includes.append((str(p.relative_to(ROOT)), f"{name}.{ext}")) + if ext == "md": + badge_md = BADGES_DIR / f"{name}.md" + if not badge_md.exists(): + missing_md_badges.add(f"{name}.md") + + report = [] + report.append("Changed files:\n" + "\n".join(changed_files)) + report.append("\nInvalid badge includes after migration (should be empty):\n" + "\n".join(f"{f} -> {badge}" for f, badge in invalid_includes)) + report.append("\nMissing .md badges to create (if any):\n" + "\n".join(sorted(missing_md_badges))) + out_path = ROOT / "build" / "badge_migration_report.txt" + out_path.parent.mkdir(parents=True, exist_ok=True) + out_path.write_text("\n\n".join(report), encoding="utf-8") + print(out_path) + + +if __name__ == "__main__": + main() + + diff --git a/source/_static/badges/all-commercial.md b/source/_static/badges/all-commercial.md new file mode 100644 index 00000000000..df058af410f --- /dev/null +++ b/source/_static/badges/all-commercial.md @@ -0,0 +1,11 @@ +```{raw} html +
+``` + +![plans-img-yellow](/_static/images/badges/flag_icon_yellow.svg) Available on [Entry, Professional, Enterprise, and Enterprise Advanced](https://mattermost.com/pricing/) plans + +```{raw} html +
+``` + + diff --git a/source/_static/badges/all-commercial.rst b/source/_static/badges/all-commercial.rst new file mode 100644 index 00000000000..cf12550c52b --- /dev/null +++ b/source/_static/badges/all-commercial.rst @@ -0,0 +1,14 @@ +:orphan: +:nosearch: + +.. raw:: html + +
+ +|plans-img-yellow| Available on `Entry, Professional, Enterprise, and Enterprise Advanced plans `__ + +.. raw:: html + +
+ + diff --git a/source/_static/badges/allplans-cloud-selfhosted.md b/source/_static/badges/allplans-cloud-selfhosted.md deleted file mode 100644 index 0819de3ec62..00000000000 --- a/source/_static/badges/allplans-cloud-selfhosted.md +++ /dev/null @@ -1,11 +0,0 @@ -```{raw} html -
-``` - -![plans-img](/_static/images/badges/flag_icon.svg) Available on {doc}`all plans ` - -![deployment-img](/_static/images/badges/deployment_icon.svg) [Cloud](https://mattermost.com/sign-up/) and [self-hosted](https://mattermost.com/download/) deployments - -```{raw} html -
-``` \ No newline at end of file diff --git a/source/_static/badges/allplans-cloud-selfhosted.rst b/source/_static/badges/allplans-cloud-selfhosted.rst deleted file mode 100644 index 30b5518f19f..00000000000 --- a/source/_static/badges/allplans-cloud-selfhosted.rst +++ /dev/null @@ -1,14 +0,0 @@ -:orphan: -:nosearch: - -.. raw:: html - -
- -|plans-img| Available on :doc:`all plans ` - -|deployment-img| `Cloud `__ and `self-hosted `__ deployments - -.. raw:: html - -
diff --git a/source/_static/badges/allplans-cloud.rst b/source/_static/badges/allplans-cloud.rst deleted file mode 100644 index 8f695f3d204..00000000000 --- a/source/_static/badges/allplans-cloud.rst +++ /dev/null @@ -1,14 +0,0 @@ -:orphan: -:nosearch: - -.. raw:: html - -
- -|plans-img| Available on :doc:`all plans ` - -|deployment-img| `Cloud `__ deployments - -.. raw:: html - -
diff --git a/source/_static/badges/allplans-selfhosted.md b/source/_static/badges/allplans-selfhosted.md deleted file mode 100644 index 14bbd808cb1..00000000000 --- a/source/_static/badges/allplans-selfhosted.md +++ /dev/null @@ -1,11 +0,0 @@ -```{raw} html -
-``` - -![plans-img](/_static/images/badges/flag_icon.svg) Available on {doc}`all plans ` - -![deployment-img](/_static/images/badges/deployment_icon.svg) [self-hosted](https://mattermost.com/download/) deployments - -```{raw} html -
-``` \ No newline at end of file diff --git a/source/_static/badges/allplans-selfhosted.rst b/source/_static/badges/allplans-selfhosted.rst deleted file mode 100644 index 1ed0536dd10..00000000000 --- a/source/_static/badges/allplans-selfhosted.rst +++ /dev/null @@ -1,14 +0,0 @@ -:orphan: -:nosearch: - -.. raw:: html - -
- -|plans-img| Available on :doc:`all plans ` - -|deployment-img| `self-hosted `__ deployments - -.. raw:: html - -
diff --git a/source/_static/badges/cloud-selfhosted.rst b/source/_static/badges/cloud-selfhosted.rst deleted file mode 100644 index ed9b68dabb3..00000000000 --- a/source/_static/badges/cloud-selfhosted.rst +++ /dev/null @@ -1,12 +0,0 @@ -:orphan: -:nosearch: - -.. raw:: html - -
- -|deployment-img| `Cloud `__ and `self-hosted `__ deployments - -.. raw:: html - -
diff --git a/source/_static/badges/ent-adv-cloud-selfhosted.rst b/source/_static/badges/ent-adv-cloud-selfhosted.rst deleted file mode 100644 index 12d56dc8f6e..00000000000 --- a/source/_static/badges/ent-adv-cloud-selfhosted.rst +++ /dev/null @@ -1,14 +0,0 @@ -:orphan: -:nosearch: - -.. raw:: html - -
- -|plans-img| Available on `Enterprise Advanced plans `__ - -|deployment-img| `Cloud `__ and `self-hosted `__ deployments - -.. raw:: html - -
diff --git a/source/_static/badges/ent-adv-only.md b/source/_static/badges/ent-adv-only.md deleted file mode 100644 index 69138d8681a..00000000000 --- a/source/_static/badges/ent-adv-only.md +++ /dev/null @@ -1,9 +0,0 @@ -```{raw} html -
-``` - -![plans-img](/_static/images/badges/flag_icon.svg) Available only on [Enterprise Advanced](https://mattermost.com/pricing/) plans - -```{raw} html -
-``` diff --git a/source/_static/badges/ent-adv-selfhosted.rst b/source/_static/badges/ent-adv-selfhosted.rst deleted file mode 100644 index 857ad003c29..00000000000 --- a/source/_static/badges/ent-adv-selfhosted.rst +++ /dev/null @@ -1,14 +0,0 @@ -:orphan: -:nosearch: - -.. raw:: html - -
- -|plans-img| Available on `Enterprise Advanced plans `__ - -|deployment-img| `self-hosted `__ deployments - -.. raw:: html - -
\ No newline at end of file diff --git a/source/_static/badges/ent-adv.md b/source/_static/badges/ent-adv.md new file mode 100644 index 00000000000..10120a59787 --- /dev/null +++ b/source/_static/badges/ent-adv.md @@ -0,0 +1,11 @@ +```{raw} html +
+``` + +![plans-img-yellow](/_static/images/badges/flag_icon_yellow.svg) Available on [Enterprise Advanced](https://mattermost.com/pricing/) plans + +```{raw} html +
+``` + + diff --git a/source/_static/badges/ent-adv.rst b/source/_static/badges/ent-adv.rst new file mode 100644 index 00000000000..e4f7a91ee01 --- /dev/null +++ b/source/_static/badges/ent-adv.rst @@ -0,0 +1,14 @@ +:orphan: +:nosearch: + +.. raw:: html + +
+ +|plans-img-yellow| Available on `Enterprise Advanced `__ plans + +.. raw:: html + +
+ + diff --git a/source/_static/badges/ent-cloud-only.rst b/source/_static/badges/ent-cloud-only.rst deleted file mode 100644 index 1212df9b0e7..00000000000 --- a/source/_static/badges/ent-cloud-only.rst +++ /dev/null @@ -1,14 +0,0 @@ -:orphan: -:nosearch: - -.. raw:: html - -
- -|plans-img| Available only on `Enterprise and Enterprise Advanced plans `__ - -|deployment-img| Available only for `Cloud `__ deployments - -.. raw:: html - -
diff --git a/source/_static/badges/ent-cloud-selfhosted.rst b/source/_static/badges/ent-cloud-selfhosted.rst deleted file mode 100644 index eb249f44949..00000000000 --- a/source/_static/badges/ent-cloud-selfhosted.rst +++ /dev/null @@ -1,14 +0,0 @@ -:orphan: -:nosearch: - -.. raw:: html - -
- -|plans-img| Available on `Enterprise and Enteprise Advanced plans `__ - -|deployment-img| `Cloud `__ and `self-hosted `__ deployments - -.. raw:: html - -
diff --git a/source/_static/badges/ent-only.md b/source/_static/badges/ent-only.md deleted file mode 100644 index 4010a00a2d1..00000000000 --- a/source/_static/badges/ent-only.md +++ /dev/null @@ -1,12 +0,0 @@ -```{raw} html -
-``` - -![plans-img](/_static/images/badges/flag_icon.svg) Available only on [Enterprise and Enterprise Advanced](https://mattermost.com/pricing/) plans - -```{raw} html -
-``` - - - diff --git a/source/_static/badges/ent-plus.md b/source/_static/badges/ent-plus.md new file mode 100644 index 00000000000..8e49bce5a36 --- /dev/null +++ b/source/_static/badges/ent-plus.md @@ -0,0 +1,11 @@ +```{raw} html +
+``` + +![plans-img-yellow](/_static/images/badges/flag_icon_yellow.svg) Available on [Enterprise and Enterprise Advanced](https://mattermost.com/pricing/) plans + +```{raw} html +
+``` + + diff --git a/source/_static/badges/ent-adv-only.rst b/source/_static/badges/ent-plus.rst similarity index 55% rename from source/_static/badges/ent-adv-only.rst rename to source/_static/badges/ent-plus.rst index 15637b4083a..9374dc2e95a 100644 --- a/source/_static/badges/ent-adv-only.rst +++ b/source/_static/badges/ent-plus.rst @@ -7,10 +7,10 @@
-Note - -|plans-img-yellow| Available only on `Enterprise Advanced `__ plans +|plans-img-yellow| Available on `Enterprise and Enterprise Advanced plans `__ .. raw:: html -
\ No newline at end of file + + + diff --git a/source/_static/badges/ent-pro-cloud-selfhosted.rst b/source/_static/badges/ent-pro-cloud-selfhosted.rst deleted file mode 100644 index e9a216c06bc..00000000000 --- a/source/_static/badges/ent-pro-cloud-selfhosted.rst +++ /dev/null @@ -1,14 +0,0 @@ -:orphan: -:nosearch: - -.. raw:: html - -
- -|plans-img| Available on `Professional, Enterprise, and Enterprise Advanced plans `__ - -|deployment-img| `Cloud `__ and `self-hosted `__ deployments - -.. raw:: html - -
diff --git a/source/_static/badges/ent-pro-only.rst b/source/_static/badges/ent-pro-only.rst deleted file mode 100644 index b44104f920d..00000000000 --- a/source/_static/badges/ent-pro-only.rst +++ /dev/null @@ -1,16 +0,0 @@ -:orphan: -:nosearch: - -.. If used with include::, note the paths for images - -.. raw:: html - -
- -Note - -|plans-img-yellow| Available only on `Professional, Enterprise, or Enterprise Advanced plans `__ - -.. raw:: html - -
\ No newline at end of file diff --git a/source/_static/badges/ent-pro-selfhosted.rst b/source/_static/badges/ent-pro-selfhosted.rst deleted file mode 100644 index 34ee8ea533a..00000000000 --- a/source/_static/badges/ent-pro-selfhosted.rst +++ /dev/null @@ -1,14 +0,0 @@ -:orphan: -:nosearch: - -.. raw:: html - -
- -|plans-img| Available on `Professional, Enterprise, and Enterprise Advanced plans `__ - -|deployment-img| `self-hosted `__ deployments - -.. raw:: html - -
diff --git a/source/_static/badges/ent-selfhosted-only.rst b/source/_static/badges/ent-selfhosted-only.rst deleted file mode 100644 index f38a658c6e0..00000000000 --- a/source/_static/badges/ent-selfhosted-only.rst +++ /dev/null @@ -1,16 +0,0 @@ -:orphan: -:nosearch: - -.. raw:: html - -
- -Note - -|plans-img-yellow| Available only on `Enterprise and Enterprise Advanced `__ plans - -|deployment-img-yellow| Available only for `self-hosted `__ deployments - -.. raw:: html - -
\ No newline at end of file diff --git a/source/_static/badges/ent-selfhosted.rst b/source/_static/badges/ent-selfhosted.rst deleted file mode 100644 index e06ac0ff6c9..00000000000 --- a/source/_static/badges/ent-selfhosted.rst +++ /dev/null @@ -1,14 +0,0 @@ -:orphan: -:nosearch: - -.. raw:: html - -
- -|plans-img| Available on `Enterprise and Enterprise Advanced plans `__ - -|deployment-img| `self-hosted `__ deployments - -.. raw:: html - -
diff --git a/source/_static/badges/entpro-cloud-free.rst b/source/_static/badges/entpro-cloud-free.rst deleted file mode 100644 index 4a93dc69f48..00000000000 --- a/source/_static/badges/entpro-cloud-free.rst +++ /dev/null @@ -1,12 +0,0 @@ -:orphan: -:nosearch: - -.. No longer used; replaced by ent-pro-cloud-selfhosted - -.. raw:: html - -
- -|plans-img| Available on `Professional, Enterprise, and Enterprise Advanced plans `__ - -|deployment-img| `Cloud `__ and `self-hosted `__ deployments diff --git a/source/_static/badges/entry-ent.md b/source/_static/badges/entry-ent.md new file mode 100644 index 00000000000..53971086d86 --- /dev/null +++ b/source/_static/badges/entry-ent.md @@ -0,0 +1,11 @@ +```{raw} html +
+``` + +![plans-img-yellow](/_static/images/badges/flag_icon_yellow.svg) Available on [Entry, Enterprise, and Enterprise Advanced](https://mattermost.com/pricing/) plans (not available on Professional) + +```{raw} html +
+``` + + diff --git a/source/_static/badges/entry-ent.rst b/source/_static/badges/entry-ent.rst new file mode 100644 index 00000000000..b59528733d5 --- /dev/null +++ b/source/_static/badges/entry-ent.rst @@ -0,0 +1,16 @@ +:orphan: +:nosearch: + +.. If used with include::, note the paths for images + +.. raw:: html + +
+ +|plans-img-yellow| Available on `Entry, Enterprise, and Enterprise Advanced plans `__ (not available on Professional) + +.. raw:: html + +
+ + diff --git a/source/_static/badges/pro-plus.md b/source/_static/badges/pro-plus.md new file mode 100644 index 00000000000..c5369c224c6 --- /dev/null +++ b/source/_static/badges/pro-plus.md @@ -0,0 +1,11 @@ +```{raw} html +
+``` + +![plans-img-yellow](/_static/images/badges/flag_icon_yellow.svg) Available on [Professional, Enterprise, and Enterprise Advanced](https://mattermost.com/pricing/) plans + +```{raw} html +
+``` + + diff --git a/source/_static/badges/ent-only.rst b/source/_static/badges/pro-plus.rst similarity index 52% rename from source/_static/badges/ent-only.rst rename to source/_static/badges/pro-plus.rst index 054d4f66dfa..bdb729ed210 100644 --- a/source/_static/badges/ent-only.rst +++ b/source/_static/badges/pro-plus.rst @@ -7,10 +7,10 @@
-Note - -|plans-img-yellow| Available only on `Enterprise and Enterprise Advanced plans `__ +|plans-img-yellow| Available on `Professional, Enterprise, and Enterprise Advanced plans `__ .. raw:: html -
\ No newline at end of file +
+ + diff --git a/source/_static/badges/selfhosted-only.md b/source/_static/badges/selfhosted-only.md deleted file mode 100644 index e3e58096f5a..00000000000 --- a/source/_static/badges/selfhosted-only.md +++ /dev/null @@ -1,11 +0,0 @@ -```{raw} html -
-``` - -Note - -![deployment-img-yellow](/_static/images/badges/deployment_icon_yellow.svg) Available only for [self-hosted](https://mattermost.com/download/) deployments - -```{raw} html -
-``` \ No newline at end of file diff --git a/source/_static/badges/selfhosted-only.rst b/source/_static/badges/selfhosted-only.rst deleted file mode 100644 index 1ded0d4835c..00000000000 --- a/source/_static/badges/selfhosted-only.rst +++ /dev/null @@ -1,14 +0,0 @@ -:orphan: -:nosearch: - -.. raw:: html - -
- -Note - -|deployment-img-yellow| Available only for `self-hosted `__ deployments - -.. raw:: html - -
\ No newline at end of file diff --git a/source/administration-guide/comply/compliance-export.rst b/source/administration-guide/comply/compliance-export.rst index b461b29a828..00bd6330334 100644 --- a/source/administration-guide/comply/compliance-export.rst +++ b/source/administration-guide/comply/compliance-export.rst @@ -1,7 +1,7 @@ Compliance export ================= -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: Mattermost Enterprise customers can archive history or transfer message data to third-party systems for auditing and compliance purposes with compliance exports. Supported integrations include `Actiance Vantage <#actiance-xml>`__, `Global Relay <#global-relay-eml>`__, and `Proofpoint <#proofpoint>`__. diff --git a/source/administration-guide/comply/compliance-monitoring.rst b/source/administration-guide/comply/compliance-monitoring.rst index 0710abe728d..0bb7deef7e0 100644 --- a/source/administration-guide/comply/compliance-monitoring.rst +++ b/source/administration-guide/comply/compliance-monitoring.rst @@ -3,7 +3,7 @@ Compliance monitoring .. This page is intentionally NOT accessible from the LHS. -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This feature enables compliance exports to be produced from the System Console, with all query and download actions logged in an audit history to enable oversight and prevent unauthorized queries. diff --git a/source/administration-guide/comply/custom-terms-of-service.rst b/source/administration-guide/comply/custom-terms-of-service.rst index 7488982ccde..9f8940fd758 100644 --- a/source/administration-guide/comply/custom-terms-of-service.rst +++ b/source/administration-guide/comply/custom-terms-of-service.rst @@ -3,7 +3,7 @@ Custom terms of service ======================= -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: Increase clarity on legal Mattermost expectations for internal employees and guests with the ability to set custom Terms of Service (“ToS”) agreements and re-acceptable periods. diff --git a/source/administration-guide/comply/data-retention-policy.rst b/source/administration-guide/comply/data-retention-policy.rst index 768a2552f84..12477619d4e 100644 --- a/source/administration-guide/comply/data-retention-policy.rst +++ b/source/administration-guide/comply/data-retention-policy.rst @@ -1,7 +1,7 @@ Data retention policy ===================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: Mattermost stores all message history providing an unlimited search history to system admins and end users. diff --git a/source/administration-guide/comply/electronic-discovery.rst b/source/administration-guide/comply/electronic-discovery.rst index 3b47254c38c..bea43c2bcef 100644 --- a/source/administration-guide/comply/electronic-discovery.rst +++ b/source/administration-guide/comply/electronic-discovery.rst @@ -3,7 +3,7 @@ Electronic discovery ===================== -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: Electronic discovery (also known as eDiscovery) refers to a process where electronic data is searched with the intent to use it as evidence in a legal case. diff --git a/source/administration-guide/comply/embedded-json-audit-log-schema.rst b/source/administration-guide/comply/embedded-json-audit-log-schema.rst index 94c4dfa104d..b59880a7667 100644 --- a/source/administration-guide/comply/embedded-json-audit-log-schema.rst +++ b/source/administration-guide/comply/embedded-json-audit-log-schema.rst @@ -1,7 +1,7 @@ Audit Log JSON Schema ============================== -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: The audit log JSON schema functions as a standardized blueprint or schematic that consistently defines how a single event should appear when being written to the audit log, including: field names, data types, objects, and structure. diff --git a/source/administration-guide/comply/export-mattermost-channel-data.rst b/source/administration-guide/comply/export-mattermost-channel-data.rst index e5126aa293e..6f255ea7be4 100644 --- a/source/administration-guide/comply/export-mattermost-channel-data.rst +++ b/source/administration-guide/comply/export-mattermost-channel-data.rst @@ -1,7 +1,7 @@ Export channel data =================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: Ensure important data isn't trapped in silos by migrating data between systems or backing data up for operational continuity. Once exported, channel data can be analyzed using various tools for insights into team dynamics, productivity, and communication patterns, and to fulfill reporting and auditability requirements. diff --git a/source/administration-guide/comply/legal-hold.rst b/source/administration-guide/comply/legal-hold.rst index 49dc531299d..c82a29c3c7a 100644 --- a/source/administration-guide/comply/legal-hold.rst +++ b/source/administration-guide/comply/legal-hold.rst @@ -1,7 +1,7 @@ Legal Hold =========== -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: A Legal Hold, also known as a litigation hold, is a process that an organization uses to preserve all forms of relevant information when litigation is reasonably anticipated. It's a requirement established by the Federal Rules of Civil Procedure (FRCP) in the United States and similar laws in other jurisdictions. diff --git a/source/administration-guide/configure/agents-admin-guide.rst b/source/administration-guide/configure/agents-admin-guide.rst index fbb724ac240..96e83aa185e 100644 --- a/source/administration-guide/configure/agents-admin-guide.rst +++ b/source/administration-guide/configure/agents-admin-guide.rst @@ -1,7 +1,7 @@ Mattermost Agents Admin Guide ============================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: .. note:: diff --git a/source/administration-guide/configure/authentication-configuration-settings.rst b/source/administration-guide/configure/authentication-configuration-settings.rst index 8dc5f6acc2f..cadc1f5b22c 100644 --- a/source/administration-guide/configure/authentication-configuration-settings.rst +++ b/source/administration-guide/configure/authentication-configuration-settings.rst @@ -1,7 +1,7 @@ Authentication configuration settings ===================================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Mattermost supports up to 4 distinct, concurrent methods of user authentication: @@ -35,9 +35,6 @@ Review and manage the following authentication configuration options in the Syst Signup ------ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Authentication > Signup**. .. config:setting:: enable-account-creation @@ -141,9 +138,6 @@ Invalidate pending email invites Email ----- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Authentication > Email**. .. config:setting:: enable-account-creation-with-email @@ -240,9 +234,6 @@ Enable sign-in with username Password -------- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Authentication > Password**. .. note:: @@ -353,9 +344,6 @@ Enable forgot password link MFA --- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Authentication > MFA**. We recommend deploying Mattermost within your own private network, and using VPN clients for mobile access, so that Mattermost is secured with your existing protocols. If you choose to run Mattermost outside your private network, bypassing your existing security protocols, we recommend adding a multi-factor authentication service specifically for accessing Mattermost. @@ -391,9 +379,6 @@ Enable multi-factor authentication Enforce multi-factor authentication ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ | - **true**: Requires `multi-factor authentication (MFA) | - System Config path: **Authentication > MFA** | | `__ | - ``config.json`` setting: ``ServiceSettings`` > ``EnforceMultifactorAuthentication`` > ``false`` | @@ -412,9 +397,6 @@ Enforce multi-factor authentication AD/LDAP -------- -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Authentication > AD/LDAP**. This opens the AD/LDAP setup wizard with step-by-step sections and testing to help configure each setting. The wizard is organized into the following sections: @@ -464,6 +446,9 @@ Enable sign-in with AD/LDAP Enable synchronization with AD/LDAP ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. include:: ../../_static/badges/entry-ent.rst + :start-after: :nosearch: + +---------------------------------------------------------------+--------------------------------------------------------------------------+ | - **true**: Mattermost periodically syncs users from AD/LDAP. | - System Config path: **Authentication > AD/LDAP** | | - **false**: **(Default)** Disables AD/LDAP synchronization. | - ``config.json`` setting: ``LdapSettings`` > ``EnableSync`` > ``false`` | @@ -735,7 +720,7 @@ User filter Group filter ^^^^^^^^^^^^ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ @@ -807,6 +792,9 @@ Guest filter Account synchronization ~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: ../../_static/badges/entry-ent.rst + :start-after: :nosearch: + Map AD/LDAP user attributes to Mattermost user profile fields. Use the **Test Attributes** button in this section to verify correct attribute mapping and data synchronization before proceeding to other configuration steps. .. config:setting:: id-attribute @@ -993,6 +981,9 @@ Profile picture attribute Group synchronization ~~~~~~~~~~~~~~~~~~~~~~ +.. include:: ../../_static/badges/entry-ent.rst + :start-after: :nosearch: + Configure group mapping for AD/LDAP group synchronization. Use the **Test Group Attributes** button in this section to verify proper group attribute mapping before proceeding to other configuration steps. .. config:setting:: group-display-name-attribute @@ -1005,9 +996,6 @@ Configure group mapping for AD/LDAP group synchronization. Use the **Test Group Group display name attribute ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. include:: ../../_static/badges/ent-only.rst - :start-after: :nosearch: - +--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | This is the AD/LDAP Group Display name attribute that populates the Mattermost group name field. | - System Config path: **Authentication > AD/LDAP** | | | - ``config.json`` setting: ``LdapSettings`` > ``GroupDisplayNameAttribute`` | @@ -1027,9 +1015,6 @@ Group display name attribute Group ID attribute ^^^^^^^^^^^^^^^^^^^ -.. include:: ../../_static/badges/ent-only.rst - :start-after: :nosearch: - +--------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | This is an AD/LDAP Group ID attribute that sets a unique identifier for groups. | - System Config path: **Authentication > AD/LDAP** | | | - ``config.json`` setting: ``LdapSettings`` > ``GroupIdAttribute`` | @@ -1044,6 +1029,9 @@ Group ID attribute Synchronization performance ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: ../../_static/badges/entry-ent.rst + :start-after: :nosearch: + Configure timing and performance settings for AD/LDAP synchronization. These settings control how often Mattermost syncs with your AD/LDAP server. .. config:setting:: synchronization-interval-minutes @@ -1110,6 +1098,9 @@ Query timeout (seconds) Synchronization history ~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: ../../_static/badges/entry-ent.rst + :start-after: :nosearch: + View synchronization status and manually trigger AD/LDAP synchronization. This section includes the **AD/LDAP Synchronize Now** button for immediate synchronization. AD/LDAP synchronize now @@ -1132,6 +1123,9 @@ AD/LDAP synchronize now Config settings not available in the AD/LDAP Wizard ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. include:: ../../_static/badges/entry-ent.rst + :start-after: :nosearch: + The following AD/LDAP configuration settings are available in the ``config.json`` file only and aren't available via the AD/LDAP wizard interface in the System Console. .. config:setting:: re-add-removed-members-on-sync @@ -1168,9 +1162,6 @@ Re-add removed members on sync SAML 2.0 -------- -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Authentication > SAML 2.0**. See the encryption options documentation for details on what :ref:`encryption methods ` Mattermost supports for SAML. @@ -1191,9 +1182,6 @@ See the encryption options documentation for details on what :ref:`encryption me Enable login with SAML ~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ | - **true**: Enables sign-in with SAML. See :doc:`SAML Single Sign-On ` to learn more. | - System Config path: **Authentication > SAML 2.0** | | - **false**: **(Default)** Disables sign-in with SAML. | - ``config.json`` setting: ``SamlSettings`` > ``Enable`` > ``false`` | @@ -1212,9 +1200,6 @@ Enable login with SAML Enable synchronizing SAML accounts with AD/LDAP ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +--------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ | - **true**: Mattermost updates configured Mattermost user attributes (ex. FirstName, Position, Email) | - System Config path: **Authentication > SAML 2.0** | | with their values from AD/LDAP. | - ``config.json`` setting: ``SamlSettings`` > ``EnableSyncWithLdap`` > ``false`` | @@ -1237,7 +1222,7 @@ See :doc:`AD/LDAP Setup ` to learn more. Ignore guest users when synchronizing with AD/LDAP ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: +-----------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ @@ -1263,9 +1248,6 @@ For more information, see :doc:`AD/LDAP Setup SAML 2.0** | | If the SAML ID attribute is not present, Mattermost overrides the SAML Email attribute with the AD/LDAP Email attribute. | - ``config.json`` setting: ``SamlSettings`` > ``EnableSyncWithLdapIncludeAuth`` > ``false`` | @@ -1289,9 +1271,6 @@ Override SAML bind data with AD/LDAP information Identity provider metadata URL ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ | This setting is the URL from which Mattermost requests setup metadata from the provider. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``IdpMetadataURL`` | @@ -1308,9 +1287,6 @@ Identity provider metadata URL SAML SSO URL ~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +--------------------------------------------------------------------------------------------+----------------------------------------------------------+ | This setting is the URL where Mattermost sends a SAML request to start the login sequence. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``IdpURL`` | @@ -1327,9 +1303,6 @@ SAML SSO URL Identity provider issuer URL ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +-----------------------------------------------------------------------------+------------------------------------------------------------------------+ | This setting is the issuer URL for the Identity Provider for SAML requests. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``IdpDescriptorURL`` | @@ -1346,9 +1319,6 @@ Identity provider issuer URL Identity provider public certificate ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +-------------------------------------------------------------------------+--------------------------------------------------------------------------+ | The public authentication certificate issued by your Identity Provider. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``IdpCertificateFile`` | @@ -1367,9 +1337,6 @@ Identity provider public certificate Verify signature ~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------+ | - **true**: **(Default)** Mattermost checks that the SAML Response signature matches the Service Provider Login URL. | - System Config path: **Authentication > SAML 2.0** | | - **false**: The signature is not verified. This is **not recommended** for production. Use this option for testing only. | - ``config.json`` setting: ``SamlSettings`` > ``Verify`` > ``true`` | @@ -1388,9 +1355,6 @@ Verify signature Service provider login URL ~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ | Enter the URL of your Mattermost server, followed by ``/login/sso/saml``, i.e. ``https://example.com/login/sso/saml``. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``AssertionConsumerServiceURL`` | @@ -1409,9 +1373,6 @@ Service provider login URL Service provider identifier ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | This setting is the unique identifier for the Service Provider, which in most cases is the same as the Service Provider Login URL. In ADFS, this must match the Relying Party Identifier. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``ServiceProviderIdentifier`` | @@ -1430,9 +1391,6 @@ Service provider identifier Enable encryption ~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ | - **true**: **(Default)** Mattermost will decrypt SAML Assertions that are encrypted with your Service Provider Public Certificate. | - System Config path: **Authentication > SAML 2.0** | | - **false**: Mattermost does not decrypt SAML Assertions. Use this option for testing only. It is **not recommended** for production. | - ``config.json`` setting: ``SamlSettings`` > ``Encrypt`` > ``true`` | @@ -1449,9 +1407,6 @@ Enable encryption Service provider private key ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ | This setting stores the private key used to decrypt SAML Assertions from the Identity Provider. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``PrivateKeyFile`` | @@ -1468,9 +1423,6 @@ Service provider private key Service provider public certificate ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ | This setting stores the certificate file used to sign a SAML request to the Identity Provider for a SAML login when Mattermost is initiating the login as the Service Provider. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``PublicCertificateFile`` | @@ -1489,9 +1441,6 @@ Service provider public certificate Sign request ~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +--------------------------------------------------------------------------------------+-----------------------------------------------------------------+ | - **true**: Mattermost signs the SAML request with the Service Provider Private Key. | - System Config path: **Authentication > SAML 2.0** | | - **false**: Mattermost does not sign the SAML request. | - ``config.json`` setting: ``SamlSettings`` > ``SignRequest`` | @@ -1508,9 +1457,6 @@ Sign request Signature algorithm ~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ | This setting determines the signature algorithm used to sign the SAML request. Options are: ``RSAwithSHA1``, ``RSAwithSHA256``, ``RSAwithSHA512``. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``SignatureAlgorithm`` | @@ -1535,9 +1481,6 @@ Signature algorithm Canonical algorithm ~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------+ | This setting determines the canonicalization algorithm. With these options: | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``CanonicalAlgorithm`` | @@ -1557,9 +1500,6 @@ Canonical algorithm Email attribute ~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ | This setting determines the attribute from the SAML Assertion that populates the user email address field in Mattermost. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``EmailAttribute`` | @@ -1578,9 +1518,6 @@ Email attribute Username attribute ~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ | This setting determines the SAML Assertion attribute that populates the username field in the Mattermost UI. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``UsernameAttribute`` | @@ -1599,9 +1536,6 @@ Username attribute Id attribute ~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ | (Optional) This setting determines the SAML Assertion attribute used to bind users from SAML to users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``IdAttribute``| @@ -1618,9 +1552,6 @@ Id attribute Guest attribute ~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +--------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------+ | (Optional) This setting determines the SAML Assertion attribute used to apply a Guest role to users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``GuestAttribute``| @@ -1641,9 +1572,6 @@ Guest attribute Enable admin attribute ~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ | - **true**: System admin status is determined by the SAML Assertion attribute set in **Admin attribute**. | - System Config path: **Authentication > SAML 2.0** | | - **false**: **(Default)** System admin status is **not** determined by the SAML Assertion attribute. | - ``config.json`` setting: ``SamlSettings`` > ``EnableAdminAttribute`` > ``false`` | @@ -1660,9 +1588,6 @@ Enable admin attribute Admin attribute ~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +-------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------+ | (Optional) This setting determines the attribute in the SAML Assertion for designating system admins. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``AdminAttribute`` | @@ -1683,9 +1608,6 @@ Admin attribute First name attribute ~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +-----------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ | (Optional) This setting determines the SAML Assertion attribute that populates the first name of users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``FirstNameAttribute`` | @@ -1703,9 +1625,6 @@ First name attribute Last name attribute ~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ | (Optional) This setting determines the SAML Assertion attribute that populates the last name of users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``LastNameAttribute`` | @@ -1723,9 +1642,6 @@ Last name attribute Nickname attribute ~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ | (Optional) This setting determines the SAML Assertion attribute that populates the nickname of users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``NicknameAttribute`` | @@ -1743,9 +1659,6 @@ Nickname attribute Position attribute ~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +----------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ | (Optional) This setting determines the SAML Assertion attribute that populates the position (job title or role at company) of users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``PositionAttribute`` | @@ -1763,9 +1676,6 @@ Position attribute Preferred language attribute ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +--------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+ | (Optional) This setting determines the SAML Assertion attribute that populates the language preference of users in Mattermost. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``LocaleAttribute``| @@ -1783,9 +1693,6 @@ Preferred language attribute Login button text ~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------------------+-------------------------------------------------------------------+ | (Optional) The text that appears in the login button on the sign-in page. | - System Config path: **Authentication > SAML 2.0** | | | - ``config.json`` setting: ``SamlSettings`` > ``LoginButtonText`` | @@ -1797,9 +1704,6 @@ Login button text OAuth 2.0 --------- -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Authentication > OAuth 2.0**. Settings for GitLab OAuth authentication can also be accessed under **Authentication > GitLab** in self-hosted deployments. Use these settings to configure OAuth 2.0 for account creation and login. @@ -1826,9 +1730,6 @@ Select OAuth 2.0 service provider GitLab OAuth 2.0 settings ^^^^^^^^^^^^^^^^^^^^^^^^^ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - .. note:: For Enterprise subscriptions, GitLab settings can be found under **OAuth 2.0** @@ -1965,9 +1866,6 @@ GitLab OAuth 2.0 Token endpoint Google OAuth 2.0 settings ^^^^^^^^^^^^^^^^^^^^^^^^^ -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - .. config:setting:: oauth-googleenable :displayname: Enable OAuth 2.0 authentication with Google (OAuth - Google) :systemconsole: Authentication > OAuth 2.0 @@ -2072,9 +1970,6 @@ Google OAuth 2.0 Token endpoint Entra ID OAuth 2.0 settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - .. note:: In line with Microsoft ADFS guidance we recommend `configuring intranet forms-based authentication for devices that do not support WIA `_. @@ -2209,9 +2104,6 @@ Entra ID OAuth 2.0 Token endpoint OpenID Connect --------------- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Authentication > OpenID Connect**. .. config:setting:: select-openid-connect-service-provider @@ -2240,9 +2132,6 @@ Select OpenID Connect service provider GitLab OpenID settings ^^^^^^^^^^^^^^^^^^^^^^ -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - .. config:setting:: guest-access :displayname: Enable (OpenID Connect - GitLab) :systemconsole: Authentication > OpenID Connect @@ -2347,9 +2236,6 @@ GitLab OpenID Client secret Google OpenID settings ^^^^^^^^^^^^^^^^^^^^^^ -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - .. config:setting:: oidc-googleenable :displayname: Enable Google Settings (OpenID Connect - Google) @@ -2427,9 +2313,6 @@ Google OpenID Client secret Entra ID OpenID settings ^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - .. note:: In line with Microsoft ADFS guidance, we recommend `configuring intranet forms-based authentication for devices that do not support WIA `_. @@ -2527,9 +2410,6 @@ Entra ID Client secret OpenID Connect (other) settings ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - .. config:setting:: oidc-enable :displayname: Enable (OpenID Connect) :systemconsole: Authentication > OpenID Connect @@ -2542,9 +2422,6 @@ OpenID Connect (other) settings Enable OpenID Connect authentication with other service providers ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - +---------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ | - **true**: Allows team and account creation using other OpenID Connect service providers. | - System Config path: **Authentication > OpenID Connect** | | - **false**: **(Default)** Disables OpenID Connect authentication with other service providers. | - ``config.json`` setting: ``OpenIdSettings`` > ``Enable`` > ``false`` | @@ -2651,9 +2528,6 @@ OpenID Connect (other) Client secret Guest access ------------ -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Authentication > Guest Access**. .. config:setting:: enable-guest-access diff --git a/source/administration-guide/configure/bleve-search.rst b/source/administration-guide/configure/bleve-search.rst index 995486ef741..b7436e31b24 100644 --- a/source/administration-guide/configure/bleve-search.rst +++ b/source/administration-guide/configure/bleve-search.rst @@ -1,7 +1,7 @@ Bleve search ============= -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: .. important:: diff --git a/source/administration-guide/configure/calls-deployment.md b/source/administration-guide/configure/calls-deployment.md index 6058ae1fcd0..8430caa1529 100644 --- a/source/administration-guide/configure/calls-deployment.md +++ b/source/administration-guide/configure/calls-deployment.md @@ -1,6 +1,6 @@ # Calls self-hosted deployment -```{include} ../../_static/badges/allplans-selfhosted.md +```{include} ../../_static/badges/all-commercial.md ``` Mattermost Calls is an excellent option for organizations demanding enhanced security and control over their communication infrastructure. Calls is designed to operate securely in self-hosted deployments, including [air-gapped environments](https://docs.mattermost.com/configure/calls-deployment.html#air-gapped-deployments), ensuring private communication without reliance on public internet connectivity with flexible configuration options for complex network requirements. @@ -610,6 +610,9 @@ See the [Mattermost rtcd repository documentation](https://github.com/mattermost ### Horizontal scalability +```{include} ./calls-rtcd-ent-only.md +``` + The supported way to enable horizontal scalability for Calls is through a form of DNS based load balancing. This can be achieved regardless of how the `rtcd` service is deployed (bare bone instance, Kubernetes, or an alternate way). In order for this to work, the [RTCD Service URL](https://docs.mattermost.com/configure/plugins-configuration-settings.html#rtcd-service-url) should point to a hostname that resolves to multiple IP addresses, each pointing to a running `rtcd` instance. The Mattermost Calls plugin will then automatically distribute calls amongst the available hosts. @@ -626,6 +629,9 @@ The expected requirements are the following: ## Configure recording, transcriptions, and live captions +```{include} ./calls-rtcd-ent-only.md +``` + Before you can start recording, transcribing, and live captioning calls, you need to configure the `calls-offloader` job service. See the [calls-offloader](https://github.com/mattermost/calls-offloader/blob/master/docs/getting_started.md) documentation on GitHub for details on deploying and running this service. [Performance and scalability recommendations](https://github.com/mattermost/calls-offloader/blob/master/docs/performance.md) related to this service are also available on GitHub. ```{note} @@ -645,6 +651,9 @@ Live captions can be enabled through the [Enable live captions](https://docs.mat ## Kubernetes deployments +```{include} ./calls-rtcd-ent-only.md +``` + The Calls plugin has been designed to integrate well with Kubernetes to offer improved scalability and control over the deployment. This is a sample diagram showing how the `rtcd` standalone service can be deployed in a Kubernetes cluster: @@ -730,9 +739,6 @@ When possible, it's recommended to keep communication between the Mattermost clu ### Can Calls be rolled out on a per-channel basis? -```{include} ../../_static/badges/selfhosted-only.md -``` - Yes. Mattermost system admins running self-hosted deployments can enable or disable call functionality per channel. Once [test mode](https://docs.mattermost.com/configure/plugins-configuration-settings.html#test-mode) is enabled for Mattermost Calls: - Select **Enable calls** for each channel where you want Calls enabled diff --git a/source/administration-guide/configure/calls-rtcd-ent-only.md b/source/administration-guide/configure/calls-rtcd-ent-only.md index 32606f3566d..cdaf6776c76 100644 --- a/source/administration-guide/configure/calls-rtcd-ent-only.md +++ b/source/administration-guide/configure/calls-rtcd-ent-only.md @@ -4,6 +4,6 @@ **Note** -![plans-img](../../_static/images/badges/flag_icon.svg) The rtcd service is available only on [Enterprise](https://mattermost.com/pricing/) plans +![plans-img](../../_static/images/badges/flag_icon.svg) The rtcd service is available only on [Enterprise and Enterprise Advanced](https://mattermost.com/pricing/) plans diff --git a/source/administration-guide/configure/cloud-billing-account-settings.rst b/source/administration-guide/configure/cloud-billing-account-settings.rst index 899cdf8e764..5cfc2fcb2ee 100644 --- a/source/administration-guide/configure/cloud-billing-account-settings.rst +++ b/source/administration-guide/configure/cloud-billing-account-settings.rst @@ -1,9 +1,6 @@ Cloud workspace subscription, billing, and account settings =========================================================== -.. include:: ../../_static/badges/allplans-cloud.rst - :start-after: :nosearch: - Review and manage the following aspects of your Mattermost cloud-based deployment by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **Billing and Account**: - Access billing history diff --git a/source/administration-guide/configure/compliance-configuration-settings.rst b/source/administration-guide/configure/compliance-configuration-settings.rst index 743a85083a8..416614ace25 100644 --- a/source/administration-guide/configure/compliance-configuration-settings.rst +++ b/source/administration-guide/configure/compliance-configuration-settings.rst @@ -1,7 +1,7 @@ Compliance configuration settings ================================= -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: Review and manage the following compliance configuration options in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **Compliance**: @@ -23,9 +23,6 @@ Review and manage the following compliance configuration options in the System C Data retention policies ----------------------- -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst - :start-after: :nosearch: - Changes to properties in this section require a server restart before taking effect. .. warning:: @@ -148,9 +145,6 @@ Start a Data Retention deletion job immediately. You can monitor the status of t Compliance export ----------------- -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Compliance > Compliance Export**. .. config:setting:: enable-administration-guide/comply/compliance-export @@ -313,9 +307,6 @@ The SMTP server port that will receive your Global Relay EML file when a `custom Message export batch size ~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst - :start-after: :nosearch: - This setting isn't available in the System Console and can only be set in ``config.json``. Determines how many new posts are batched together to a compliance export file. @@ -334,9 +325,6 @@ This button initiates a compliance export job immediately. You can monitor the s Compliance monitoring ---------------------- -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst - :start-after: :nosearch: - Settings used to enable and configure Mattermost compliance reports. Access the following configuration settings in the System Console by going to **Compliance > Compliance Monitoring**. @@ -418,9 +406,6 @@ Set the size of the batches in which posts will be read from the database to gen Custom terms of service ----------------------- -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Compliance > Custom Terms of Service**. .. config:setting:: enable-custom-terms-of-service diff --git a/source/administration-guide/configure/configuration-in-your-database.rst b/source/administration-guide/configure/configuration-in-your-database.rst index be305540d1b..cf18bc62f24 100644 --- a/source/administration-guide/configure/configuration-in-your-database.rst +++ b/source/administration-guide/configure/configuration-in-your-database.rst @@ -1,10 +1,10 @@ Store configuration in your database ==================================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: -You can use your database as the single source of truth for the active configuration of your Mattermost installation. This changes the Mattermost binary from reading the default ``config.json`` file to reading the configuration settings stored within a configuration table in the database. Mattermost has been running our `community server `__ on this option since the feature was released, and recommends its use for those on :doc:`High Availability deployments `. +If you have a self-hosted Mattermost deployment, you can use your database as the single source of truth for the active configuration of your Mattermost installation. This changes the Mattermost binary from reading the default ``config.json`` file to reading the configuration settings stored within a configuration table in the database. Mattermost has been running our `community server `__ on this option since the feature was released, and recommends its use for those on :doc:`High Availability deployments `. Benefits to using this option: diff --git a/source/administration-guide/configure/configuration-settings.rst b/source/administration-guide/configure/configuration-settings.rst index f2068509d43..1320de47348 100644 --- a/source/administration-guide/configure/configuration-settings.rst +++ b/source/administration-guide/configure/configuration-settings.rst @@ -1,7 +1,7 @@ Configuration settings ====================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: System admins for both self-hosted and Cloud Mattermost deployments can manage Mattermost configuration using the System Console by selecting the **Product** |product-list| menu and selecting **System Console**. @@ -51,26 +51,17 @@ Mattermost configuration settings are organized into the following categories wi Configuration in database -------------------------- -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - Self-hosted system configuration can be stored in the database. This changes the Mattermost binary from reading the default ``config.json`` file to reading the configuration settings stored within a configuration table in the database. See the :doc:`Mattermost database configuration ` documentation for migration details. Environment variables --------------------- -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - -You can use :doc:`environment variables ` to manage Mattermost configuration. Environment variables override settings in ``config.json``. If a change to a setting in ``config.json`` requires a restart to take effect, then changes to the corresponding environment variable also require a server restart. +You can use :doc:`environment variables ` to manage Mattermost configuration for self-hosted deployments. Environment variables override settings in ``config.json``. If a change to a setting in ``config.json`` requires a restart to take effect, then changes to the corresponding environment variable also require a server restart. Configuration reload -------------------- -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - -The “config watcher”, the mechanism that automatically reloads the ``config.json`` file, has been deprecated in favor of the :ref:`mmctl config reload ` command that you must run to apply configuration changes you've made. This improves configuration performance and robustness. +In self-hosted deployments, the “config watcher”, the mechanism that automatically reloads the ``config.json`` file, has been deprecated in favor of the :ref:`mmctl config reload ` command that you must run to apply configuration changes you've made. This improves configuration performance and robustness. Deprecated configuration settings --------------------------------- diff --git a/source/administration-guide/configure/custom-branding-tools.rst b/source/administration-guide/configure/custom-branding-tools.rst index 483ce211d54..166bd99136f 100644 --- a/source/administration-guide/configure/custom-branding-tools.rst +++ b/source/administration-guide/configure/custom-branding-tools.rst @@ -1,7 +1,7 @@ Custom branding tools ===================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Use custom branding tools to present a Mattermost experience that's tailored to the branding of your organization. diff --git a/source/administration-guide/configure/customize-mattermost.rst b/source/administration-guide/configure/customize-mattermost.rst index ea90eb2c4d5..ae939b11ea3 100644 --- a/source/administration-guide/configure/customize-mattermost.rst +++ b/source/administration-guide/configure/customize-mattermost.rst @@ -1,7 +1,7 @@ Customizing Mattermost ====================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: There are several ways to customize your Mattermost server. diff --git a/source/administration-guide/configure/deprecated-configuration-settings.rst b/source/administration-guide/configure/deprecated-configuration-settings.rst index 2837f9e8564..7cd9625c182 100644 --- a/source/administration-guide/configure/deprecated-configuration-settings.rst +++ b/source/administration-guide/configure/deprecated-configuration-settings.rst @@ -939,9 +939,6 @@ Enable the ability to establish secure connections between Mattermost instances, User satisfaction surveys plugin settings ----------------------------------------- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - .. important:: This plugin is deprecated from Mattermost v10.11, and is no longer included as a pre-packaged plugin for new Mattermost deployments. For new installations, we strongly recommend using the :doc:`Mattermost User Survey integration ` instead. diff --git a/source/administration-guide/configure/email-templates.rst b/source/administration-guide/configure/email-templates.rst index 4663d8ff42c..be1b9480ee3 100644 --- a/source/administration-guide/configure/email-templates.rst +++ b/source/administration-guide/configure/email-templates.rst @@ -1,7 +1,7 @@ Email templates =============== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Mattermost has a few email templates that are sent out when a specific event occurs. diff --git a/source/administration-guide/configure/enabling-chinese-japanese-korean-search.rst b/source/administration-guide/configure/enabling-chinese-japanese-korean-search.rst index 3ec97fe622e..1366b2e75e1 100644 --- a/source/administration-guide/configure/enabling-chinese-japanese-korean-search.rst +++ b/source/administration-guide/configure/enabling-chinese-japanese-korean-search.rst @@ -3,7 +3,7 @@ Chinese, Japanese and Korean search ====================================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Enabling search for Chinese, Japanese and Korean (CJK) requires special configuration, since these languages do not contain spaces. diff --git a/source/administration-guide/configure/environment-configuration-settings.rst b/source/administration-guide/configure/environment-configuration-settings.rst index 27352fccee5..6b78dabe7b3 100644 --- a/source/administration-guide/configure/environment-configuration-settings.rst +++ b/source/administration-guide/configure/environment-configuration-settings.rst @@ -1,7 +1,7 @@ Environment configuration settings ================================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Review and manage the following environmental configuration options in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **Environment**: @@ -32,10 +32,7 @@ Review and manage the following environmental configuration options in the Syste Web server ---------- -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - -Configure the network environment in which Mattermost is deployed by going to **System Console > Environment > Web Server**, or by updating the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. +With self-hosted deployments, you can configure the network environment in which Mattermost is deployed by going to **System Console > Environment > Web Server**, or by updating the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. .. config:setting:: site-url :displayname: Site URL (Web Server) @@ -376,7 +373,7 @@ Managed resource paths Reload configuration from disk ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +----------------------------------------------------------+---------------------------------------------------------------+ @@ -437,9 +434,6 @@ Websocket URL License file location ~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +--------------------------------------------------------+------------------------------------------------------------------------------------+ | The path and filename of the license file on disk. | - System Config path: N/A | | On startup, if Mattermost can't find a valid license | - ``config.json`` setting: ``ServiceSettings`` > ``LicenseFileLocation`` > ``""`` | @@ -617,7 +611,7 @@ Allow cookies for subdomains Cluster log timeout ~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +--------------------------------------------------------+------------------------------------------------------------------------------------------------+ @@ -656,13 +650,7 @@ Maximum payload size Database -------- -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - -Configure the database environment in which Mattermost is deployed by going to **System Console > Environment > Database**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. - -.. include:: ../../_static/badges/academy-mattermost-database.rst - :start-after: :nosearch: +With self-hosted deployments, you can configure the database environment in which Mattermost is deployed by going to **System Console > Environment > Database**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. .. config:setting:: driver-name :displayname: Driver name (Database) @@ -936,7 +924,7 @@ SQL statement logging Recycle database connections ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +--------------------------------------------------------+------------------------------------------------------------------+ @@ -965,16 +953,16 @@ Recycle database connections Disable database search ~~~~~~~~~~~~~~~~~~~~~~~ -+------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| When `enterprise-scale search `, | - System Config path: **Environment > Database** | -| database search can be disabled from performing searches. | - ``config.json`` setting: ``SqlSettings`` > ``DisableDatabaseSearch`` > ``false`` | -| | - Environment variable: ``MM_SQLSETTINGS_DISABLEDATABASESEARCH`` | -| - **true**: Disables the use of the database to perform | | -| searches. If another search engine isn't configured, | | -| setting this value to ``true`` will result in empty search | | -| results. | | -| - **false**: **(Default)** Database search isn't disabled. | | -+------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| When :doc:`enterprise-scale search `, | - System Config path: **Environment > Database** | +| database search can be disabled from performing searches. | - ``config.json`` setting: ``SqlSettings`` > ``DisableDatabaseSearch`` > ``false`` | +| | - Environment variable: ``MM_SQLSETTINGS_DISABLEDATABASESEARCH`` | +| - **true**: Disables the use of the database to perform | | +| searches. If another search engine isn't configured, | | +| setting this value to ``true`` will result in empty search | | +| results. | | +| - **false**: **(Default)** Database search isn't disabled. | | ++-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ Search behavior in Mattermost depends on which search engines are enabled: @@ -1022,9 +1010,6 @@ Read-only display of the currently active backend used for search. Values can in Read replicas ~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +--------------------------------------------------------+-------------------------------------------------------------------------------+ | Specifies the connection strings for the read replica | - System Config path: N/A | | databases. | - ``config.json`` setting: ``SqlSettings`` > ``DataSourceReplicas`` > ``[]`` | @@ -1053,9 +1038,6 @@ For an AWS High Availability RDS cluster deployment, point this configuration se Search replicas ~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +--------------------------------------------------------+-------------------------------------------------------------------------------------+ | Specifies the connection strings for the search | - System Config path: N/A | | replica databases. A search replica is similar to a | - ``config.json`` setting: ``SqlSettings`` > ``DataSourceSearchReplicas`` > ``[]`` | @@ -1082,7 +1064,7 @@ For an AWS High Availability RDS cluster deployment, point this configuration se Replica lag settings ~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +--------------------------------------------------------+----------------------------------------------------------------------------------+ @@ -1222,9 +1204,6 @@ Replica lag settings Replica monitor interval (seconds) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - +--------------------------------------------------------+-----------------------------------------------------------------------------------------+ | Specifies how frequently unhealthy replicas will be | - System Config path: N/A | | monitored for liveness check. Mattermost will | - ``config.json`` setting: ``SqlSettings`` > ``ReplicaMonitorIntervalSeconds`` > ``5`` | @@ -1233,17 +1212,21 @@ Replica monitor interval (seconds) | Numerical input. Default is 5 seconds. | | +--------------------------------------------------------+-----------------------------------------------------------------------------------------+ +.. note:: + + This configuration setting is applicable to self-hosted deployments only. + ---- Enterprise search ----------------- -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: Core database search happens in a relational database and is intended for deployments under about 2–3 million posts and file entries. Beyond that scale, enabling enterprise search with Elasticsearch or AWS OpenSearch is highly recommended for optimum search performance before reaching 3 million posts. -For deployments with over 3 million posts, Elasticsearch or AWS OpenSearch is required to avoid significant performance issues, such as timeouts, with :doc:`message searches ` and :doc:`@mentions `. +For self-hosted deployments with over 3 million posts, Elasticsearch or AWS OpenSearch is required to avoid significant performance issues, such as timeouts, with :doc:`message searches ` and :doc:`@mentions `. You can configure Mattermost enterprise search by going to **System Console > Environment > Elasticsearch**. The following configuration settings apply to both Elasticsearch and AWS OpenSearch. You can also edit the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. @@ -1920,13 +1903,7 @@ Trace File storage ------------ -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - -Configure file storage settings by going to **System Console > Environment > File Storage**, or by editing the ``config.json`` file as described in the following tables. - -.. include:: ../../_static/badges/academy-file-storage.rst - :start-after: :nosearch: +With self-hosted deployments, you can configure file storage settings by going to **System Console > Environment > File Storage**, or by editing the ``config.json`` file as described in the following tables. .. note:: @@ -2241,7 +2218,7 @@ See the `AWS File Storage @@ -2422,10 +2403,7 @@ Initial font Image proxy ----------- -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - -An image proxy is used by Mattermost apps to prevent them from connecting directly to remote self-hosted servers. Configure an image proxy by going to **System Console > Environment > Image Proxy**, or by editing the ``config.json`` file as described in the following tables. +With self-hosted deployments, an image proxy can be used by Mattermost apps to prevent them from connecting directly to remote self-hosted servers. Configure an image proxy by going to **System Console > Environment > Image Proxy**, or by editing the ``config.json`` file as described in the following tables. .. config:setting:: enable-image-proxy :displayname: Enable image proxy (Image Proxy) @@ -2512,10 +2490,7 @@ See the :doc:`image proxy ` documentation SMTP ---- -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - -Configure SMTP email server settings by going to **System Console > Environment > SMTP**, or by editing the ``config.json`` file as described in the following tables. +With self-hosted deployments, you can configure SMTP email server settings by going to **System Console > Environment > SMTP**, or by editing the ``config.json`` file as described in the following tables. .. config:setting:: smtp-server :displayname: SMTP server (SMTP) @@ -2693,9 +2668,6 @@ SMTP server timeout Push notification server ------------------------ -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - .. include:: push-notification-server-configuration-settings.rst :start-after: :nosearch: @@ -2704,10 +2676,10 @@ Push notification server High availability ----------------- -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: -You can configure Mattermost as a :doc:`high availability cluster-based deployment ` by going to **System Console > Environment > High Availability**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. +With self-hosted deployments, you can configure Mattermost as a :doc:`high availability cluster-based deployment ` by going to **System Console > Environment > High Availability**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. In a Mattermost high availability cluster-based deployment, the System Console is set to read-only, and settings can only be changed by editing the ``config.json`` file directly. However, to test a high availability cluster-based environment, you can disable ``ClusterSettings.ReadOnlyConfig`` in the ``config.json`` file by setting it to ``false``. This allows changes applied using the System Console to be saved back to the configuration file. @@ -2946,9 +2918,6 @@ Advertise address Rate limiting ------------- -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - .. include:: rate-limiting-configuration-settings.rst :start-after: :nosearch: @@ -2957,10 +2926,7 @@ Rate limiting Logging -------- -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - -Mattermost provides 3 independent logging systems that can be configured separately with separate log files and rotation policies to meet different operational and compliance needs: +Mattermost provides 3 independent logging systems for self-hosted deployments that can be configured separately with separate log files and rotation policies to meet different operational and compliance needs: - `Log Settings <#log-settings>`__ - `Notification Log Settings <#notification-logging>`__ @@ -3565,6 +3531,9 @@ Output logs to multiple targets Audit logging ~~~~~~~~~~~~~ +.. include:: ../../_static/badges/ent-plus.rst + :start-after: :nosearch: + Configure audit logging by going to **System Console > Compliance > Audit Logging**, or by editing the ``config.json`` file as described in the following tables. These settings operate independently from the main ``LogSettings`` and allow you to customize logging behavior specifically for the audit subsystem. Changes to these configuration settings require a server restart before taking effect. .. config:setting:: auditlog-fileenabled @@ -3751,10 +3720,7 @@ Output audit logs to multiple targets Session lengths --------------- -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - -User sessions are cleared when a user tries to log in, and sessions are cleared every 24 hours from the sessions database table. Configure session lengths by going to **System Console > Environment > Session Lengths**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. +With self-hosted deployments, user sessions are cleared when a user tries to log in, and sessions are cleared every 24 hours from the sessions database table. Configure session lengths by going to **System Console > Environment > Session Lengths**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. .. config:setting:: extend-session-length-with-activity :displayname: Extend session length with activity (Session Lengths) @@ -3934,10 +3900,10 @@ Session idle timeout Performance monitoring ---------------------- -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: -Configure performance monitoring by going to **System Console > Environment > Performance Monitoring**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. +With self-hosted deployments, you can configure performance monitoring by going to **System Console > Environment > Performance Monitoring**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. See the :doc:`performance monitoring ` documentation to learn more about setting up performance monitoring. @@ -4030,10 +3996,7 @@ Listen address Developer --------- -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - -Configure developer mode by going to **System Console > Environment > Developer**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. +With self-hosted deployments, you can configure developer mode by going to **System Console > Environment > Developer**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. .. config:setting:: enable-testing-commands :displayname: Enable testing commands (Developer) @@ -4156,7 +4119,7 @@ Some examples of when you may want to modify this setting include: Mobile security --------------- -.. include:: ../../_static/badges/ent-adv-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: From Mattermost v10.7 and mobile app v2.27, you can configure biometric authentication, prevent Mattermost use on jailbroken or rooted devices, and can block screen captures without relying on an EMM Provider. Configure these options by going to **System Console > Environment > Mobile Security**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart and require users to restart their mobile app or log out and back in before taking effect. @@ -4313,8 +4276,7 @@ Allow PDF link navigation on mobile config.json-only settings ------------------------- -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: +The following self-hosted deployment settings are only configurable in the ``config.json`` file and are not available in the System Console. .. config:setting:: disable-customer-portal-requests :displayname: Disable customer portal requests @@ -4459,10 +4421,10 @@ This setting isn't available in the System Console and can only be enabled in `` Redis cache backend ~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-adv-selfhosted.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: -From Mattermost v10.4, Mattermost Enterprise customers can configure `Redis `_ (Remote Dictionary Server) as an alternative cache backend. Redis is an open-source, in-memory data structure store that can be used as a database, cache, and message broker. It supports various data structures and is a top choice for its performance because its able to store data in memory and provide very quick data access. +From Mattermost v10.4, Mattermost Enterprise customers with self-hosted deployments can configure `Redis `_ (Remote Dictionary Server) as an alternative cache backend. Redis is an open-source, in-memory data structure store that can be used as a database, cache, and message broker. It supports various data structures and is a top choice for its performance because its able to store data in memory and provide very quick data access. Using Redis as a caching solution can help ensure that Mattermost for enterprise-level deployments with high concurrency and large user bases remains performant and efficient, even under heavy usage. diff --git a/source/administration-guide/configure/environment-variables.rst b/source/administration-guide/configure/environment-variables.rst index ff4ca9364b0..0893f3891a3 100644 --- a/source/administration-guide/configure/environment-variables.rst +++ b/source/administration-guide/configure/environment-variables.rst @@ -1,7 +1,7 @@ Environment variables ===================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: You can use environment variables to manage the configuration. Environment variables override settings in ``config.json``. If a change to a setting in ``config.json`` requires a restart for it to take effect, then changes to the corresponding environment variable also require a server restart. diff --git a/source/administration-guide/configure/experimental-configuration-settings.rst b/source/administration-guide/configure/experimental-configuration-settings.rst index cfebfb00656..497eca01976 100644 --- a/source/administration-guide/configure/experimental-configuration-settings.rst +++ b/source/administration-guide/configure/experimental-configuration-settings.rst @@ -1,7 +1,7 @@ Experimental configuration settings ===================================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Review and manage the following :ref:`experimental ` configuration options in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **Experimental > Features**: @@ -49,9 +49,6 @@ Specify the color of the AD/LDAP login button for white labeling purposes. Use a AD/LDAP login button border color ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - Specify the color of the AD/LDAP login button border for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile app. +-------------------------------------------------------------------------------------------------------------------------------+ @@ -68,9 +65,6 @@ Specify the color of the AD/LDAP login button border for white labeling purposes AD/LDAP login button text color ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - Specify the color of the AD/LDAP login button text for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile app. +-------------------------------------------------------------------------------------------------------------------------------+ @@ -89,9 +83,6 @@ Specify the color of the AD/LDAP login button text for white labeling purposes. Change authentication method ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - **True**: Users can change their sign-in method to any that is enabled on the server, either via their Profile or the APIs. **False**: Users cannot change their sign-in method, regardless of which authentication options are enabled. @@ -336,9 +327,6 @@ Changes made when hardened mode is enabled: Enable theme selection ~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - **True**: Enables the **Display > Theme** tab in **Settings** so users can select their theme. **False**: Users cannot select a different theme. The **Display > Theme** tab is hidden in **Settings**. @@ -359,9 +347,6 @@ Enable theme selection Allow custom themes ~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - **True**: Enables the **Display > Theme > Custom Theme** section in **Settings**. **False**: Users cannot use a custom theme. The **Display > Theme > Custom Theme** section is hidden in **Settings**. @@ -380,9 +365,6 @@ Allow custom themes Default theme ~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - Set a default theme that applies to all new users on the system. +--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -517,9 +499,6 @@ If the team URL of the primary team is ``https://example.mattermost.com/myteam/` SAML login button color ~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - Specify the color of the SAML login button for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile app. +-------------------------------------------------------------------------------------------------------------------------------+ @@ -536,9 +515,6 @@ Specify the color of the SAML login button for white labeling purposes. Use a he SAML login button border color ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - Specify the color of the SAML login button border for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile app. +-------------------------------------------------------------------------------------------------------------------------------+ @@ -555,9 +531,6 @@ Specify the color of the SAML login button border for white labeling purposes. U SAML login button text color ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - Specify the color of the SAML login button text for white labeling purposes. Use a hex code with a #-sign before the code. This setting only applies to the mobile app. +-------------------------------------------------------------------------------------------------------------------------------+ @@ -673,8 +646,8 @@ Enable the following settings to output audit events in the System Console by go Advanced logging ~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-cloud-only.rst - :start-after: :nosearch: +.. include:: ../../_static/badges/entry-ent.rst + :start-after: :nosearch: Output log and audit records to any combination of console, local file, syslog, and TCP socket targets for a Mattermost Cloud deployment. See the :ref:`advanced logging ` documentation for details about logging options. @@ -688,7 +661,7 @@ Output log and audit records to any combination of console, local file, syslog, Enable audit logging ~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: When audit logging is enabled in a self-hosted instance, you can specify size, backup interval, compression, maximium age to manage file rotation, and timestamps for audit logging, as defined below. You can specify these settings independently for audit events and AD/LDAP events. @@ -711,7 +684,7 @@ When audit logging is enabled in a self-hosted instance, you can specify size, b File name ~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: Specify the path to the audit file for a self-hosted deployment. @@ -730,7 +703,7 @@ Specify the path to the audit file for a self-hosted deployment. Max file size ~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This is the maximum size, in megabytes, that the file can grow before triggering rotation for a self-hosted deployment. The default setting is ``100``. @@ -749,7 +722,7 @@ This is the maximum size, in megabytes, that the file can grow before triggering Max file age ~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This is the maximum age, in days, a file can reach before triggering rotation for a self-hosted deployment. The default value is ``0``, indicating no limit on the age. @@ -768,7 +741,7 @@ This is the maximum age, in days, a file can reach before triggering rotation fo Maximum file backups ~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This is the maximum number of rotated files kept for a self-hosted deployment. The oldest is deleted first. The default value is ``0``, indicating no limit on the number of backups. @@ -787,7 +760,7 @@ This is the maximum number of rotated files kept for a self-hosted deployment. T File compression ~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: When ``true``, rotated files are compressed using ``gzip`` in a self-hosted deployment. @@ -806,7 +779,7 @@ When ``true``, rotated files are compressed using ``gzip`` in a self-hosted depl Maximum file queue ~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This setting determines how many audit records can be queued/buffered at any point in time when writing to a file for a self-hosted deployment. The default is ``1000`` records. @@ -837,20 +810,9 @@ Upload the certificate PEM file in the System Console by going to **System Conso :environment: N/A :description: Output log and audit records to any combination of console, local file, syslog, and TCP socket targets for a Mattermost self-hosted deployment. -Advanced logging -~~~~~~~~~~~~~~~~ - -.. include:: ../../_static/badges/ent-selfhosted.rst - :start-after: :nosearch: - -Output log and audit records to any combination of console, local file, syslog, and TCP socket targets for a Mattermost self-hosted deployment. See the :ref:`advanced logging ` documentation for details about logging options. - Experimental configuration settings for self-hosted deployments only -------------------------------------------------------------------- -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - Access the following self-hosted configuration settings by editing the ``config.json`` file as described in the following tables. These configuration settings are not accessible through the System Console. .. tip:: @@ -870,9 +832,6 @@ Access the following self-hosted configuration settings by editing the ``config. Allowed themes ~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - This setting isn't available in the System Console and can only be set in ``config.json``. Select the themes that can be chosen by users when ``EnableThemeSelection`` is set to ``true``. @@ -893,7 +852,7 @@ Select the themes that can be chosen by users when ``EnableThemeSelection`` is s File Location ~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This setting isn't available in the System Console and can only be set in ``config.json``. @@ -959,7 +918,7 @@ This setting isn't available in the System Console and can only be set in ``conf Enable client-side certification ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: .. important:: @@ -986,7 +945,7 @@ Enable client-side certification Client-side certification login method ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: .. important:: @@ -1169,7 +1128,7 @@ Standard setting for OAuth to determine the scope of information shared with OAu Global relay SMTP server timeout ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This setting isn't available in the System Console and can only be set in ``config.json``. @@ -1190,9 +1149,6 @@ The number of seconds that can elapse before the connection attempt to the SMTP Google scope ~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - This setting isn't available in the System Console and can only be set in ``config.json``. Standard setting for OAuth to determine the scope of information shared with OAuth client. Recommended setting is ``profile email``. @@ -1247,7 +1203,7 @@ The number of days to retain the imported files before deleting them. Export from timestamp ~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This setting isn't available in the System Console and can only be set in ``config.json``. @@ -1293,9 +1249,6 @@ To include every blocking event in the profile, set the rate to ``1``. To turn o Entra ID Scope ~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - This setting isn't available in the System Console and can only be set in ``config.json``. Standard setting for OAuth to determine the scope of information shared with OAuth client. Recommended setting is ``User.Read``. @@ -1416,9 +1369,6 @@ The location of client plugin files. If blank, they are stored in the ``./client Scoping IDP provider ID ~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - This setting isn't available in the System Console and can only be set in ``config.json``. Allows an authenticated user to skip the initial login page of their federated Azure AD server, and only require a password to log in. @@ -1437,9 +1387,6 @@ Allows an authenticated user to skip the initial login page of their federated A Scoping IDP provider name ~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - This setting isn't available in the System Console and can only be set in ``config.json``. Adds the name associated with a user's Scoping Identity Provider ID. @@ -1484,10 +1431,9 @@ This setting applies to the new sidebar only. You must disable the :ref:`Enable Enable channel category sorting ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/allplans-cloud.rst - :start-after: :nosearch: +From Mattermost v10.10, when this :ref:`experimental ` feature is enabled, users can assign channels to new or existing channel categories when creating or renaming channels. -From Mattermost v10.10, when this :ref:`experimental ` feature is enabled, users can assign channels to new or existing channel categories when creating or renaming channels. This configuration setting applies only to cloud-based deployments. +**This configuration setting applies only to cloud-based deployments.** **True**: Users can assign channels to new or existing channel categories when creating or renaming channels. @@ -1679,7 +1625,7 @@ This setting isn't available in the System Console and can only be set in ``conf Enable local mode for mmctl ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. +This self-hosted deployment setting isn't available in the System Console and can only be set in ``config.json``. **True**: Enables local mode for mmctl. @@ -1703,7 +1649,7 @@ This setting isn't available in the System Console and can only be set in ``conf Enable local mode socket location ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This setting isn't available in the System Console and can only be set in ``config.json``. +This self-hosted deployment setting isn't available in the System Console and can only be set in ``config.json``. The path for the socket that the server will create for mmctl to connect and communicate through local mode. If the default value for this key is changed, you will need to point mmctl to the new socket path when in local mode, using the ``--local-socket-path /new/path/to/socket`` flag in addition to the ``--local`` flag. @@ -1742,10 +1688,7 @@ When not set, every user is added to the ``town-square`` channel by default. Experimental job configuration settings --------------------------------------- -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - -Settings to configure how Mattermost schedules and completes periodic tasks such as the deletion of old posts with Data Retention enabled or indexing posts with Elasticsearch. These settings control which Mattermost servers are designated as a Scheduler, a server that queues the tasks at the correct times, and as a Worker, a server that completes the given tasks. +With self-hosted deployments, you can configure how Mattermost schedules and completes periodic tasks such as the deletion of old posts with Data Retention enabled or indexing posts with Elasticsearch. These settings control which Mattermost servers are designated as a Scheduler, a server that queues the tasks at the correct times, and as a Worker, a server that completes the given tasks. When running Mattermost on a single machine, both ``RunJobs`` and ``RunScheduler`` should be enabled. Without both of these enabled, Mattermost will not function properly. diff --git a/source/administration-guide/configure/install-boards.rst b/source/administration-guide/configure/install-boards.rst index f521a645efc..4638a914da1 100644 --- a/source/administration-guide/configure/install-boards.rst +++ b/source/administration-guide/configure/install-boards.rst @@ -1,7 +1,7 @@ Install Mattermost Boards ========================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Mattermost Boards is not enabled by default for new Mattermost Enterprise instances. If the Mattermost Boards plugin isn't enabled for your Mattermost workspace, self-hosted Enterprise customers can install this plugin by manually uploading the binary release file into the System Console and enabling it. diff --git a/source/administration-guide/configure/integrations-configuration-settings.rst b/source/administration-guide/configure/integrations-configuration-settings.rst index 77680c0b740..e4eec48cfd1 100644 --- a/source/administration-guide/configure/integrations-configuration-settings.rst +++ b/source/administration-guide/configure/integrations-configuration-settings.rst @@ -1,7 +1,7 @@ Integrations configuration settings =================================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Review and manage the following integration configuration options in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **Integrations**: @@ -23,9 +23,6 @@ Review and manage the following integration configuration options in the System Integrations management ----------------------- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Integrations > Integration Management**. .. config:setting:: enable-incoming-webhooks @@ -218,9 +215,6 @@ To manage who can create personal access tokens or to search users by token ID, Bot accounts ------------ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Integrations > Bot Accounts**. .. config:setting:: enable-bot-account-creation @@ -268,9 +262,6 @@ Disable bot accounts when owner is deactivated GIF ---- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Integrations > GIF**. .. config:setting:: enable-gif-picker @@ -301,10 +292,7 @@ Enable GIF picker CORS ---- -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - -Access the following configuration settings in the System Console by going to **Integrations > CORS**. +The following configuration settings are applicable only to self-hosted deployments. Access the following configuration settings in the System Console by going to **Integrations > CORS**. .. config:setting:: enable-cross-origin-requests-from :displayname: Enable cross-origin requests from (Integrations) @@ -392,10 +380,7 @@ CORS debug Embedding --------- -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - -Access the following configuration settings in the System Console by going to **Integrations > Embedding**. +The following configuration settings are applicable only to self-hosted deployments. Access the following configuration settings in the System Console by going to **Integrations > Embedding**. .. config:setting:: frame-ancestors :displayname: Frame ancestors (Integrations) diff --git a/source/administration-guide/configure/manage-user-surveys.rst b/source/administration-guide/configure/manage-user-surveys.rst index 70a744e714c..b562c7cd32f 100644 --- a/source/administration-guide/configure/manage-user-surveys.rst +++ b/source/administration-guide/configure/manage-user-surveys.rst @@ -1,7 +1,7 @@ Manage user surveys =================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: In a self-hosted Mattermost deployment, you can use the Mattermost User Survey integration to gather direct feedback from your Mattermost users to identify what's working well and what's not with your Mattermost instance. diff --git a/source/administration-guide/configure/optimize-your-workspace.rst b/source/administration-guide/configure/optimize-your-workspace.rst index 4929fe13748..2aa6a8c707e 100644 --- a/source/administration-guide/configure/optimize-your-workspace.rst +++ b/source/administration-guide/configure/optimize-your-workspace.rst @@ -1,7 +1,7 @@ Optimize your Mattermost workspace ================================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: With workspace optimizations, system admins can review their workspace health and growth scores, then take advantage of recommended actions for ensuring their workspace is running smoothly and teams are maximizing productivity. diff --git a/source/administration-guide/configure/plugins-configuration-settings.rst b/source/administration-guide/configure/plugins-configuration-settings.rst index 2e8691f2724..395dd68c9c2 100644 --- a/source/administration-guide/configure/plugins-configuration-settings.rst +++ b/source/administration-guide/configure/plugins-configuration-settings.rst @@ -1,7 +1,7 @@ Plugins configuration settings ============================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Review and manage the following plugin configuration options in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **Plugins**: @@ -78,9 +78,6 @@ Enable plugins Require plugin signature ~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ | - **true**: **(Default)** Enables plugin signature validation for managed and unmanaged plugins. | - System Config path: **Plugins > Plugin Management** | | - **false**: Disables plugin signature validation for managed and unmanaged plugins. | - ``config.json`` setting: ``PluginSettings`` > ``RequirePluginSignature`` > ``true`` | @@ -88,7 +85,8 @@ Require plugin signature +---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ .. note:: - From Mattermost server v10.11, pre-packaged plugins require signature validation on startup. Distributions that bundle custom pre-packaged plugins must configure custom public keys via ``PluginSettings.SignaturePublicKeyFiles`` to validate their signatures. + - This setting is applicable to self-hosted deployments only. + - From Mattermost server v10.11, pre-packaged plugins require signature validation on startup. Distributions that bundle custom pre-packaged plugins must configure custom public keys via ``PluginSettings.SignaturePublicKeyFiles`` to validate their signatures. - **Mattermost server v10.10 and earlier**: Pre-packaged plugins are not subject to signature validation. - Plugins installed through the Marketplace are always subject to signature validation at the time of download. - Enabling this configuration will result in `plugin file uploads <#upload-plugin>`__ being disabled in the System Console. @@ -126,9 +124,6 @@ Automatic prepackaged plugins Upload Plugin ~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ | - **true**: Enables you to upload plugins from the local computer to the Mattermost server. | - System Config path: **Plugins > Plugin Management** | | - **false**: **(Default)** Disables uploading of plugins from the local computer to the Mattermost server. | - ``config.json`` setting: ``PluginSettings`` > ``EnableUploads`` > ``false`` | @@ -136,6 +131,7 @@ Upload Plugin +------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ .. note:: + - This setting is applicable to self-hosted deployments only. - When plugin uploads are enabled, the error ``Received invlaid response from the server`` when uploading a plugin file typically indicates that the :ref:`MaxFileSize ` configuration setting isn't large enough to support the plugin file upload. Additional proxy setting updateds may also be required. @@ -239,9 +235,6 @@ Plugin settings Calls ----- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Plugins > Calls**. .. config:setting:: enable-plugin @@ -272,9 +265,6 @@ Enable plugin RTC server address (UDP) ~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +--------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ | This setting controls the IP address the RTC server listens for UDP connections. All calls UDP traffic will be served through this IP. | - System Config path: **Plugins > Calls** | | | - ``config.json`` setting: ``PluginSettings`` ``Plugins`` > ``com.mattermost.calls`` > ``udpserveraddress`` | @@ -283,7 +273,7 @@ RTC server address (UDP) +--------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ .. note:: - This setting is only applicable when not running calls through the standalone ``rtcd`` service. + This setting is applicable to self-hosted deployments only, and only when not running calls through the standalone ``rtcd`` service. .. config:setting:: rtc-server-address-tcp :displayname: RTC server port (TCP) (Plugins - Calls) @@ -295,9 +285,6 @@ RTC server address (UDP) RTC server address (TCP) ~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +--------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | This setting controls the IP address the RTC server listens for TCP connections. All calls TCP traffic will be served through this IP. | - System Config path: **Plugins > Calls** | | | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``tcpserveraddress`` | @@ -306,7 +293,7 @@ RTC server address (TCP) +--------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ .. note:: - This setting is available starting in plugin version 0.17, and is only applicable when not running calls through the standalone ``rtcd`` service. + This setting is available starting in plugin version 0.17, and is only applicable for self-hosted deployments when not running calls through the standalone ``rtcd`` service. .. config:setting:: rtc-server-port-udp :displayname: RTC server port (UDP) (Plugins - Calls) @@ -318,9 +305,6 @@ RTC server address (TCP) RTC server port (UDP) ~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | This setting controls the UDP port listened on by the RTC server. All calls UDP traffic will be served through this port. | - System Config path: **Plugins > Calls** | | | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``udpserverport`` | @@ -331,7 +315,7 @@ RTC server port (UDP) +-------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ .. note:: - This setting is only applicable when not running calls through the standalone ``rtcd`` service. + This setting is only applicable for self-hosted deployments when not running calls through the standalone ``rtcd`` service. .. config:setting:: rtc-server-port-tcp :displayname: RTC server port (TCP) (Plugins - Calls) @@ -343,9 +327,6 @@ RTC server port (UDP) RTC server port (TCP) ~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +-------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ | This setting controls the TCP port listened on by the RTC server. All calls TCP traffic will be served through this port. | - System Config path: **Plugins > Calls** | | | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``tcpserverport`` | @@ -356,7 +337,7 @@ RTC server port (TCP) +-------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ .. note:: - This setting is available starting in plugin version 0.17, and is only applicable when not running calls through the standalone ``rtcd`` service. + This setting is available starting in plugin version 0.17, and is only applicable for self-hosted deplyoments when not running calls through the standalone ``rtcd`` service. .. config:setting:: enable-pluginsonspecificchannels :displayname: Enable on specific channels (Plugins - Calls) @@ -368,10 +349,7 @@ RTC server port (TCP) Enable on specific channels ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -*Admins can't configure this setting from Mattermost v7.7; it's hidden and always enabled* - -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: +*Admins can't configure this setting from Mattermost v7.7; it's hidden and always enabled for self-hosted deployments* +----------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | - **true**: Channel admins can enable or disable calls on specific channels. Participants in DMs/GMs can also enable or disable calls. | - System Config path: **Plugins > Calls** | @@ -389,10 +367,7 @@ Enable on specific channels Test mode ~~~~~~~~~ -*This setting was called Enable on all channels until Mattermost v7.7. It was renamed to defaultenabled in code and Test Mode in-product.* - -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: +*This setting was called Enable on all channels until Mattermost v7.7. It was renamed to defaultenabled in code and Test Mode in-product and is only applicable to self-hosted deployments.* +-----------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | - **false**: Test mode is enabled and only system admins can start calls in channels. | - System Config path: **Plugins > Calls** | @@ -413,9 +388,6 @@ Test mode ICE host override ~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | This setting can be used to override the host addresses that get advertised to clients when connecting to calls. The accepted formats are the following: | - System Config path: **Plugins > Calls** | | | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``icehostoverride`` | @@ -429,7 +401,7 @@ ICE host override +------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ .. note:: - - This setting is only applicable when not running calls through the standalone ``rtcd`` service. + - This setting is only applicable for self-hosted deployments when not running calls through the standalone ``rtcd`` service. - Depending on the network infrastructure (e.g. instance behind a NAT device) it may be necessary to set this field to the client facing external IP for clients to connect. When empty or unset, the RTC service will attempt to find the instance's public IP through STUN. - A hostname (e.g. domain name) can be specified in this setting, but an IP address will be passed to clients. This means that a DNS resolution happens on the Mattermost instance which could result in a different IP address from the one the clients would see, causing connectivity to fail. When in doubt, we recommend using an IP address directly or confirming that the resolution on the host side reflects the one on the client. @@ -445,9 +417,6 @@ ICE host override ICE host port override ~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ | This setting can be used to override the port used in the ICE host candidates that get advertised to clients when connecting to calls. | - System Config path: **Plugins > Calls** | | | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``icehostportoverride`` | @@ -458,7 +427,8 @@ ICE host port override +---------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ .. note:: - This value will apply to both UDP and TCP host candidates. + - This setting is applicable only to self-hosted deployments. + - This value will apply to both UDP and TCP host candidates. .. config:setting:: rtcd-service-url :displayname: RTCD service URL (Plugins - Calls) @@ -470,7 +440,7 @@ ICE host port override RTCD service URL ~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -484,11 +454,10 @@ RTCD service URL +---------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ .. note:: + - This setting is applicable only to self-hosted deployments. - The environment variable ``MM_CALLS_RTCD_URL`` is deprecated in favor of ``MM_CALLS_RTCD_SERVICE_URL``. - 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`` - -.. 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`` @@ -502,9 +471,6 @@ RTCD service URL Max call participants ~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | This setting limits the number of participants that can join a single call. | - System Config path: **Plugins > Calls** | | | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``maxcallparticipants``| @@ -514,6 +480,7 @@ Max call participants +-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. note:: + - This setting is applicable only to self-hosted deployments. - The environment variable ``MM_CALLS_MAX_PARTICIPANTS`` is deprecated in favor of ``MM_CALLS_MAX_CALL_PARTICIPANTS``. - This setting is optional, but the recommended maximum number of participants is **50**. Call participant limits greatly depends on instance resources. See the :doc:`Calls self-hosted deployment ` documentation for details. @@ -528,9 +495,6 @@ Max call participants ICE servers configurations ~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | This setting stores a list of ICE servers (STUN/TURN) in JSON format to be used by the service. | - System Config path: **Plugins > Calls** | | | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``iceserversconfigs`` | @@ -542,6 +506,7 @@ ICE servers configurations +---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ .. note:: + - This setting is applicable only to self-hosted deployments. - The configurations above, containing STUN and TURN servers, are sent to the clients and used to generate local candidates. - If hosting calls through the plugin (i.e. not using the |rtcd_service|) any configured STUN server may also be used to find the instance's public IP when none is provided through the |ice_host_override_link| option. @@ -587,9 +552,6 @@ ICE servers configurations TURN static auth secret ~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | A static secret used to generate short-lived credentials for TURN servers. | - System Config path: **Plugins > Calls** | | | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``turnstaticauthsecret`` | @@ -597,6 +559,10 @@ TURN static auth secret | This is an optional field. | | +----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ +.. note:: + + This setting is applicable only to self-hosted deployments. + .. config:setting:: turn-credentials-expiration :displayname: TURN credentials expiration (Plugins - Calls) :systemconsole: Plugins > Calls @@ -607,9 +573,6 @@ TURN static auth secret TURN credentials expiration ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | The expiration, in minutes, of the short-lived credentials generated for TURN servers. | - System Config path: **Plugins > Calls** | | | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``turncredentialsexpirationminutes`` | @@ -618,6 +581,10 @@ TURN credentials expiration | Default is **1440** (one day). | | +----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +.. note:: + + This setting is applicable only to self-hosted deployments. + .. config:setting:: server-side-turn :displayname: Server side TURN (Plugins - Calls) :systemconsole: Plugins > Calls @@ -630,9 +597,6 @@ TURN credentials expiration Server side TURN ~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | - **true**: The RTC server will use the configured TURN candidates for server-initiated connections. | - System Config path: **Plugins > Calls** | | - **false**: TURN will be used only on the client-side. | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``serversideturn`` | @@ -641,6 +605,10 @@ Server side TURN | Changing this setting requires a plugin restart to take effect. | | +------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +.. note:: + + This setting is applicable only to self-hosted deployments. + .. config:setting:: allow-screen-sharing :displayname: Allow screen sharing (Plugins - Calls) :systemconsole: Plugins > Calls @@ -653,9 +621,6 @@ Server side TURN Allow screen sharing ~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | - **true**: Call participants will be allowed to share their screen. | - System Config path: **Plugins > Calls** | | - **false**: Call participants won't be allowed to share their screen. | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``allowscreensharing`` | @@ -663,6 +628,10 @@ Allow screen sharing | Changing this setting requires a plugin restart to take effect. | | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +.. note:: + + This setting is applicable only to self-hosted deployments. + .. config:setting:: enable-pluginsimulcast :displayname: (Experimental) Enable simulcast for screen sharing (Plugins - Calls) :systemconsole: Plugins > Calls @@ -675,9 +644,6 @@ Allow screen sharing Enable simulcast for screen sharing (Experimental) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | - **true**: Enables simulcast for screen sharing. This can help to improve screen sharing quality. | - System Config path: **Plugins > Calls** | | - **false**: Disables simulcast for screen sharing. | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``enablesimulcast`` | @@ -686,6 +652,7 @@ Enable simulcast for screen sharing (Experimental) .. note:: + - This experimental setting is applicable only to self-hosted deployments. - This functionality requires Calls plugin version >= v0.16.0 and ``rtcd`` version >= v0.10.0 (when in use). - Avoid enabling both this experimental configuration setting and the `Enable AV1 <#enable-av1-experimental>`__ experimental configuration setting at the same time. @@ -701,7 +668,7 @@ Enable simulcast for screen sharing (Experimental) Enable call recordings ~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +-------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ @@ -713,6 +680,10 @@ Enable call recordings | Changing this setting requires a plugin restart to take effect. | | +-------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +.. note:: + + This setting is applicable only to self-hosted deployments. + .. config:setting:: job-service-url :displayname: Job service URL (Plugins - Calls) :systemconsole: Plugins > Calls @@ -723,7 +694,7 @@ Enable call recordings Job service URL ~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ @@ -733,6 +704,8 @@ Job service URL +------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ .. note:: + + - This setting is applicable only to self-hosted deployments. - 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``. @@ -749,7 +722,7 @@ Job service URL Maximum call recording duration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +-----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ @@ -759,6 +732,10 @@ Maximum call recording duration | The default is **60**. The maximum is **180**. This is a required value. | | +-----------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +.. note:: + + This setting is applicable only to self-hosted deployments. + .. config:setting:: call-recording-quality :displayname: Call recording quality (Plugins - Calls) :systemconsole: Plugins > Calls @@ -769,7 +746,7 @@ Maximum call recording duration Call recording quality ~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -780,7 +757,8 @@ Call recording quality +-----------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. note:: - The quality setting will affect the performance of the job service and the file size of recordings. Refer to the :ref:`deployment section ` for more information. + - This setting is applicable only to self-hosted deployments. + - The quality setting will affect the performance of the job service and the file size of recordings. Refer to the :ref:`deployment section ` for more information. .. config:setting:: enable-pluginscalltranscriptions :displayname: Enable call transcriptions (Plugins - Calls) @@ -794,7 +772,7 @@ Call recording quality Enable call transcriptions ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ @@ -805,6 +783,7 @@ Enable call transcriptions +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ .. note:: + - This setting is applicable only to self-hosted deployments. - The ability to enable call transcriptions in Mattermost calls is currently in :ref:`Beta `. - This server-side configuration setting is available from plugin version 0.22. - Call transcriptions require :ref:`call recordings ` to be enabled. @@ -819,7 +798,7 @@ Enable call transcriptions Transcriber model size ~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ @@ -830,7 +809,8 @@ Transcriber model size +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ .. note:: - This setting is available starting in plugin version 0.22. The model size setting will affect the performance of the job service. Refer to the :ref:`configure call recordings, transcriptions, and live captions ` documentation for more information. + - This setting is applicable only to self-hosted deployments. + - This setting is available starting in plugin version 0.22. The model size setting will affect the performance of the job service. Refer to the :ref:`configure call recordings, transcriptions, and live captions ` documentation for more information. .. config:setting:: call-transcriber-threads :displayname: Call transcriber threads (Plugins - Calls) @@ -842,7 +822,7 @@ Transcriber model size Call transcriber threads ~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -853,7 +833,8 @@ Call transcriber threads +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. note:: - The call transcriber threads setting will affect the performance of the job service. Refer to the :ref:`configure call recordings, transcriptions, and live captions ` documentation for more information. This setting is available starting in plugin version 0.26.2. + - This setting is applicable only to self-hosted deployments. + - The call transcriber threads setting will affect the performance of the job service. Refer to the :ref:`configure call recordings, transcriptions, and live captions ` documentation for more information. This setting is available starting in plugin version 0.26.2. .. config:setting:: enable-pluginslivecaptions :displayname: (Experimental) Enable live captions (Plugins - Calls) @@ -868,7 +849,7 @@ Call transcriber threads Enable live captions ~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +---------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ @@ -895,7 +876,7 @@ Enable live captions Live captions: Model size ~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ @@ -906,7 +887,8 @@ Live captions: Model size +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ .. note:: - This setting is available starting in plugin version 0.26.2. The model size setting will affect the performance of the job service. Refer to the `performance and scalability recommendations `_ documentation for more information. + - This setting is applicable only to self-hosted deployments. + - This setting is available starting in plugin version 0.26.2. The model size setting will affect the performance of the job service. Refer to the `performance and scalability recommendations `_ documentation for more information. .. config:setting:: live-captions-number-of-transcribers-used-per-call :displayname: Live captions: Number of transcribers used per call (Plugins - Calls) @@ -918,7 +900,7 @@ Live captions: Model size Live captions: Number of transcribers used per call ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ @@ -929,7 +911,8 @@ Live captions: Number of transcribers used per call +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+ .. note:: - This setting is available starting in plugin version 0.26.2. The live captions number of transcribers setting will affect the performance of the job service. Refer to the `performance and scalability recommendations `_ documentation for more information. + - This setting is applicable only to self-hosted deployments. + - This setting is available starting in plugin version 0.26.2. The live captions number of transcribers setting will affect the performance of the job service. Refer to the `performance and scalability recommendations `_ documentation for more information. .. config:setting:: live-captions-number-of-threads-per-transcriber :displayname: Live captions: Number of threads per transcriber (Plugins - Calls) @@ -941,7 +924,7 @@ Live captions: Number of transcribers used per call Live captions: Number of threads per transcriber ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ @@ -952,7 +935,8 @@ Live captions: Number of threads per transcriber +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ .. note:: - This setting is available starting in plugin version 0.26.2. The live captions number of threads per transcriber setting will affect the performance of the job service. Refer to the `performance and scalability recommendations `_ documentation for more information + - This setting is applicable only to self-hosted deployments. + - This setting is available starting in plugin version 0.26.2. The live captions number of threads per transcriber setting will affect the performance of the job service. Refer to the `performance and scalability recommendations `_ documentation for more information .. config:setting:: live-captions-language :displayname: Live captions language (Plugins - Calls) @@ -964,7 +948,7 @@ Live captions: Number of threads per transcriber Live captions language ~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ @@ -974,6 +958,9 @@ Live captions language | If blank, the lange will be set to 'en' (English) as default. | | +---------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ +.. note:: + This setting is applicable only to self-hosted deployments. + .. config:setting:: enable-pluginipv6 :displayname: (Experimental) Enable IPv6 (Plugins - Calls) :systemconsole: Plugins > Calls @@ -986,9 +973,6 @@ Live captions language (Experimental) Enable IPv6 ~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +----------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ | - **true**: The RTC service will work in dual-stack mode, listening for IPv6 connections and generating candidates in addition to IPv4 ones. | - System Config path: **Plugins > Calls** | | - **false**: **(Default)** The RTC service will only listen for IPv4 connections. | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``enableipv6`` | @@ -997,7 +981,8 @@ Live captions language +----------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ .. note:: - This setting is available starting in plugin version 0.17, and is only applicable when not running calls through the standalone ``rtcd`` service. + - This setting is applicable only to self-hosted deployments. + - This setting is available starting in plugin version 0.17, and is only applicable when not running calls through the standalone ``rtcd`` service. .. config:setting:: enable-pluginscallringing :displayname: Enable call ringing (Plugins - Calls) @@ -1010,6 +995,7 @@ Live captions language Enable call ringing ~~~~~~~~~~~~~~~~~~~ + +--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | - **true**: Ringing functionality is enabled. Direct and group message | - System Config path: **Plugins > Calls** | | participants receive a desktop app alert and a ringing notification | - ``config.json`` setting: ``PluginSettings`` > ``Plugins`` > ``com.mattermost.calls`` > ``enableringing`` | @@ -1075,9 +1061,6 @@ Enable DC signaling (Experimental) AI Agents ---------- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - .. note:: Mattermost Agents is formerly known as Mattermost Copilot. @@ -1529,7 +1512,7 @@ Enable LLM trace Enable embedding search ~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ @@ -1731,9 +1714,6 @@ Reindex all posts GitLab ------ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - See the :doc:`Connect GitLab to Mattermost ` product documentation for available :ref:`Mattermost configuration options `. ---- @@ -1748,9 +1728,6 @@ See the :doc:`Connect GitLab to Mattermost ` product GitHub ------ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - See the :doc:`Connect GitHub to Mattermost ` product documentation for available :ref:`Mattermost configuration options `. ---- @@ -1765,9 +1742,6 @@ See the :doc:`Connect GitHub to Mattermost ` product Jira ---- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - See the :doc:`Connect Jira to Mattermost ` product documentation for available :ref:`Mattermost configuration options `. ---- @@ -1782,7 +1756,7 @@ See the :doc:`Connect Jira to Mattermost ` product doc Legal hold ---------- -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: See the :doc:`Legal holds ` product documentation for details. @@ -1799,9 +1773,6 @@ See the :doc:`Legal holds ` product doc Microsoft Calendar Integration ------------------------------- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - See the :doc:`Connect Microsoft Calendar Integration to Mattermost ` product documentation for available :ref:`Mattermost configuration options `. ---- @@ -1816,9 +1787,6 @@ See the :doc:`Connect Microsoft Calendar Integration to Mattermost ` product documentation for available :ref:`Mattermost configuration options `. @@ -1828,9 +1796,6 @@ See the :doc:`Connect Microsoft Teams Meetings to Mattermost MS Teams**. -.. include:: ../../_static/badges/academy-msteams.rst - :start-after: :nosearch: - .. config:setting:: enable-plugin :displayname: Enable plugin (Plugins - MS Teams) :systemconsole: Plugins > MS Teams @@ -2036,7 +1998,7 @@ Buffer size for streaming files Performance metrics ------------------- -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: See the :doc:`Monitor performance metrics ` product documentation for available :ref:`Mattermost configuration options `. @@ -2046,9 +2008,6 @@ See the :doc:`Monitor performance metrics Collaborative playbooks**. @@ -2117,9 +2076,6 @@ Enable experimental features ServiceNow ---------- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - See the :doc:`Connect ServiceNow to Mattermost ` product documentation for available :ref:`Mattermost configuration options `. @@ -2135,9 +2091,6 @@ See the :doc:`Connect ServiceNow to Mattermost ` Zoom ---- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - See the :doc:`Connect Zoom to Mattermost ` product documentation for available :ref:`Mattermost configuration options `. ---- @@ -2145,8 +2098,7 @@ See the :doc:`Connect Zoom to Mattermost ` product doc config.json-only settings -------------------------- -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: +The following self-hosted deployment settings are only configurable in the ``config.json`` file and are not available in the System Console. .. config:setting:: signature-public-key-files :displayname: Signature public key file (Plugins) diff --git a/source/administration-guide/configure/push-notification-server-configuration-settings.rst b/source/administration-guide/configure/push-notification-server-configuration-settings.rst index bfd75005706..1769807d1ec 100644 --- a/source/administration-guide/configure/push-notification-server-configuration-settings.rst +++ b/source/administration-guide/configure/push-notification-server-configuration-settings.rst @@ -1,7 +1,7 @@ :orphan: :nosearch: -Configure mobile push notifications for Mattermost by going to **System Console > Environment > Push Notification Server**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. +With self-hosted deployments, you can configure mobile push notifications for Mattermost by going to **System Console > Environment > Push Notification Server**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. .. config:setting:: enable-push-notifications :displayname: Enable push notifications (Push Notifications) @@ -37,9 +37,6 @@ Enable push notifications Hosted Push Notifications Service (HPNS) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - Mattermost Enterprise, Professional, and Cloud customers can use Mattermost's Hosted Push Notification Service (HPNS). The HPNS offers: - Access to a publicly-hosted Mattermost Push Notification Service (MPNS) `available on GitHub. `__ @@ -60,7 +57,7 @@ Mattermost Enterprise, Professional, and Cloud customers can use Mattermost's Ho Test Push Notifications Service (TPNS) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Non-commercial and self-hosted customers can use Mattermost's free, basic Test Push Notifications Service (TPNS). +Non-commercial self-hosted customers can use Mattermost's free, basic Test Push Notifications Service (TPNS). .. note:: - The TPNS isn’t recommended for use in production environments, and doesn’t offer production-level update service level agreements (SLAs). @@ -79,7 +76,7 @@ Non-commercial and self-hosted customers can use Mattermost's free, basic Test P ID-only push notifications ^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Admins can enable mobile notifications to be fully private to protect a Mattermost customer against breaches in iOS and Android notification infrastructure by limiting the data sent to Apple and Google through a Mattermost configuration setting. diff --git a/source/administration-guide/configure/rate-limiting-configuration-settings.rst b/source/administration-guide/configure/rate-limiting-configuration-settings.rst index 7206188787b..33536b8c2a6 100644 --- a/source/administration-guide/configure/rate-limiting-configuration-settings.rst +++ b/source/administration-guide/configure/rate-limiting-configuration-settings.rst @@ -1,7 +1,7 @@ :orphan: :nosearch: -Rate limiting prevents your Mattermost server from being overloaded with too many requests, and decreases the risk and impact of third-party applications or malicious attacks on your server. +With self-hosted deployments, rate limiting prevents your Mattermost server from being overloaded with too many requests, and decreases the risk and impact of third-party applications or malicious attacks on your server. Configure rate limiting settings by going to **System Console > Environment > Rate Limiting**, or by editing the ``config.json`` file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect. diff --git a/source/administration-guide/configure/reporting-configuration-settings.rst b/source/administration-guide/configure/reporting-configuration-settings.rst index 431bdceaef0..471e680257a 100644 --- a/source/administration-guide/configure/reporting-configuration-settings.rst +++ b/source/administration-guide/configure/reporting-configuration-settings.rst @@ -1,7 +1,7 @@ Reporting configuration settings ================================ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: View the following statistics for your overall deployment and specific teams, as well as access server logs, in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **Reporting**: @@ -48,9 +48,6 @@ Team statistics Server logs ----------- -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------+---------------------------------------------------------------+ | View logging of server-side events. | - System Config path: **Reporting > Server Logs** | | | - ``config.json`` setting: N/A | @@ -58,19 +55,17 @@ Server logs | and view full log event details for any log entry. | | +---------------------------------------------------------------+---------------------------------------------------------------+ -.. tip:: +.. note:: - From Mattermost v10.9, you can toggle between JSON and plain text server logs in the System Console when console log output is configured as :ref:`JSON ` by specifying the log format as **JSON** or **Plain text**. This option is located in the top right corner of the page **Server logs** page. + - This setting is applicable to self-hosted deployments only. + - From Mattermost v10.9, you can toggle between JSON and plain text server logs in the System Console when console log output is configured as :ref:`JSON ` by specifying the log format as **JSON** or **Plain text**. This option is located in the top right corner of the page **Server logs** page. ---- Statistics configuration settings --------------------------------- -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - -The following configuration setting controls statistics collection behavior. This setting is not available in the System Console and can only be set in the ``config.json`` file. +The following self-hosted deployment configuration setting controls statistics collection behavior. This setting is not available in the System Console and can only be set in the ``config.json`` file. .. config:setting:: maximum-users-for-statistics :displayname: Maximum users for statistics (Reporting) @@ -82,9 +77,6 @@ The following configuration setting controls statistics collection behavior. Thi Maximum users for statistics ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - This setting is used to maximize performance for large Enterprise deployments and isn't available in the System Console and can only be set in ``config.json``. +---------------------------------------------------------------+--------------------------------------------------------------------------------+ diff --git a/source/administration-guide/configure/self-hosted-account-settings.rst b/source/administration-guide/configure/self-hosted-account-settings.rst index f871bd1b3b6..73a873158ee 100644 --- a/source/administration-guide/configure/self-hosted-account-settings.rst +++ b/source/administration-guide/configure/self-hosted-account-settings.rst @@ -1,7 +1,7 @@ Self-hosted workspace edition and license settings ================================================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Start a trial or manage your self-hosted deployment by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **About > Edition and License**. diff --git a/source/administration-guide/configure/site-configuration-settings.rst b/source/administration-guide/configure/site-configuration-settings.rst index 78b8a9e60c8..97e8f56b480 100644 --- a/source/administration-guide/configure/site-configuration-settings.rst +++ b/source/administration-guide/configure/site-configuration-settings.rst @@ -1,7 +1,7 @@ Site configuration settings =========================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Review and manage the following site configuration options in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **Site Configuration**: @@ -30,9 +30,6 @@ Review and manage the following site configuration options in the System Console Customization ------------- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Site Configuration > Customization**. .. config:setting:: site-name @@ -173,9 +170,6 @@ Help link Terms of Use link ~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ | This field sets the URL for the Terms of Use of a self-hosted site. A link to the terms appears at the bottom of the sign-up and login pages. | - System Config path: **Site Configuration > Customization** | | | - ``config.json`` setting: ``SupportSettings`` > ``TermsOfServiceLink`` | @@ -185,7 +179,7 @@ Terms of Use link +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ .. note:: - This setting doesn't change the **Terms of Use** link in the **About Mattermost** window. + This setting is applicable to self-hosted deployments only and doesn't change the **Terms of Use** link in the **About Mattermost** window. .. config:setting:: privacy-policy-link :displayname: Privacy Policy link (Customization) @@ -197,9 +191,6 @@ Terms of Use link Privacy Policy link ~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ | This field sets the URL for the Privacy Policy of a self-hosted site. A link to the policy appears at the bottom of the sign-up and login pages. If this field is empty, the link does not appear. | - System Config path: **Site Configuration > Customization** | | | - ``config.json`` setting: ``SupportSettings`` > ``PrivacyPolicyLink`` | @@ -207,7 +198,7 @@ Privacy Policy link +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ .. note:: - This setting does not change the **Privacy Policy** link in the **About Mattermost** window. + This setting is applicable to self-hosted deployments only and doesn't change the **Privacy Policy** link in the **About Mattermost** window. .. config:setting:: about-link :displayname: About link (Customization) @@ -219,15 +210,15 @@ Privacy Policy link About link ~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ | This field sets the URL for a page containing general information about a self-hosted site. A link to the About page appears at the bottom of the sign-up and login pages. If this field is empty the link does not appear. | - System Config path: **Site Configuration > Customization** | | | - ``config.json`` setting: ``SupportSettings`` > ``AboutLink``| | String input. Default is ``https://about.mattermost.com/default-about/``. | - Environment variable: ``MM_SUPPORTSETTINGS_ABOUTLINK`` | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ +.. note:: + This setting is applicable to self-hosted deployments only. + .. config:setting:: forgot-password-custom-link :displayname: Forgot Password custom link (Customization) :systemconsole: Site Configuration > Customization @@ -258,10 +249,7 @@ Forgot Password custom link Report a Problem ~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - -Specify how the **Report a Problem** option behaves in the Mattermost app via the **Help** menu: +With self-hosted deployments, you can specify how the **Report a Problem** option behaves in the Mattermost app via the **Help** menu: - **Default link**: Uses the default Mattermost URL to report a problem. For commercial customers, this is the `Mattermost Support Portal `_. Non-commercial customers are directed to `create a new issue on the Mattermost GitHub repository `_. - **Email address**: Enables you to :ref:`enter an email address ` that users will be prompted to send a message to when they choose **Report a Problem** in Mattermost. @@ -278,9 +266,6 @@ Specify how the **Report a Problem** option behaves in the Mattermost app via th Report a Problem link ~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ | This field sets the URL for the **Report a Problem** link in the channel header **Help** menu. | - System Config path: **Site Configuration > Customization** | | If this field is empty the link does not appear. | - ``config.json`` setting: ``SupportSettings`` > ``ReportAProblemLink`` | @@ -288,6 +273,9 @@ Report a Problem link | String input. Default is ``https://mattermost.com/pl/report-a-bug``. | | +---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ +.. note:: + This setting is applicable to self-hosted deployments only. + .. config:setting:: report-a-problem-email :displayname: Report a Problem email (Customization) :systemconsole: Site Configuration > Customization @@ -298,9 +286,6 @@ Report a Problem link Report a Problem email address ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ | This field sets the email address for the **Report a Problem** link in the channel | - System Config path: **Site Configuration > Customization** | | header **Help** menu. | - ``config.json`` setting: ``SupportSettings`` > ``ReportAProblemMail`` | @@ -308,6 +293,9 @@ Report a Problem email address | String input. Cannot be left blank. | | +---------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ +.. note:: + This setting is applicable to self-hosted deployments only. + .. config:setting:: allow-mobile-app-log-downloads :displayname: Allow Mobile App Log Downloads (Customization) :systemconsole: Site Configuration > Customization @@ -318,9 +306,6 @@ Report a Problem email address Allow mobile app log downloads ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +--------------------------------------------------------------------------+-------------------------------------------------------------------------+ | Enable users to download mobile app logs for troubleshooting. | - System Config path: **Site Configuration > Customization** | | When the **Report a Problem** link is shown, mobile logs can be | - ``config.json`` setting: ``SupportSettings`` > ``AllowDownloadLogs`` | @@ -330,6 +315,9 @@ Allow mobile app log downloads | - **false** Users can't download mobile app logs. | | +--------------------------------------------------------------------------+-------------------------------------------------------------------------+ +.. note:: + This setting is applicable to self-hosted deployments only. + .. config:setting:: mattermost-apps-download-page-link :displayname: Mattermost apps download page link (Customization) :systemconsole: Site Configuration > Customization @@ -340,9 +328,6 @@ Allow mobile app log downloads Mattermost apps download page link ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ | This field sets the URL for the Download Apps link in the **Product** menu. If this field is empty, the link does not appear. | - System Config path: **Site Configuration > Customization** | | | - ``config.json`` setting: ``NativeAppSettings`` > ``AppDownloadLink`` | @@ -351,6 +336,9 @@ Mattermost apps download page link | String input. Default is ``https://mattermost.com/pl/download-apps``. | | +-------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------+ +.. note:: + This setting is applicable to self-hosted deployments only. + .. config:setting:: android-app-download-link :displayname: Android app download link (Customization) :systemconsole: Site Configuration > Customization @@ -361,9 +349,6 @@ Mattermost apps download page link Android app download link ~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ | This field sets the URL to download the Mattermost Android app. Users who access the Mattermost site on a mobile browser will be prompted to download the app through this link. If this field is empty, the prompt does not appear. | - System Config path: **Site Configuration > Customization** | | | - ``config.json`` setting: ``NativeAppSettings`` > ``AndroidAppDownloadLink`` | @@ -372,6 +357,9 @@ Android app download link | String input. Default is ``https://mattermost.com/pl/android-app/``. | | +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------+ +.. note:: + This setting is applicable to self-hosted deployments only. + .. config:setting:: ios-app-download-link :displayname: iOS app download link (Customization) :systemconsole: Site Configuration > Customization @@ -382,9 +370,6 @@ Android app download link iOS app download link ~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ | This field sets the URL to download the Mattermost iOS app. Users who access the site on a mobile browser will be prompted to download the app through this link. If this field is empty, the prompt does not appear. | - System Config path: **Site Configuration > Customization** | | | - ``config.json`` setting: ``NativeAppSettings`` > ``IosAppDownloadLink``| @@ -393,6 +378,9 @@ iOS app download link | String input. Default is ``https://mattermost.com/pl/ios-app/``. | | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ +.. note:: + This setting is applicable to self-hosted deployments only. + .. config:setting:: enable-desktop-app-landing-page :displayname: Enable desktop app landing page (Customization) :systemconsole: Site Configuration > Customization @@ -450,9 +438,6 @@ When configured, after OAuth or SAML user authentication is complete, custom URL Mobile external browser ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ | From Mattermost v10.2 and Mobile v2.2.1, this setting configures the mobile app | - System Config path: N/A | | to use an external mobile browser to perform SSO authentication. | - ``config.json`` setting: ``NativeAppSettings.MobileExternalBrowser`` | @@ -463,16 +448,16 @@ Mobile external browser | perform SSO authentication. | | +---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ -Enable this configuration setting when there are issues with the mobile app SSO redirect flow. +.. note:: + + - This setting is applicable to self-hosted deployments only. + - We recommend enabling this configuration setting when there are issues with the mobile app SSO redirect flow. ---- Localization ------------ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Site Configuration > Localization**. Changes to configuration settings in this section require a server restart before taking effect. .. config:setting:: default-server-language @@ -585,9 +570,6 @@ Enable work in progress languages in Mattermost to review translations and ident Users and teams --------------- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Site Configuration > Users and Teams**. .. config:setting:: max-users-per-team @@ -725,7 +707,7 @@ Teammate name display Lock teammate name display for all users ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ @@ -846,9 +828,6 @@ Enable last active time Enable custom user groups ~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ | - **true**: **(Default)** Users with appropriate permissions can create custom user groups, | - System Config path: **Site Configuration > Users and Teams** | | and users can @mention custom user groups in Mattermost conversations. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableCustomGroups`` > ``true`` | @@ -878,9 +857,6 @@ User statistics update time Notifications ------------- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Site Configuration > Notifications**. .. config:setting:: show-channel-all-or-here-confirmation-dialog @@ -1000,7 +976,7 @@ Enable email batching Email notification contents ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ @@ -1173,9 +1149,6 @@ Enable notification monitoring System-wide notifications ------------------------- -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Site Configuration > System-wide notifications**. .. config:setting:: enable-system-wide-notifications @@ -1271,9 +1244,6 @@ Allow banner dismissal Emoji ----- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Site Configuration > Emoji**. .. config:setting:: enable-emoji-picker @@ -1323,9 +1293,6 @@ Enable custom emoji Posts ----- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Site Configuration > Posts**. .. config:setting:: automatically-follow-threads @@ -1341,9 +1308,6 @@ Access the following configuration settings in the System Console by going to ** Automatically follow threads ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ | - **true**: **(Default)** Enables automatic following for all threads that a user starts, | - System Config path: **Site Configuration > Posts** | | or in which the user participates or is mentioned. A **Threads** table in the database | - ``config.json`` setting: ``ServiceSettings`` > ``ThreadAutoFollow`` > ``true`` | @@ -1353,6 +1317,7 @@ Automatically follow threads +-------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ .. note:: + - This setting is applicable to self-hosted deployments only. - This setting **must** be enabled for :doc:`threaded discussions ` to function. - Enabling this setting does not automatically follow threads based on previous user actions. For example, threads a user participated in prior to enabling this setting won't be automatically followed, unless the user adds a new comment or is mentioned @@ -1435,9 +1400,6 @@ Message priority Persistent notifications ~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - +--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | - **true**: **(Default)** Users can trigger repeating notifications to | - System Config path: **Site Configuration > Posts** | | mentioned recipients of urgent messages. | - ``config.json`` setting: ``ServiceSettings`` > ``AllowPersistentNotifications`` > ``true`` | @@ -1454,9 +1416,6 @@ Persistent notifications Maximum number of recipients for persistent notifications ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - +---------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ | The maximum number of recipients users may send persistent | - System Config path: **Site Configuration > Posts** | | notifications to. | - ``config.json`` setting: ``ServiceSettings`` > ``PersistentNotificationMaxRecipients`` > ``5`` | @@ -1474,9 +1433,6 @@ Maximum number of recipients for persistent notifications Frequency of persistent notifications ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - +---------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ | The number of minutes between repeated notifications for | - System Config path: **Site Configuration > Posts** | | urgent messages sent with persistent notifications. | - ``config.json`` setting: ``ServiceSettings`` > ``PersistentNotificationIntervalMinutes`` > ``5`` | @@ -1494,9 +1450,6 @@ Frequency of persistent notifications Total number of persistent notifications per post ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - +-------------------------------------------------------------+----------------------------------------------------------------------------------------------+ | The maximum number of times users may receive persistent | - System Config path: **Site Configuration > Posts** | | notifications. | - ``config.json`` setting: ``ServiceSettings`` > ``PersistentNotificationMaxCount`` > ``6`` | @@ -1699,9 +1652,6 @@ Maximum Markdown nodes Google API key ~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ | If a key is provided in this setting, Mattermost displays titles of embedded YouTube videos and detects if a video is no longer available. Setting a key should also prevent Google from throttling access to embedded videos that receive a high number of views. | - System Config path: **Site Configuration > Posts** | | | - ``config.json`` setting: ``ServiceSettings`` > ``GoogleDeveloperKey`` | @@ -1709,7 +1659,9 @@ Google API key +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+ .. note:: - This key is used in client-side Javascript, and must have the YouTube Data API added as a service. + + - This setting is applicable to self-hosted deployments only. + - This key is used in client-side Javascript, and must have the YouTube Data API added as a service. .. config:setting:: enable-server-syncing-of-message-drafts :displayname: Enable server syncing of message drafts (Posts) @@ -1771,9 +1723,6 @@ Unique emoji reaction limit File sharing and downloads -------------------------- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Site Configuration > File Sharing and Downloads**. .. config:setting:: allow-file-sharing @@ -1846,7 +1795,7 @@ Allow file downloads on mobile Enable secure file preview on mobile ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-adv-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: This setting improves an organization's mobile security posture by restricting file access while still allowing essential file viewing capabilities. @@ -1873,7 +1822,7 @@ This setting improves an organization's mobile security posture by restricting f Allow PDF link navigation on mobile ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-adv-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: +---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ @@ -1893,10 +1842,7 @@ Allow PDF link navigation on mobile Public Links ------------ -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - -Access the following configuration settings in the System Console by going to **Site Configuration > Public Links**. +With self-hosted deployments, you can access the following configuration settings in the System Console by going to **Site Configuration > Public Links**. .. config:setting:: enable-public-file-links :displayname: Enable public file links (Public links) @@ -1941,9 +1887,6 @@ Public link salt Notices ------- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Access the following configuration settings in the System Console by going to **Site Configuration > Notices**. .. config:setting:: enable-admin-notices @@ -1987,7 +1930,7 @@ Enable end user notices Connected workspaces ---------------------- -.. include:: ../../_static/badges/ent-adv-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: The following settings aren't available in the System Console and can only be set in ``config.json``. @@ -2134,8 +2077,7 @@ Member sync batch size config.json-only settings ------------------------- -.. include:: ../../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: +The following self-hosted deployment settings are only configurable in the ``config.json`` file and are not available in the System Console. .. config:setting:: enable-cross-team-search :displayname: Enable cross-team search diff --git a/source/administration-guide/configure/smtp-email.rst b/source/administration-guide/configure/smtp-email.rst index b63294b61b2..e7f089df8ed 100644 --- a/source/administration-guide/configure/smtp-email.rst +++ b/source/administration-guide/configure/smtp-email.rst @@ -1,7 +1,7 @@ SMTP email setup ================ -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: In a production environment, Mattermost requires SMTP email enabled for email notifications and password resets when using :ref:`email-based authentication `. diff --git a/source/administration-guide/configure/system-attributes.rst b/source/administration-guide/configure/system-attributes.rst index 90b94a050a9..c899455fb46 100644 --- a/source/administration-guide/configure/system-attributes.rst +++ b/source/administration-guide/configure/system-attributes.rst @@ -1,7 +1,7 @@ System Attributes ================= -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: System attributes configuration settings provide system admins with centralized control over key user account properties. diff --git a/source/administration-guide/configure/user-management-configuration-settings.rst b/source/administration-guide/configure/user-management-configuration-settings.rst index 728a4808dc1..0d995ba0fa6 100644 --- a/source/administration-guide/configure/user-management-configuration-settings.rst +++ b/source/administration-guide/configure/user-management-configuration-settings.rst @@ -1,7 +1,7 @@ User management configuration settings ====================================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Review and manage the following in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **User Management**: @@ -221,7 +221,7 @@ Add or remove users from teams using the System Console. Manage user's settings ~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: From Mattermost v9.11, system admins can help end users customize their Mattermost notifications by editing the user's :doc:`notification settings ` on the user's behalf within the System Console. Users can view, modify, and override their own settings at any time. @@ -488,6 +488,7 @@ Manage the Management actions available to channel members and guests. Create Posts ^^^^^^^^^^^^ + The ability for members and guests to create posts in the channel. 1. Go to **System Console > User Management > Channels** to access all available channels. @@ -500,6 +501,7 @@ The ability for members and guests to create posts in the channel. Post Reactions ^^^^^^^^^^^^^^ + The ability for members and guests to react with emojis on messages in the channel. 1. Go to **System Console > User Management > Channels** to access all available channels. @@ -512,6 +514,7 @@ The ability for members and guests to react with emojis on messages in the chann Manage Members ^^^^^^^^^^^^^^ + The ability for members to add and remove people from the channels. Guests can't add or remove people from channels. 1. Go to **System Console > User Management > Channels** to access all available channels. @@ -524,6 +527,7 @@ The ability for members to add and remove people from the channels. Guests can't Channel Mentions ^^^^^^^^^^^^^^^^ + The ability for members and guests to use channel mentions, including **@all**, **@here**, and **@channel**, in the channel. 1. Go to **System Console > User Management > Channels** to access all available channels. @@ -534,11 +538,13 @@ The ability for members and guests to use channel mentions, including **@all**, .. image:: ../../images/allow-mentions-for-a-channel.png :alt: Add Members and Guests to use mentions in a channel using the System Console. -.. tip:: +.. tip:: + **Guests** and **Members** can't use channel mentions without the ability to **Create Posts**. To enable this permission, these users must have been granted **Create Posts** permission first. Manage Bookmarks ^^^^^^^^^^^^^^^^ + The ability for members to add, delete, and sort bookmarks. Guests can't add, remove, or sort bookmarks for the channel. 1. Go to **System Console > User Management > Channels** to access all available channels. @@ -549,7 +555,8 @@ The ability for members to add, delete, and sort bookmarks. Guests can't add, re .. image:: ../../images/allow-manage-bookmarks-for-a-channel.png :alt: Allow Members to manage bookmarks for the channel using the System Console. -.. tip:: +.. tip:: + The ability to manage bookmarks for the channel is available for **Members** only. **Guests** can't add, remove or sort bookmarks for the channel. Channel Management @@ -559,6 +566,7 @@ Choose between inviting members manually or sychronizing members automatically f Sync Group Members ^^^^^^^^^^^^^^^^^^ + When enabled, adding and removing users from groups will add or remove them from this team. The only way of inviting members to this team is by adding the groups they belong to. See the :ref:`Synchronize teams and channels ` documentation for further details. 1. Go to **System Console > User Management > Channels** to access all available channels. @@ -571,6 +579,7 @@ When enabled, adding and removing users from groups will add or remove them from Public channel or private channel ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Public channels are discoverable and any user can join. Private channels require invitations to join. 1. Go to **System Console > User Management > Channels** to access all available channels. @@ -632,9 +641,6 @@ Archive a channel Permissions ----------- -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - +---------------------------------------------------------------------+-------------------------------------------------------------+ | Restrict actions in Mattermost to authorized users only. | - System Config path: **User Management > Permissions** | | | - ``config.json setting``: N/A | @@ -648,6 +654,9 @@ Permissions System roles ------------ +.. include:: ../../_static/badges/pro-plus.rst + :start-after: :nosearch: + +----------------------------------------------------------------------+------------------------------------------------------------+ | Restrict System Console access to authorized users only. | - System Config path: **User Management > System Roles** | | | - ``config.json setting``: N/A | diff --git a/source/administration-guide/manage/admin/abac-channel-access-rules.rst b/source/administration-guide/manage/admin/abac-channel-access-rules.rst index f8a12946124..98966014fb0 100644 --- a/source/administration-guide/manage/admin/abac-channel-access-rules.rst +++ b/source/administration-guide/manage/admin/abac-channel-access-rules.rst @@ -1,7 +1,7 @@ Channel-specific access rules ============================= -.. include:: ../../../_static/badges/ent-adv-cloud-selfhosted.rst +.. include:: ../../../_static/badges/ent-adv.rst :start-after: :nosearch: Channel and Team Admins can self-manage access controls for their private channels directly through the Channel Settings modal, without requiring System Admin intervention. For organization-wide policies created by System Admins, see :doc:`System-wide attribute-based access policies `. diff --git a/source/administration-guide/manage/admin/abac-system-wide-policies.rst b/source/administration-guide/manage/admin/abac-system-wide-policies.rst index 33c655d8627..35da001487f 100644 --- a/source/administration-guide/manage/admin/abac-system-wide-policies.rst +++ b/source/administration-guide/manage/admin/abac-system-wide-policies.rst @@ -1,7 +1,7 @@ System-wide attribute-based access policies ============================================================ -.. include:: ../../../_static/badges/ent-adv-cloud-selfhosted.rst +.. include:: ../../../_static/badges/ent-adv.rst :start-after: :nosearch: Use this guide to create and manage organization-wide attribute-based access policies in the System Console. For channel-level rules managed by Channel Admins, see :doc:`Channel-specific access rules `. diff --git a/source/administration-guide/manage/admin/attribute-based-access-control.rst b/source/administration-guide/manage/admin/attribute-based-access-control.rst index 98a0b56e65d..cc0cfb6d169 100644 --- a/source/administration-guide/manage/admin/attribute-based-access-control.rst +++ b/source/administration-guide/manage/admin/attribute-based-access-control.rst @@ -1,7 +1,7 @@ Attribute-Based Access Control ================================ -.. include:: ../../../_static/badges/ent-adv-cloud-selfhosted.rst +.. include:: ../../../_static/badges/ent-adv.rst :start-after: :nosearch: .. toctree:: diff --git a/source/administration-guide/manage/admin/error-codes.rst b/source/administration-guide/manage/admin/error-codes.rst index ee20e335e7d..8335194df9d 100644 --- a/source/administration-guide/manage/admin/error-codes.rst +++ b/source/administration-guide/manage/admin/error-codes.rst @@ -1,7 +1,7 @@ Mattermost error codes ====================== -.. include:: ../../../_static/badges/allplans-selfhosted.rst +.. include:: ../../../_static/badges/all-commercial.rst :start-after: :nosearch: Mattermost is designed to deploy in private networks which may be disconnected or “air-gapped” from the internet. In these deployments, links to Mattermost’s online documentation may be unavailable. diff --git a/source/administration-guide/manage/admin/generating-support-packet.rst b/source/administration-guide/manage/admin/generating-support-packet.rst index 0352db5b128..a7cc643cdda 100644 --- a/source/administration-guide/manage/admin/generating-support-packet.rst +++ b/source/administration-guide/manage/admin/generating-support-packet.rst @@ -1,7 +1,7 @@ Generate a Support Packet ========================== -.. include:: ../../../_static/badges/ent-pro-selfhosted.rst +.. include:: ../../../_static/badges/all-commercial.rst :start-after: :nosearch: The Support Packet is used to help customers diagnose and troubleshoot issues. Use the System Console or the :ref:`mmctl system supportpacket ` command to generate a zip file that includes configuration information, logs, plugin details, and data on external dependencies across all nodes in a high-availability cluster. Confidential data, such as passwords, are automatically stripped. diff --git a/source/administration-guide/manage/admin/installing-license-key.rst b/source/administration-guide/manage/admin/installing-license-key.rst index fbf95de289e..07658e845bc 100644 --- a/source/administration-guide/manage/admin/installing-license-key.rst +++ b/source/administration-guide/manage/admin/installing-license-key.rst @@ -1,7 +1,7 @@ Install a license key ===================== -.. include:: ../../../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../../../_static/badges/all-commercial.rst :start-after: :nosearch: You can use the System Console or the mmctl tools to add or change a Mattermost license key. diff --git a/source/administration-guide/manage/admin/self-hosted-billing.rst b/source/administration-guide/manage/admin/self-hosted-billing.rst index 669b6589c04..5311bfec937 100644 --- a/source/administration-guide/manage/admin/self-hosted-billing.rst +++ b/source/administration-guide/manage/admin/self-hosted-billing.rst @@ -1,9 +1,12 @@ Self-hosted billing =================== -Mattermost Enterprise and Professional plans are offered as an annual subscription service. With your purchase you're provided with a license key. Depending on which version of Mattermost you're on, you may have to download and apply this license manually via the System Console. +.. include:: ../../../_static/badges/all-commercial.rst + :start-after: :nosearch: -When you upgrade to an Enterprise or Professional plan, you can enter the number of users (also referred to as "seats") before you complete your purchase and the license key is generated. The number you enter has to be equal to or greater than your current number of activated users (formerly called active users). +Mattermost commercial plans are offered as an annual subscription service. With your purchase you're provided with a license key. Depending on which version of Mattermost you're on, you may have to download and apply this license manually via the System Console. + +When you upgrade to commercial plan, the number of user seats you need has to be equal to or greater than your current number of activated users (formerly called active users). You can add new users to your deployment at any time. Every quarter, during the true-up review (section 3.5 License True-up Review of Software License Agreement, also referenced in docs), we check the license license seat count relative to number of activated users. If there's a difference, we'll provide you with a new invoice which is payable immediately. diff --git a/source/administration-guide/manage/admin/user-attributes.rst b/source/administration-guide/manage/admin/user-attributes.rst index a5edd4c75ab..ba97b63b0c1 100644 --- a/source/administration-guide/manage/admin/user-attributes.rst +++ b/source/administration-guide/manage/admin/user-attributes.rst @@ -1,7 +1,7 @@ User attributes ================= -.. include:: ../../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../../_static/badges/ent-plus.rst :start-after: :nosearch: From Mattermost v10.8, ensure your teams always have the critical information they need to collaborate effectively by defining and managing organization-specific user profile attributes as system attributes that you can synchronize with your AD/LDAP or SAML identity provider. diff --git a/source/administration-guide/manage/bulk-export-tool.rst b/source/administration-guide/manage/bulk-export-tool.rst index a809f70fb99..46f3105cd48 100644 --- a/source/administration-guide/manage/bulk-export-tool.rst +++ b/source/administration-guide/manage/bulk-export-tool.rst @@ -3,7 +3,7 @@ Bulk export tool ================ -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Moving data from one Mattermost instance into another begins with exporting data to a `JSONL `__ file using the diff --git a/source/administration-guide/manage/cloud-byok.rst b/source/administration-guide/manage/cloud-byok.rst index ed72e36d01c..6537d185a0b 100644 --- a/source/administration-guide/manage/cloud-byok.rst +++ b/source/administration-guide/manage/cloud-byok.rst @@ -1,12 +1,9 @@ Cloud Dedicated Bring Your Own Key =================================== -.. include:: ../../_static/badges/ent-cloud-dedicated.rst - :start-after: :nosearch: - Bring Your Own Key (BYOK) provides Enterprise Cloud customers with autonomy over their encryption key life cycle. BYOK supports encryption at rest with custom KMS keys that the enterprise provides and maintains. -BYOK requires a subscription to Mattermost Cloud Enterprise Dedicated, which offers enhanced data security and compliance by ensuring that enterprises have full control over their data encryption processes. +**BYOK requires a subscription to Mattermost Cloud Enterprise Dedicated**, which offers enhanced data security and compliance by ensuring that enterprises have full control over their data encryption processes. In Mattermost Cloud Enterprise Dedicated, you can use KMS keys in 2 ways: diff --git a/source/administration-guide/manage/cloud-data-export.rst b/source/administration-guide/manage/cloud-data-export.rst index 92a8a02150f..d5b2442d8c4 100644 --- a/source/administration-guide/manage/cloud-data-export.rst +++ b/source/administration-guide/manage/cloud-data-export.rst @@ -1,7 +1,7 @@ Mattermost workspace migration ============================== -.. include:: ../../_static/badges/allplans-cloud.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: This document outlines the process for migrating an existing Mattermost instance `from self-hosted to Cloud <#migrate-from-self-hosted-to-cloud>`__, and `from Cloud to self-hosted <#migrate-from-cloud-to-self-hosted>`__. diff --git a/source/administration-guide/manage/cloud-data-residency.rst b/source/administration-guide/manage/cloud-data-residency.rst index 8d99d687077..407a362a563 100644 --- a/source/administration-guide/manage/cloud-data-residency.rst +++ b/source/administration-guide/manage/cloud-data-residency.rst @@ -1,9 +1,6 @@ Mattermost Cloud data residency =============================== -.. include:: ../../_static/badges/allplans-cloud.rst - :start-after: :nosearch: - Mattermost Cloud resides in the ``aws-us-east-1`` region, located in Virginia, United States. The following customer data will be stored at rest in this data center when using Mattermost Cloud: - Channels, messages, replies, and channel membership information diff --git a/source/administration-guide/manage/cloud-ip-filtering.rst b/source/administration-guide/manage/cloud-ip-filtering.rst index ea0998fb0b3..2c46b5a105b 100644 --- a/source/administration-guide/manage/cloud-ip-filtering.rst +++ b/source/administration-guide/manage/cloud-ip-filtering.rst @@ -1,10 +1,9 @@ Cloud IP Filtering ======================== -.. include:: ../../_static/badges/ent-cloud-only.rst - :start-after: :nosearch: +IP filtering is a powerful security feature that allows system admins to control access to their workspace by defining approved IP ranges. Only users within these specified IP ranges can access the workspace, ensuring enhanced security for your workspace. -IP filtering is a powerful security feature that allows system admins to control access to their workspace by defining approved IP ranges. Only users within these specified IP ranges can access the workspace, ensuring enhanced security for your workspace. IP filtering requires a subscription to Mattermost Cloud Enterprise. +**IP filtering requires a subscription to Mattermost Cloud Enterprise.** Configure IP filtering ------------------------ diff --git a/source/administration-guide/manage/code-signing-custom-builds.rst b/source/administration-guide/manage/code-signing-custom-builds.rst index ec071b25e4a..d3de2cb5e39 100644 --- a/source/administration-guide/manage/code-signing-custom-builds.rst +++ b/source/administration-guide/manage/code-signing-custom-builds.rst @@ -1,7 +1,7 @@ Code signing custom builds ========================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Code signing is an essential process for ensuring the authenticity and integrity of your custom ``Mattermost`` builds. This guide provides steps on how to code sign a build using your own certificates for Windows, Mac, and Linux. diff --git a/source/administration-guide/manage/command-line-tools.rst b/source/administration-guide/manage/command-line-tools.rst index 781a9ec457c..c9994ba388a 100644 --- a/source/administration-guide/manage/command-line-tools.rst +++ b/source/administration-guide/manage/command-line-tools.rst @@ -1,7 +1,7 @@ Command line tools ================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: In self-managed deployments, a ``mattermost`` command is available for configuring the system from the directory where the Mattermost server is installed. For an overview of the Mattermost command line interface (CLI), `read this article `_ from Santos. @@ -237,7 +237,7 @@ Format mattermost export ----------------- -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: Description diff --git a/source/administration-guide/manage/configure-health-check-probes.rst b/source/administration-guide/manage/configure-health-check-probes.rst index 1fabf1c8626..1c394b15cd2 100644 --- a/source/administration-guide/manage/configure-health-check-probes.rst +++ b/source/administration-guide/manage/configure-health-check-probes.rst @@ -1,7 +1,7 @@ Configure server health check probes ==================================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: This page describes how to configure health check probes for a Mattermost server. diff --git a/source/administration-guide/manage/feature-labels.rst b/source/administration-guide/manage/feature-labels.rst index 7dd884847bb..c7a55bdbb5a 100644 --- a/source/administration-guide/manage/feature-labels.rst +++ b/source/administration-guide/manage/feature-labels.rst @@ -1,6 +1,9 @@ Mattermost feature labels ========================== +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + Mattermost’s feature labels serve as indicators of the status, maturity, and support level of each feature, helping users and system administrators navigate product feature adoption with clarity and confidence. Feature labels communicate the stage of development, level of readiness, and potential risks associated with a feature for customers seeking to adopt new value. Experimental diff --git a/source/administration-guide/manage/in-product-notices.rst b/source/administration-guide/manage/in-product-notices.rst index 277df6441cc..fcd2673a8af 100644 --- a/source/administration-guide/manage/in-product-notices.rst +++ b/source/administration-guide/manage/in-product-notices.rst @@ -1,7 +1,7 @@ In-product notices ================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Mattermost in-product notices keep users and administrators informed of the newest product improvements, features, and releases. diff --git a/source/administration-guide/manage/logging.rst b/source/administration-guide/manage/logging.rst index 5d2a2d2181d..3e3b97484a9 100644 --- a/source/administration-guide/manage/logging.rst +++ b/source/administration-guide/manage/logging.rst @@ -1,7 +1,7 @@ Mattermost logging =================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: .. important:: @@ -199,7 +199,7 @@ You can use the sample JSON below as a starting point. Audit logging --------------- -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: By default, Mattermost doesn’t write audit logs locally to a file on the server, and the ability to enable audit logging in Mattermost is currently in :ref:`Beta `. @@ -243,7 +243,7 @@ You can enable and customize advanced audit logging in Mattermost to record acti Advanced logging ----------------- -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: System admins can output log and audit records for general and audit activities to any combination of `console <#console-target-configuration-options>`__, `local file <#file-target-configuration-options>`__, `syslog <#syslog-target-configuration-options>`__, and `TCP socket <#tcp-target-configuration-options>`__ targets. @@ -646,7 +646,7 @@ File targets support rotation and compression triggered by size and/or duration. Syslog target configuration options ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Syslog targets support local and remote syslog servers, with or without TLS transport. Syslog target support requires Mattermost Enterprise. @@ -671,7 +671,7 @@ Syslog targets support local and remote syslog servers, with or without TLS tran TCP target configuration options ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: The TCP socket targets can be configured with an IP address or domain name, port, and optional TLS certificate. TCP socket target support requires Mattermost Enterprise. You can :download:`download a sample JSON file ` of the configuration to use as a starting point. diff --git a/source/administration-guide/manage/mmctl-command-line-tool.rst b/source/administration-guide/manage/mmctl-command-line-tool.rst index e96e189d3ed..db4cdc5287f 100644 --- a/source/administration-guide/manage/mmctl-command-line-tool.rst +++ b/source/administration-guide/manage/mmctl-command-line-tool.rst @@ -1,7 +1,7 @@ mmctl command line tool ======================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: The mmctl is a CLI tool for the Mattermost server which is installed locally and uses the Mattermost API, but may also be used remotely. Authentication is done with either login credentials or an authentication token. This mmctl tool is included and replaces the :doc:`CLI `. The mmctl can currently be used alongside the Mattermost CLI tool. The Mattermost CLI tool will be deprecated in a future release. @@ -134,8 +134,7 @@ After checking out the `mattermost repository `. + To maximize performance for large enterprise deployments, statistics for total messages, total hashtag messages, total file messages, messages per day, and activated users with messages per day is configurable by changing the ``MaxUsersForStatistics`` value :ref:`in config.json `. -For advanced metrics for Enterprise deployments, :doc:`see performance monitoring documentation to learn more `. +For advanced metrics for Entry, Enterprise, and Enterprise deployments, :doc:`see performance monitoring documentation to learn more `. Site statistics --------------- @@ -47,10 +47,10 @@ Active Users with Posts (graph) Advanced system statistics ~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: -Mattermost Enterprise includes additional system statistics. +Self-hosted deployments include additional system statistics. Total Sessions The number of active user sessions connected to your system. Expired sessions are not counted. @@ -125,10 +125,10 @@ If the statistics page is loading endlessly and you get an error message saying Can team admins review their own team's statistics? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-selfhosted-only.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: -Yes. In Mattermost Enterprise, you can enable team admins to see their team's statistics by modifying available delegated granular administration system roles. See the :doc:`delegated granular administration ` documentation to learn more about these admin roles, including how to manage privileges and assign roles. +Yes. With self-hosted deployments, you can enable team admins to see their team's statistics by modifying available delegated granular administration system roles. See the :doc:`delegated granular administration ` documentation to learn more about these admin roles, including how to manage privileges and assign roles. To enable team admins to access their team's statistics: diff --git a/source/administration-guide/manage/system-wide-notifications.rst b/source/administration-guide/manage/system-wide-notifications.rst index fd09e7651d4..f9ce1d69b23 100644 --- a/source/administration-guide/manage/system-wide-notifications.rst +++ b/source/administration-guide/manage/system-wide-notifications.rst @@ -1,7 +1,7 @@ System-wide notifications ========================= -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: System admins can configure system-wide notifications visibile in all channels for all users across all teams. diff --git a/source/administration-guide/manage/team-channel-members.rst b/source/administration-guide/manage/team-channel-members.rst index 29e726647ac..96a6a2b4999 100644 --- a/source/administration-guide/manage/team-channel-members.rst +++ b/source/administration-guide/manage/team-channel-members.rst @@ -1,7 +1,7 @@ Manage team and channel members ================================ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: System admins can manage channel configuration in the System Console, including: @@ -43,7 +43,7 @@ Alternatively, system admins can use the mmctl ``mmctl team restore`` to archive Team management ~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: - When **Sync Group Members** is enabled, the **Synced Groups** list is visible and additional groups can be added. @@ -52,7 +52,7 @@ Team management Groups ~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: You can add and remove groups, as well as promote or demote group members to team admin/member roles. @@ -88,7 +88,7 @@ The name and description of the channel. To archive the channel, select **Archiv Channel management ~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: - When **Sync Group Members** is enabled, the **Synced Groups** list is visible and additional groups can be added. @@ -97,9 +97,6 @@ Channel management Advanced access controls ~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - Advanced access control settings enable system admins to restrict actions within specific channels. These actions include: - **Make channel read-only:** :ref:`Read-only channels ` enable system admins to turn off posting in specified channels. @@ -139,7 +136,7 @@ The channel is available for all members and guests to access but only Admins ca Groups ~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: You can add and remove groups, as well as promote or demote group members to team admin/member roles. diff --git a/source/administration-guide/manage/user-satisfaction-surveys.rst b/source/administration-guide/manage/user-satisfaction-surveys.rst index 37e5a6a1482..30e8819097c 100644 --- a/source/administration-guide/manage/user-satisfaction-surveys.rst +++ b/source/administration-guide/manage/user-satisfaction-surveys.rst @@ -1,7 +1,7 @@ User satisfaction surveys ========================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Feedback is used to measure user satisfaction and improve product quality by hearing directly from users. Please refer to our `privacy policy `_ for information on the collection and use of information received through our services. @@ -88,7 +88,4 @@ Data is only collected when a user selects a score or provides written feedback Will this data be sent through my firewall? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - -If Mattermost is hosted in a private network with firewall then data from the User Satisfaction Surveys plugin is not sent unless outbound connections are allowed or specifically configured for this plugin. +If Mattermost is self-hosted in a private network with firewall then data from the User Satisfaction Surveys plugin is not sent unless outbound connections are allowed or specifically configured for this plugin. diff --git a/source/administration-guide/onboard/ad-ldap-groups-synchronization.rst b/source/administration-guide/onboard/ad-ldap-groups-synchronization.rst index 1779b64f5f0..da27d9b2023 100644 --- a/source/administration-guide/onboard/ad-ldap-groups-synchronization.rst +++ b/source/administration-guide/onboard/ad-ldap-groups-synchronization.rst @@ -3,7 +3,7 @@ AD/LDAP groups ============== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Overview diff --git a/source/administration-guide/onboard/ad-ldap.rst b/source/administration-guide/onboard/ad-ldap.rst index b6e7a7e53a8..1a11f6b3a19 100644 --- a/source/administration-guide/onboard/ad-ldap.rst +++ b/source/administration-guide/onboard/ad-ldap.rst @@ -1,7 +1,7 @@ AD/LDAP setup ============= -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Overview @@ -101,6 +101,9 @@ Configure AD/LDAP login Configure AD/LDAP synchronization ---------------------------------- +.. include:: ../../_static/badges/entry-ent.rst + :start-after: :nosearch: + In addition to configuring AD/LDAP sign-in, you can also configure AD/LDAP synchronization. When synchronizing, Mattermost queries AD/LDAP for relevant account information and updates Mattermost accounts based on changes to attributes (first name, last name, and nickname). When accounts are disabled in AD/LDAP users are deactivated in Mattermost, and their active sessions are revoked once Mattermost synchronizes the updated attributes. The AD/LDAP synchronization depends on email. Make sure all users on your AD/LDAP server have an email address, or ensure their account is deactivated in Mattermost. diff --git a/source/administration-guide/onboard/advanced-permissions-backend-infrastructure.rst b/source/administration-guide/onboard/advanced-permissions-backend-infrastructure.rst index 8ba51998bc0..7a694f73596 100644 --- a/source/administration-guide/onboard/advanced-permissions-backend-infrastructure.rst +++ b/source/administration-guide/onboard/advanced-permissions-backend-infrastructure.rst @@ -1,7 +1,7 @@ Advanced permissions: backend infrastructure ============================================ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: This document outlines the backend server infrastructure for permissions in Mattermost and is recommended only for technical Admins or developers looking to make modifications to their installation. diff --git a/source/administration-guide/onboard/advanced-permissions.rst b/source/administration-guide/onboard/advanced-permissions.rst index ce9a0c26161..482012a322b 100644 --- a/source/administration-guide/onboard/advanced-permissions.rst +++ b/source/administration-guide/onboard/advanced-permissions.rst @@ -1,7 +1,7 @@ Advanced permissions ==================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Mattermost system admins using Mattermost Cloud or Mattermost Server can use Advanced Permissions to customize which users can perform specific actions, such as creating teams, managing channels, and configuring webhooks. The Mattermost permission system is based on a modified RBAC (role-based access control) architecture, using roles to determine which users have the ability to perform various actions. @@ -37,7 +37,7 @@ You can access the System Scheme interface by going to **System Console > User M Team override scheme ~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: On systems with multiple :ref:`Mattermost teams `, each team may operate and collaborate in a unique way. Team Override Schemes give Admins the flexibility to tailor permissions to the needs of each team. @@ -60,7 +60,7 @@ The channel permissions interface is accessed in **System Console > User Managem Advanced access controls ~~~~~~~~~~~~~~~~~~~~~~~~~ -See the :ref:`team and channel management ` documentation for details. +See the :ref:`team and channel management ` documentation for details on available channel access controls. Recipes ------- @@ -145,7 +145,7 @@ This permission is applied to all other roles (excluding the Guest role). When t Read-only channels ~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: Members can participate but guests can only read and react diff --git a/source/administration-guide/onboard/bulk-loading-data.rst b/source/administration-guide/onboard/bulk-loading-data.rst index 3d27928648c..56ce8efe7e1 100644 --- a/source/administration-guide/onboard/bulk-loading-data.rst +++ b/source/administration-guide/onboard/bulk-loading-data.rst @@ -1,7 +1,7 @@ Bulk loading data ================= -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Large quantities of data can be imported from a `JSONL `__ file into Mattermost at the command line using the bulk loading feature. This feature is most suitable for migrating data from an existing system, or for pre-populating a new installation with data. diff --git a/source/administration-guide/onboard/certificate-based-authentication.rst b/source/administration-guide/onboard/certificate-based-authentication.rst index 48e5f82e66b..ecc6b7e8eab 100644 --- a/source/administration-guide/onboard/certificate-based-authentication.rst +++ b/source/administration-guide/onboard/certificate-based-authentication.rst @@ -1,7 +1,7 @@ Certificate-based authentication (Experimental) =============================================== -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: .. important:: diff --git a/source/administration-guide/onboard/connected-workspaces.rst b/source/administration-guide/onboard/connected-workspaces.rst index 3b9ccc63a4d..67732b1a92e 100644 --- a/source/administration-guide/onboard/connected-workspaces.rst +++ b/source/administration-guide/onboard/connected-workspaces.rst @@ -1,7 +1,7 @@ Connected workspaces ==================== -.. include:: ../../_static/badges/ent-adv-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Communicate across organizations, as well as external partners and vendors using Mattermost by synchronizing messages, emoji reactions, and file sharing in real-time through secured, connected Mattermost workspaces. diff --git a/source/administration-guide/onboard/convert-oauth20-service-providers-to-openidconnect.rst b/source/administration-guide/onboard/convert-oauth20-service-providers-to-openidconnect.rst index 88455655a28..05ec9acb133 100644 --- a/source/administration-guide/onboard/convert-oauth20-service-providers-to-openidconnect.rst +++ b/source/administration-guide/onboard/convert-oauth20-service-providers-to-openidconnect.rst @@ -1,7 +1,7 @@ Converting OAuth 2.0 Service Providers to OpenID Connect ======================================================== -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: .. include:: common-converting-oauth-to-openidconnect.rst @@ -10,10 +10,7 @@ Converting OAuth 2.0 Service Providers to OpenID Connect Configuring OpenID Connect Single Sign-On ----------------------------------------- -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - -For details on configuring Mattermost to use a service provider as a Single Sign-on (SSO) service for team creation, account creation, and user sign-in using OpenID Connect, refer to the following documentation: +For details on configuring Mattermost to use a service provider as a Single Sign-on (SSO) service for team creation, account creation, and user sign-in using OpenID Connect in your self-hosted deployment, refer to the following documentation: - :doc:`OpenID Connect Single Sign-On ` - :doc:`GitLab Single Sign-On ` diff --git a/source/administration-guide/onboard/delegated-granular-administration.rst b/source/administration-guide/onboard/delegated-granular-administration.rst index 2274c42f7e2..a4e80d62253 100644 --- a/source/administration-guide/onboard/delegated-granular-administration.rst +++ b/source/administration-guide/onboard/delegated-granular-administration.rst @@ -1,7 +1,7 @@ Delegated granular administration ================================= -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: Mattermost supports the creation and customization of system administration roles with specific granular permissions and System Console access. This allows senior administrators in large organizations to delegate and de-centralize specialized administration and administrative tasks with specific admin roles. diff --git a/source/administration-guide/onboard/guest-accounts.rst b/source/administration-guide/onboard/guest-accounts.rst index 9a8e91b527e..48995d6d120 100644 --- a/source/administration-guide/onboard/guest-accounts.rst +++ b/source/administration-guide/onboard/guest-accounts.rst @@ -3,7 +3,7 @@ Guest accounts ============== -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Guest accounts in Mattermost are a way to collaborate with individuals, such as vendors and contractors, outside of your organization by controlling their access to channels and team members. For example, guest accounts can be used to collaborate with customers on a support issue or work on a website project with resources from an external design firm. diff --git a/source/administration-guide/onboard/managing-team-channel-membership-using-ad-ldap-sync-groups.rst b/source/administration-guide/onboard/managing-team-channel-membership-using-ad-ldap-sync-groups.rst index 2a3c753b4bc..cce01e5690d 100644 --- a/source/administration-guide/onboard/managing-team-channel-membership-using-ad-ldap-sync-groups.rst +++ b/source/administration-guide/onboard/managing-team-channel-membership-using-ad-ldap-sync-groups.rst @@ -3,7 +3,7 @@ Using AD/LDAP synchronized groups to manage team or private channel membership ------------------------------------------------------------------------------ -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: Mattermost groups created with :doc:`synchronized AD/LDAP groups ` can be used to manage the membership of private teams and private channels. When a team or private channel is managed by synchronized groups, users will be added and removed based on their membership to the synchronized AD/LDAP group. diff --git a/source/administration-guide/onboard/migrate-from-slack.rst b/source/administration-guide/onboard/migrate-from-slack.rst index edae37f1453..74e0cb1323d 100644 --- a/source/administration-guide/onboard/migrate-from-slack.rst +++ b/source/administration-guide/onboard/migrate-from-slack.rst @@ -1,7 +1,7 @@ Migrate from Slack ================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Overview diff --git a/source/administration-guide/onboard/migrating-to-mattermost.rst b/source/administration-guide/onboard/migrating-to-mattermost.rst index 40c6e71a460..d5bb4069f8a 100644 --- a/source/administration-guide/onboard/migrating-to-mattermost.rst +++ b/source/administration-guide/onboard/migrating-to-mattermost.rst @@ -1,7 +1,7 @@ Migration guide =============== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Migrations help you move your Mattermost deployment or data from one environment to another with minimal disruption. Whether you’re transitioning your Mattermost server to new infrastructure, restructuring your database, or moving from another collaboration platform like Slack, this guide provides step-by-step instructions for each supported path. Use the sections below to quickly find the scenario that matches your needs and follow the recommended process to ensure a smooth migration. diff --git a/source/administration-guide/onboard/migration-announcement-email.rst b/source/administration-guide/onboard/migration-announcement-email.rst index 9110fe287c1..1637302341b 100644 --- a/source/administration-guide/onboard/migration-announcement-email.rst +++ b/source/administration-guide/onboard/migration-announcement-email.rst @@ -1,7 +1,7 @@ Migration announcement email ============================ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: To notify your end users of your migration to Mattermost, we created a sample email template that you can use. diff --git a/source/administration-guide/onboard/multi-factor-authentication.rst b/source/administration-guide/onboard/multi-factor-authentication.rst index 9397d3cf328..3afd09ac9f1 100644 --- a/source/administration-guide/onboard/multi-factor-authentication.rst +++ b/source/administration-guide/onboard/multi-factor-authentication.rst @@ -3,7 +3,7 @@ Multi-factor authentication =========================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Multi-factor authentication (MFA) is a secondary layer of user authentication applied to your Mattermost server that applies to all users on all teams within your Mattermost workspace. @@ -35,7 +35,7 @@ MFA can be disabled for user accounts using the API. See the `Mattermost API Ref Enforcing MFA -------------- -.. include:: ../../_static/badges/ent-pro-only.rst +.. include:: ../../_static/badges/pro-plus.rst :start-after: :nosearch: Admins can fulfill Multi-Factor Authentication (MFA) compliance requirements by enforcing an MFA requirement for login with email and LDAP accounts. Go to **System Console > Authentication > MFA**, then set **Enforce Multi-factor Authentication** to **true**. diff --git a/source/administration-guide/onboard/ssl-client-certificate.rst b/source/administration-guide/onboard/ssl-client-certificate.rst index 128ea54663a..d7ad0cdf8a0 100644 --- a/source/administration-guide/onboard/ssl-client-certificate.rst +++ b/source/administration-guide/onboard/ssl-client-certificate.rst @@ -1,7 +1,7 @@ SSL client certificate setup ============================ -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Follow these steps to configure SSL client certificates for your browser and the Mattermost desktop apps on Windows, macOS, and Linux. diff --git a/source/administration-guide/onboard/sso-entraid.rst b/source/administration-guide/onboard/sso-entraid.rst index c8f2f8e138d..285b07dcb63 100644 --- a/source/administration-guide/onboard/sso-entraid.rst +++ b/source/administration-guide/onboard/sso-entraid.rst @@ -1,7 +1,7 @@ Entra ID Single Sign-On ========================= -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Configuring EntraID as a Single Sign-On (SSO) service @@ -81,9 +81,6 @@ If you don't register Mattermost in the Microsoft Azure AD tenant your organizat Configure Mattermost ``config.json`` for Entra ID SSO ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst - :start-after: :nosearch: - Instead of using the System Console, you can add the Entra ID settings directly to the ``config.json`` file on your Mattermost server. 1. Open ``config.json`` as *root* in a text editor. It’s usually in ``/opt/mattermost/config`` but it might be elsewhere on your system. diff --git a/source/administration-guide/onboard/sso-gitlab.rst b/source/administration-guide/onboard/sso-gitlab.rst index d9c25d66a03..de6690f3ab8 100644 --- a/source/administration-guide/onboard/sso-gitlab.rst +++ b/source/administration-guide/onboard/sso-gitlab.rst @@ -1,7 +1,7 @@ GitLab Single Sign-On ===================== -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Configuring GitLab as a Single Sign-On (SSO) service diff --git a/source/administration-guide/onboard/sso-google.rst b/source/administration-guide/onboard/sso-google.rst index e7201344460..c648def471b 100644 --- a/source/administration-guide/onboard/sso-google.rst +++ b/source/administration-guide/onboard/sso-google.rst @@ -1,7 +1,7 @@ Google Single Sign-On ===================== -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Configuring Google Apps as a Single Sign-On (SSO) service @@ -68,9 +68,6 @@ Step 3: Configure Mattermost for Google Apps SSO Configure Mattermost ``config.json`` for Google Apps SSO ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - Instead of using the System Console, you can add the Google settings directly to the ``config.json`` file directly on your Mattermost server. 1. Open ``config.json`` as *root* in a text editor. It’s usually in ``/opt/mattermost/config``, but it might be elsewhere on your system. diff --git a/source/administration-guide/onboard/sso-openidconnect.rst b/source/administration-guide/onboard/sso-openidconnect.rst index 049003b8150..d9dc5e872ff 100644 --- a/source/administration-guide/onboard/sso-openidconnect.rst +++ b/source/administration-guide/onboard/sso-openidconnect.rst @@ -1,7 +1,7 @@ OpenID Connect Single Sign-On ============================== -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Mattermost provides OpenID Connect support for :doc:`GitLab `, :doc:`Google Apps `, and :doc:`Entra ID `. With OpenID Connect, users can also use their login to Keycloak, Atlassian Crowd, Apple, Microsoft, Salesforce, Auth0, Ory.sh, Facebook, Okta, OneLogin, and Azure AD, as well as others, as a Single Sign-on (SSO) service for team creation, account creation, and user login. diff --git a/source/administration-guide/onboard/sso-saml-adfs-msws2016.rst b/source/administration-guide/onboard/sso-saml-adfs-msws2016.rst index 66a0ec4717a..d4be766449c 100644 --- a/source/administration-guide/onboard/sso-saml-adfs-msws2016.rst +++ b/source/administration-guide/onboard/sso-saml-adfs-msws2016.rst @@ -1,10 +1,13 @@ Configure SAML with Microsoft ADFS using Microsoft Windows Server 2016 ====================================================================== +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + This document provides steps to configure SAML 2.0 with Microsoft ADFS for Mattermost and Microsoft Windows Server 2016. .. include:: sso-saml-before-you-begin.rst - :start-after: :nosearch: + :start-after: :nosearch: Prerequisites ------------- diff --git a/source/administration-guide/onboard/sso-saml-adfs.rst b/source/administration-guide/onboard/sso-saml-adfs.rst index 1621f953c99..887e938586d 100644 --- a/source/administration-guide/onboard/sso-saml-adfs.rst +++ b/source/administration-guide/onboard/sso-saml-adfs.rst @@ -1,10 +1,13 @@ Configure SAML with Microsoft ADFS for Windows Server 2012 ========================================================== +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + The following process provides steps to configure SAML 2.0 with Microsoft ADFS for Mattermost. .. include:: sso-saml-before-you-begin.rst - :start-after: :nosearch: + :start-after: :nosearch: The following are basic requirements to use ADFS for Mattermost: - An Active Directory instance where all users have a specified email and username attributes. For Mattermost servers running 3.3 and earlier, users must also have their first name and last name attributes specified. diff --git a/source/administration-guide/onboard/sso-saml-keycloak.rst b/source/administration-guide/onboard/sso-saml-keycloak.rst index b06dff7120f..847d0e96738 100644 --- a/source/administration-guide/onboard/sso-saml-keycloak.rst +++ b/source/administration-guide/onboard/sso-saml-keycloak.rst @@ -1,7 +1,7 @@ Configure SAML with Keycloak ============================ -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: The following process provides steps to configure SAML with Keycloak for Mattermost. diff --git a/source/administration-guide/onboard/sso-saml-okta.rst b/source/administration-guide/onboard/sso-saml-okta.rst index 56d85e8d6ac..733509fe3fe 100644 --- a/source/administration-guide/onboard/sso-saml-okta.rst +++ b/source/administration-guide/onboard/sso-saml-okta.rst @@ -1,6 +1,9 @@ Configure SAML with Okta ======================== +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + The following process provides steps to configure SAML 2.0 with Okta for Mattermost. See the encryption options documentation for details on what :ref:`encryption methods ` Mattermost supports for SAML. diff --git a/source/administration-guide/onboard/sso-saml-onelogin.rst b/source/administration-guide/onboard/sso-saml-onelogin.rst index 7ce03f4d0f5..2f4a4fa05a9 100644 --- a/source/administration-guide/onboard/sso-saml-onelogin.rst +++ b/source/administration-guide/onboard/sso-saml-onelogin.rst @@ -1,6 +1,9 @@ Configure SAML with OneLogin ============================= +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + The following process provides steps to configure SAML 2.0 with OneLogin for Mattermost. See the encryption options documentation for details on what :ref:`encryption methods ` Mattermost supports for SAML. diff --git a/source/administration-guide/onboard/sso-saml-technical.rst b/source/administration-guide/onboard/sso-saml-technical.rst index 7b1b7115292..99fbb48c191 100644 --- a/source/administration-guide/onboard/sso-saml-technical.rst +++ b/source/administration-guide/onboard/sso-saml-technical.rst @@ -3,7 +3,7 @@ SAML Single Sign-On: technical documentation ============================================ -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Security Assertion Markup Language (SAML) is an open standard that allows identity providers (IdP), like OneLogin, to pass authorization credentials to service providers (SP), like Mattermost. diff --git a/source/administration-guide/onboard/sso-saml.rst b/source/administration-guide/onboard/sso-saml.rst index c13bef3bc91..35f94228e75 100644 --- a/source/administration-guide/onboard/sso-saml.rst +++ b/source/administration-guide/onboard/sso-saml.rst @@ -1,7 +1,7 @@ SAML Single Sign-On =================== -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Single sign-on (SSO) is a way for users to log into multiple applications with a single user ID and password without having to re-enter their credentials. The SAML standard allows identity providers to pass credentials to service providers. Mattermost can be configured to act as a SAML 2.0 Service Provider. diff --git a/source/administration-guide/onboard/user-provisioning-workflows.rst b/source/administration-guide/onboard/user-provisioning-workflows.rst index eacbb9b659d..cde14110113 100644 --- a/source/administration-guide/onboard/user-provisioning-workflows.rst +++ b/source/administration-guide/onboard/user-provisioning-workflows.rst @@ -3,7 +3,7 @@ Provisioning workflows ====================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: This document provides an overview of user provisioning and deprovisioning workflows in Mattermost. diff --git a/source/administration-guide/scale/collect-performance-metrics.rst b/source/administration-guide/scale/collect-performance-metrics.rst index 3c38593bf93..9a07bb46a01 100644 --- a/source/administration-guide/scale/collect-performance-metrics.rst +++ b/source/administration-guide/scale/collect-performance-metrics.rst @@ -1,7 +1,7 @@ Collect performance metrics ============================ -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: System admins can collect and store the :doc:`same performance monitoring metrics ` as Prometheus, without having to deploy these third-party tools. Data is collected every minute and is stored in a path you configure. The data is synchronized to either a cloud-based or local file store every hour, and retained for 15 days. diff --git a/source/administration-guide/scale/deploy-prometheus-grafana-for-performance-monitoring.rst b/source/administration-guide/scale/deploy-prometheus-grafana-for-performance-monitoring.rst index 8d35a2d3721..90362d0e2e3 100644 --- a/source/administration-guide/scale/deploy-prometheus-grafana-for-performance-monitoring.rst +++ b/source/administration-guide/scale/deploy-prometheus-grafana-for-performance-monitoring.rst @@ -1,7 +1,7 @@ Deploy Prometheus and Grafana for performance monitoring ======================================================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Performance monitoring support enables admins to track system health for large Enterprise deployments through integrations with `Prometheus `_ and `Grafana `__. These integrations support data collection from several Mattermost servers, which is particularly useful if you're running Mattermost :doc:`in high availability mode `. Once you're tracking system health, you can :doc:`set up performance alerts ` on your Grafana dashboard. diff --git a/source/administration-guide/scale/elasticsearch-setup.rst b/source/administration-guide/scale/elasticsearch-setup.rst index 54bd45798d7..d49024540f0 100644 --- a/source/administration-guide/scale/elasticsearch-setup.rst +++ b/source/administration-guide/scale/elasticsearch-setup.rst @@ -1,7 +1,7 @@ Elasticsearch server setup =========================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: Elasticsearch allows you to search large volumes of data quickly, in near real-time, by creating and managing an index of post data. The indexing process can be managed from the System Console after setting up and connecting an Elasticsearch server. The post index is stored on the Elasticsearch server and updated constantly after new posts are made. In order to index existing posts, a bulk index of the entire post database must be generated. @@ -84,4 +84,4 @@ Follow these steps to configure Mattermost to use your Elasticsearch server and 3. Ensure **Backend type** is set to ``elasticsearch``. .. include:: /administration-guide/scale/common-configure-mattermost-for-enterprise-search.rst - :start-after: :nosearch: \ No newline at end of file + :start-after: :nosearch: \ No newline at end of file diff --git a/source/administration-guide/scale/ensuring-releases-perform-at-scale.rst b/source/administration-guide/scale/ensuring-releases-perform-at-scale.rst index a3bad00b815..649ce0274b2 100644 --- a/source/administration-guide/scale/ensuring-releases-perform-at-scale.rst +++ b/source/administration-guide/scale/ensuring-releases-perform-at-scale.rst @@ -1,6 +1,9 @@ Ensuring Releases Perform at Scale ================================== +.. include:: ../../_static/badges/entry-ent.rst + :start-after: :nosearch: + To ensure each release of Mattermost upholds our high standards for performance at scale, the Mattermost Engineering team performs thorough load testing, develops features with scale in mind, and follows strict guidelines for database schema migrations. Monthly release load tests @@ -36,7 +39,6 @@ If a more involved migration is required, detailed analysis is performed and pub Additionally, all database schema changes are load tested as a part of our monthly release process. - Monitoring post-release ----------------------- diff --git a/source/administration-guide/scale/enterprise-search.rst b/source/administration-guide/scale/enterprise-search.rst index e0224116cff..49cba5adcc4 100644 --- a/source/administration-guide/scale/enterprise-search.rst +++ b/source/administration-guide/scale/enterprise-search.rst @@ -1,7 +1,7 @@ Enterprise search ================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: Mattermost database search starts to show performance degradation at around 2 million posts, on a server with 32 GB RAM and 4 CPUs. If you anticipate your Mattermost server reaching more than 2.5 million posts, we recommend enabling `Elasticsearch <#elasticsearch>`__ or `AWS OpenSearch Service <#aws-opensearch-service>`__ for optimum search performance **before** reaching 3 million posts. Both tools are highly capable and can handle enterprise-scale workloads. The choice between them depends on the following factors: diff --git a/source/administration-guide/scale/high-availability-cluster-based-deployment.rst b/source/administration-guide/scale/high-availability-cluster-based-deployment.rst index df212f1b64a..be2c1342a32 100644 --- a/source/administration-guide/scale/high-availability-cluster-based-deployment.rst +++ b/source/administration-guide/scale/high-availability-cluster-based-deployment.rst @@ -1,7 +1,7 @@ High availability cluster-based deployment =========================================== -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: A high availability cluster-based deployment enables a Mattermost system to maintain service during outages and hardware failures through the use of redundant infrastructure. diff --git a/source/administration-guide/scale/opensearch-setup.rst b/source/administration-guide/scale/opensearch-setup.rst index 553b1c26796..88a9f14de49 100644 --- a/source/administration-guide/scale/opensearch-setup.rst +++ b/source/administration-guide/scale/opensearch-setup.rst @@ -1,7 +1,7 @@ AWS OpenSearch server setup ============================ -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: AWS OpenSearch Service allows you to search large volumes of data quickly, in near real-time, by creating and managing an index of post data. The indexing process can be managed from the System Console after setting up and connecting an OpenSearch server. The post index is stored on the OpenSearch server and updated constantly after new posts are made. In order to index existing posts, a bulk index of the entire post database must be generated. diff --git a/source/administration-guide/scale/performance-alerting.rst b/source/administration-guide/scale/performance-alerting.rst index c379a4ce567..86fd11cb99b 100644 --- a/source/administration-guide/scale/performance-alerting.rst +++ b/source/administration-guide/scale/performance-alerting.rst @@ -1,7 +1,7 @@ Mattermost performance alerting guide ====================================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Mattermost recommends using `Prometheus `_ and `Grafana `_ to track performance metrics of the Mattermost application servers. The purpose of this guide is to help you set up alerts on your Grafana dashboard once you've :doc:`set up system health tracking `. diff --git a/source/administration-guide/scale/performance-monitoring-metrics.rst b/source/administration-guide/scale/performance-monitoring-metrics.rst index 580319f4c05..dda3ceb64f2 100644 --- a/source/administration-guide/scale/performance-monitoring-metrics.rst +++ b/source/administration-guide/scale/performance-monitoring-metrics.rst @@ -1,7 +1,7 @@ Performance monitoring metrics ============================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Mattermost provides the following performance monitoring statistics to integrate with Prometheus and Grafana. @@ -231,7 +231,7 @@ Web app metrics Standard Go metrics -------------------- -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: The performance monitoring feature provides standard Go metrics for HTTP server runtime profiling data and system monitoring, such as: @@ -269,9 +269,6 @@ where you can replace ``localhost`` with the server name. The profiling reports Host/system metrics -------------------- -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst - :start-after: :nosearch: - From Metrics Plugin v0.7.0, you can pull metrics from `node exporter `_ targets to access network-related panels for Mattermost Calls. Frequently asked questions diff --git a/source/administration-guide/scale/push-notification-health-targets.rst b/source/administration-guide/scale/push-notification-health-targets.rst index dd22333a243..05ae64651bc 100644 --- a/source/administration-guide/scale/push-notification-health-targets.rst +++ b/source/administration-guide/scale/push-notification-health-targets.rst @@ -1,7 +1,7 @@ Push notification health targets ================================= -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: When using the `Mattermost Notification Health `_ Grafana dashboard to track different types of notifications sent from Mattermost, we recommend adhering to the following mobile push notification health targets to ensure a performant production deployment of Mattermost. diff --git a/source/administration-guide/scale/redis.rst b/source/administration-guide/scale/redis.rst index 6faf6a8504a..228c2d5b9fd 100644 --- a/source/administration-guide/scale/redis.rst +++ b/source/administration-guide/scale/redis.rst @@ -1,7 +1,7 @@ Redis ===== -.. include:: ../../_static/badges/ent-adv-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: Redis is an open-source, in-memory data structure store used as a database, cache, message broker, and streaming engine. Mattermost uses Redis as an external cache to improve performance at scale. When properly configured, Redis can help support Mattermost installations with more than 100,000 users by providing improved performance through efficient caching. diff --git a/source/administration-guide/scale/scale-to-100000-users.rst b/source/administration-guide/scale/scale-to-100000-users.rst index 37a9e8cb6fe..f056724df5e 100644 --- a/source/administration-guide/scale/scale-to-100000-users.rst +++ b/source/administration-guide/scale/scale-to-100000-users.rst @@ -1,7 +1,7 @@ Scale Mattermost up to 100000 users ==================================== -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This page describes the Mattermost reference architecture designed for the load of up to 100000 concurrent users. Unsure which reference architecture to use? See the :doc:`scaling for enterprise ` documentation for details. diff --git a/source/administration-guide/scale/scale-to-15000-users.rst b/source/administration-guide/scale/scale-to-15000-users.rst index ee118c0e250..d6181d22b06 100644 --- a/source/administration-guide/scale/scale-to-15000-users.rst +++ b/source/administration-guide/scale/scale-to-15000-users.rst @@ -1,7 +1,7 @@ Scale Mattermost up to 15000 users ================================== -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This page describes the Mattermost reference architecture designed for the load of up to 15000 concurrent users. Unsure which reference architecture to use? See the :doc:`scaling for enterprise ` documentation for details. diff --git a/source/administration-guide/scale/scale-to-2000-users.rst b/source/administration-guide/scale/scale-to-2000-users.rst index 57432c38168..4409d01c75d 100644 --- a/source/administration-guide/scale/scale-to-2000-users.rst +++ b/source/administration-guide/scale/scale-to-2000-users.rst @@ -1,7 +1,7 @@ Scale Mattermost up to 2000 users ================================= -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This page describes the Mattermost reference architecture designed for a minimum load of 100 concurrent users and up to 2000 concurrent users. Unsure which reference architecture to use? See the :doc:`scaling for enterprise ` documentation for details. diff --git a/source/administration-guide/scale/scale-to-200000-users.rst b/source/administration-guide/scale/scale-to-200000-users.rst index b0d92690e54..80d05c9988f 100644 --- a/source/administration-guide/scale/scale-to-200000-users.rst +++ b/source/administration-guide/scale/scale-to-200000-users.rst @@ -1,7 +1,7 @@ Scale Mattermost up to 200000 users ==================================== -.. include:: ../../_static/badges/ent-adv-selfhosted.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: This page describes the Mattermost reference architecture designed for the load of up to 200000 concurrent users. Unsure which reference architecture to use? See the :doc:`scaling for enterprise ` documentation for details. diff --git a/source/administration-guide/scale/scale-to-30000-users.rst b/source/administration-guide/scale/scale-to-30000-users.rst index 89904bddc58..86d0a522172 100644 --- a/source/administration-guide/scale/scale-to-30000-users.rst +++ b/source/administration-guide/scale/scale-to-30000-users.rst @@ -1,7 +1,7 @@ Scale Mattermost up to 30000 users ================================== -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This page describes the Mattermost reference architecture designed for the load of up to 30000 concurrent users. Unsure which reference architecture to use? See the :doc:`scaling for enterprise ` documentation for details. diff --git a/source/administration-guide/scale/scale-to-50000-users.rst b/source/administration-guide/scale/scale-to-50000-users.rst index e17d155aeb3..a81a152e664 100644 --- a/source/administration-guide/scale/scale-to-50000-users.rst +++ b/source/administration-guide/scale/scale-to-50000-users.rst @@ -1,7 +1,7 @@ Scale Mattermost up to 50000 users ================================== -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This page describes the Mattermost reference architecture designed for the load of up to 50000 concurrent users. Unsure which reference architecture to use? See the :doc:`scaling for enterprise ` documentation for details. diff --git a/source/administration-guide/scale/scale-to-80000-users.rst b/source/administration-guide/scale/scale-to-80000-users.rst index 0b15f31b736..6348fed301e 100644 --- a/source/administration-guide/scale/scale-to-80000-users.rst +++ b/source/administration-guide/scale/scale-to-80000-users.rst @@ -1,7 +1,7 @@ Scale Mattermost up to 80000 users ================================== -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This page describes the Mattermost reference architecture designed for the load of up to 80000 concurrent users. Unsure which reference architecture to use? See the :doc:`scaling for enterprise ` documentation for details. diff --git a/source/administration-guide/scale/scale-to-90000-users.rst b/source/administration-guide/scale/scale-to-90000-users.rst index 94dbee14620..3e24880db5c 100644 --- a/source/administration-guide/scale/scale-to-90000-users.rst +++ b/source/administration-guide/scale/scale-to-90000-users.rst @@ -1,7 +1,7 @@ Scale Mattermost up to 90000 users ================================== -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This page describes the Mattermost reference architecture designed for the load of up to 90000 concurrent users. Unsure which reference architecture to use? See the :doc:`scaling for enterprise ` documentation for details. diff --git a/source/administration-guide/scale/scaling-for-enterprise.rst b/source/administration-guide/scale/scaling-for-enterprise.rst index 16e95354841..ef10fcedcf6 100644 --- a/source/administration-guide/scale/scaling-for-enterprise.rst +++ b/source/administration-guide/scale/scaling-for-enterprise.rst @@ -1,6 +1,9 @@ Scaling for Enterprise ====================== +.. include:: ../../_static/badges/ent-plus.rst + :start-after: :nosearch: + Mattermost is designed to scale from small teams hosted on a single server to large enterprises running in cluster-based, highly available deployment configurations. - Mattermost supports any 64-bit x86 processor architecture diff --git a/source/administration-guide/upgrade-mattermost.rst b/source/administration-guide/upgrade-mattermost.rst index 6e6b9a2403d..93702c26d3e 100644 --- a/source/administration-guide/upgrade-mattermost.rst +++ b/source/administration-guide/upgrade-mattermost.rst @@ -1,6 +1,9 @@ Upgrade Mattermost ================== +.. include:: ../_static/badges/all-commercial.rst + :start-after: :nosearch: + .. toctree:: :maxdepth: 1 :hidden: diff --git a/source/administration-guide/upgrade/admin-onboarding-tasks.rst b/source/administration-guide/upgrade/admin-onboarding-tasks.rst index 3126234f32a..47a9bd79c61 100644 --- a/source/administration-guide/upgrade/admin-onboarding-tasks.rst +++ b/source/administration-guide/upgrade/admin-onboarding-tasks.rst @@ -1,7 +1,7 @@ Administrator onboarding tasks ============================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: This document provides instructions for common administrator tasks, including some recommendations on tasks to prepare your Mattermost deployment to onboard users. diff --git a/source/administration-guide/upgrade/communicate-scheduled-maintenance.rst b/source/administration-guide/upgrade/communicate-scheduled-maintenance.rst index 083129f57d6..b1b2a628540 100644 --- a/source/administration-guide/upgrade/communicate-scheduled-maintenance.rst +++ b/source/administration-guide/upgrade/communicate-scheduled-maintenance.rst @@ -1,7 +1,7 @@ Communicate scheduled maintenance best practices ================================================ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Performing scheduled maintenance on a Mattermost server with 1,000 or more users requires advanced planning and a clear communication strategy to ensure minimal disruption and maximum transparency. diff --git a/source/administration-guide/upgrade/downgrading-mattermost-server.rst b/source/administration-guide/upgrade/downgrading-mattermost-server.rst index 105b382dd85..e966934c0c7 100644 --- a/source/administration-guide/upgrade/downgrading-mattermost-server.rst +++ b/source/administration-guide/upgrade/downgrading-mattermost-server.rst @@ -1,7 +1,7 @@ Downgrade Mattermost Server =========================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: In most cases you can downgrade Mattermost Server using the same steps as :doc:`upgrading-mattermost-server`. Server binaries can be found in the :doc:`Mattermost server version archive ` documentation. diff --git a/source/administration-guide/upgrade/enterprise-roll-out-checklist.rst b/source/administration-guide/upgrade/enterprise-roll-out-checklist.rst index 03140235695..1a329c9e848 100644 --- a/source/administration-guide/upgrade/enterprise-roll-out-checklist.rst +++ b/source/administration-guide/upgrade/enterprise-roll-out-checklist.rst @@ -1,7 +1,7 @@ Enterprise roll out checklist ============================== -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This checklist is intended to serve as a guide to Enterprises who are rolling out Mattermost to thousands of users. diff --git a/source/administration-guide/upgrade/important-upgrade-notes.rst b/source/administration-guide/upgrade/important-upgrade-notes.rst index 1828a9fae84..252af637a38 100644 --- a/source/administration-guide/upgrade/important-upgrade-notes.rst +++ b/source/administration-guide/upgrade/important-upgrade-notes.rst @@ -1,6 +1,9 @@ Important Upgrade Notes ======================= +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + .. include:: ../../product-overview/common-esr-support-rst.rst We recommend reviewing the `additional upgrade notes <#additional-upgrade-notes>`__ at the bottom of this page. diff --git a/source/administration-guide/upgrade/open-source-components.rst b/source/administration-guide/upgrade/open-source-components.rst index d62631ed508..5f1d2a0bef3 100644 --- a/source/administration-guide/upgrade/open-source-components.rst +++ b/source/administration-guide/upgrade/open-source-components.rst @@ -1,7 +1,7 @@ Open Source Components ======================= -.. include:: ../../_static/badges/ent-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: The following open source components are used to provide the full benefits of Mattermost Enterprise. diff --git a/source/administration-guide/upgrade/prepare-to-upgrade-mattermost.rst b/source/administration-guide/upgrade/prepare-to-upgrade-mattermost.rst index fe0bbf53189..ddb515385fa 100644 --- a/source/administration-guide/upgrade/prepare-to-upgrade-mattermost.rst +++ b/source/administration-guide/upgrade/prepare-to-upgrade-mattermost.rst @@ -1,7 +1,7 @@ Prepare to upgrade Mattermost ============================= -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: In most cases, you can :doc:`upgrade Mattermost Server ` in a few minutes. However, the upgrade can take longer depending on several factors, including the size and complexity of your installation, and the version that you're upgrading from. When planning an upgrade, it's worth confirming that your current database and operating system version are still supported. Details can be found on our :ref:`software and hardware requirements ` page. diff --git a/source/administration-guide/upgrade/upgrade-mattermost-kubernetes-ha.rst b/source/administration-guide/upgrade/upgrade-mattermost-kubernetes-ha.rst index d8e70cecd22..afc0f9e4bf8 100644 --- a/source/administration-guide/upgrade/upgrade-mattermost-kubernetes-ha.rst +++ b/source/administration-guide/upgrade/upgrade-mattermost-kubernetes-ha.rst @@ -1,7 +1,7 @@ Upgrade Mattermost in Kubernetes and High Availability environments =================================================================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This guide provides a resilient and comprehensive strategy for upgrading Mattermost deployments managed via Kubernetes and the Mattermost Operator, including High Availability (HA) and optional Active/Active failover configurations. It outlines best practices to ensure zero downtime, minimize service risk, and provide robust fallback mechanisms. diff --git a/source/administration-guide/upgrade/upgrading-mattermost-server.rst b/source/administration-guide/upgrade/upgrading-mattermost-server.rst index b9c4b71b41e..a2a2183f3eb 100644 --- a/source/administration-guide/upgrade/upgrading-mattermost-server.rst +++ b/source/administration-guide/upgrade/upgrading-mattermost-server.rst @@ -1,7 +1,7 @@ Upgrade Mattermost Server ========================= -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: In most cases, you can upgrade Mattermost Server in a few minutes. However, the upgrade can take longer depending on several factors, including the size and complexity of your installation, and the version that you're upgrading from. @@ -231,6 +231,3 @@ Upload a license key --------------------- When Enterprise Edition is running, open **System Console > About > Editions and License** and upload your license key. - -.. include:: ../../_static/badges/academy-tarball-upgrade.rst - :start-after: :nosearch: diff --git a/source/administration-guide/upgrade/welcome-email-to-end-users.rst b/source/administration-guide/upgrade/welcome-email-to-end-users.rst index 346501ce8e6..323b18ad696 100644 --- a/source/administration-guide/upgrade/welcome-email-to-end-users.rst +++ b/source/administration-guide/upgrade/welcome-email-to-end-users.rst @@ -1,7 +1,7 @@ Welcome email to end users =========================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: To make it easy for your end users to start using Mattermost right away, we created a sample email template that you can use. diff --git a/source/deployment-guide/backup-disaster-recovery.rst b/source/deployment-guide/backup-disaster-recovery.rst index 0757d80e374..cd07ef35fad 100644 --- a/source/deployment-guide/backup-disaster-recovery.rst +++ b/source/deployment-guide/backup-disaster-recovery.rst @@ -1,7 +1,7 @@ Backup and disaster recovery ============================= -.. include:: ../_static/badges/allplans-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: Options to protect your Mattermost server from different types of failures range from simple backups to sophisticated disaster recovery deployments and automation. diff --git a/source/deployment-guide/desktop/desktop-app-deployment.rst b/source/deployment-guide/desktop/desktop-app-deployment.rst index 2ff4f2b249c..3a0b40435ab 100644 --- a/source/deployment-guide/desktop/desktop-app-deployment.rst +++ b/source/deployment-guide/desktop/desktop-app-deployment.rst @@ -1,7 +1,7 @@ Desktop App Deployment ======================= -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: The Mattermost desktop app is available for Windows, macOS, and Linux operating systems, and offers :doc:`additional functionality ` beyond the web-based experience. diff --git a/source/deployment-guide/desktop/desktop-app-managed-resources.rst b/source/deployment-guide/desktop/desktop-app-managed-resources.rst index a0238b86782..5d3fe01b68a 100644 --- a/source/deployment-guide/desktop/desktop-app-managed-resources.rst +++ b/source/deployment-guide/desktop/desktop-app-managed-resources.rst @@ -1,7 +1,7 @@ Desktop managed resources ========================= -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: The Mattermost desktop app supports managed resources. A managed resource can be any service available on the same hostname using the same protocol as the Mattermost server. diff --git a/source/deployment-guide/desktop/desktop-custom-dictionaries.rst b/source/deployment-guide/desktop/desktop-custom-dictionaries.rst index 7b40933676b..3d8a62cbc9b 100644 --- a/source/deployment-guide/desktop/desktop-custom-dictionaries.rst +++ b/source/deployment-guide/desktop/desktop-custom-dictionaries.rst @@ -1,6 +1,9 @@ Desktop App custom dictionaries =============================== +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + From Mattermost desktop app v4.7.1, custom dictionary definitions can be served through a URL on Windows and Linux. If custom dictionaries aren't specified, default dictionary definitions are obtained automatically from Chromium's CDNs (content delivery networks). On macOS, the Mattermost desktop app uses dictionary definitions provided by Apple that can't be customized. Prepare custom dictionaries diff --git a/source/deployment-guide/desktop/desktop-msi-installer-and-group-policy-install.rst b/source/deployment-guide/desktop/desktop-msi-installer-and-group-policy-install.rst index c509e6e008d..0fb145d6abc 100644 --- a/source/deployment-guide/desktop/desktop-msi-installer-and-group-policy-install.rst +++ b/source/deployment-guide/desktop/desktop-msi-installer-and-group-policy-install.rst @@ -1,6 +1,9 @@ Desktop MSI installer and group policy guide ============================================= +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + This page provides guidance on installing the desktop app MSI and use Group Policies in Windows for Mattermost Enterprise or Professional. The MSI installer package can be downloaded `here `_. .. tip:: diff --git a/source/deployment-guide/desktop/distribute-a-custom-desktop-app.rst b/source/deployment-guide/desktop/distribute-a-custom-desktop-app.rst index 1bb2573f809..955352e59c3 100644 --- a/source/deployment-guide/desktop/distribute-a-custom-desktop-app.rst +++ b/source/deployment-guide/desktop/distribute-a-custom-desktop-app.rst @@ -1,9 +1,10 @@ Distribute a custom desktop app ================================ -You can customize and distribute your own Mattermost desktop application by configuring `src/common/config/buildConfig.ts `__. - +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: +You can customize and distribute your own Mattermost desktop application by configuring `src/common/config/buildConfig.ts `__. 1. Configure the desktop app's ``buildConfig.ts`` file. You can configure the following parameters to customize the user experience, including `defaultTeams <#defaultTeams>`__, `helpLink <#helpLink>`__, and `enableServerManagement <#enableServerManagement>`__. diff --git a/source/deployment-guide/desktop/linux-desktop-install.rst b/source/deployment-guide/desktop/linux-desktop-install.rst index 2dd7cf6c772..dd8a723be02 100644 --- a/source/deployment-guide/desktop/linux-desktop-install.rst +++ b/source/deployment-guide/desktop/linux-desktop-install.rst @@ -1,6 +1,9 @@ Install desktop app on Linux ============================= +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + This page describes how to install the Mattermost desktop app on Linux. .. tab:: Ubuntu/Debian diff --git a/source/deployment-guide/desktop/silent-windows-desktop-distribution.rst b/source/deployment-guide/desktop/silent-windows-desktop-distribution.rst index 93a6097a71b..0133e0e5dcf 100644 --- a/source/deployment-guide/desktop/silent-windows-desktop-distribution.rst +++ b/source/deployment-guide/desktop/silent-windows-desktop-distribution.rst @@ -1,6 +1,9 @@ Silent Windows desktop distribution ===================================== +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + You can distribute the official Windows desktop app silently to end users, pre-configured with the server URL. Additionally, you can customize all of the :doc:`desktop app settings `, except the **Start app on login** option. .. tip:: diff --git a/source/deployment-guide/encryption-options.rst b/source/deployment-guide/encryption-options.rst index 1f5398d92ec..08ff972f277 100644 --- a/source/deployment-guide/encryption-options.rst +++ b/source/deployment-guide/encryption-options.rst @@ -1,7 +1,7 @@ Encryption options ================== -.. include:: ../_static/badges/allplans-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: Mattermost provides encryption-in-transit and encryption-at-rest capabilities. This page guides you through setting up appropriate encryption security. diff --git a/source/deployment-guide/manual-postgres-migration.rst b/source/deployment-guide/manual-postgres-migration.rst index d9734ec1d01..b9a419860b8 100644 --- a/source/deployment-guide/manual-postgres-migration.rst +++ b/source/deployment-guide/manual-postgres-migration.rst @@ -1,7 +1,7 @@ Manually migrate from MySQL to PostgreSQL ========================================= -.. include:: ../_static/badges/allplans-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: Migrating a MySQL database to PostgreSQL manually involves the following steps: diff --git a/source/deployment-guide/mobile/consider-mobile-vpn-options.rst b/source/deployment-guide/mobile/consider-mobile-vpn-options.rst index d17806dab83..afa12478e3a 100644 --- a/source/deployment-guide/mobile/consider-mobile-vpn-options.rst +++ b/source/deployment-guide/mobile/consider-mobile-vpn-options.rst @@ -1,6 +1,9 @@ Mobile VPN options =================== +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + To connect to your private network Mattermost instance, you need to set up a way to connect to your private network Mattermost instance, using an external proxy with encrypted transport through HTTPS and WSS network connections. Depending on your security policies, we recommend deploying Mattermost behind a VPN and using a `per-app VPN <#id3>`_ with your EMM provider, or a mobile VPN client. diff --git a/source/deployment-guide/mobile/deploy-mobile-apps-using-emm-provider.rst b/source/deployment-guide/mobile/deploy-mobile-apps-using-emm-provider.rst index 272a46aded1..de8f2141f81 100644 --- a/source/deployment-guide/mobile/deploy-mobile-apps-using-emm-provider.rst +++ b/source/deployment-guide/mobile/deploy-mobile-apps-using-emm-provider.rst @@ -1,7 +1,7 @@ Deploy using an EMM provider ============================= -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: You can enhance mobile security by deploying the Mattermost mobile app with `Enterprise Mobility Management (EMM) `__ and Mattermost AppConfig compatibility to secure mobile endpoints with management application configuration. diff --git a/source/deployment-guide/mobile/distribute-custom-mobile-apps.rst b/source/deployment-guide/mobile/distribute-custom-mobile-apps.rst index 3c82858a549..06bb4074737 100644 --- a/source/deployment-guide/mobile/distribute-custom-mobile-apps.rst +++ b/source/deployment-guide/mobile/distribute-custom-mobile-apps.rst @@ -1,6 +1,9 @@ Distribute a custom mobile app ================================ +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + To control the look and feel of the Mattermost mobile app requires building your own mobile apps, :doc:`hosting your own push proxy service `, and managing your own app distribution. .. note:: diff --git a/source/deployment-guide/mobile/host-your-own-push-proxy-service.rst b/source/deployment-guide/mobile/host-your-own-push-proxy-service.rst index 9f528fc2247..7748dff7164 100644 --- a/source/deployment-guide/mobile/host-your-own-push-proxy-service.rst +++ b/source/deployment-guide/mobile/host-your-own-push-proxy-service.rst @@ -1,6 +1,9 @@ Host your own push proxy service ================================= +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + Customers building their own custom mobile apps must host their own push proxy service using one of the following methods: - Compile your own MPNS from the `open source repository `__. diff --git a/source/deployment-guide/mobile/mobile-app-deployment.rst b/source/deployment-guide/mobile/mobile-app-deployment.rst index cbdb5402ac8..e982c7a43f5 100644 --- a/source/deployment-guide/mobile/mobile-app-deployment.rst +++ b/source/deployment-guide/mobile/mobile-app-deployment.rst @@ -1,6 +1,9 @@ Mobile App Deployment ====================== +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + The Mattermost mobile app is available for iPhone and Android devices, and provides a native experience on the go, ensuring you can stay connected and productive from anywhere. Learn more about :ref:`mobile app software requirements `, :doc:`available releases and server compatibility `, :doc:`what's changed across releases `, and :doc:`commonly asked questions `. diff --git a/source/deployment-guide/mobile/mobile-security-features.rst b/source/deployment-guide/mobile/mobile-security-features.rst index 83034ffe4ca..6ab27fb4db1 100644 --- a/source/deployment-guide/mobile/mobile-security-features.rst +++ b/source/deployment-guide/mobile/mobile-security-features.rst @@ -1,7 +1,7 @@ Mobile security features ======================== -.. include:: ../../_static/badges/ent-adv-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: This document outlines the key security features implemented in the mobile application, explains the significance of each control, and details our continuous security practices to maintain an up-to-date security posture. diff --git a/source/deployment-guide/mobile/mobile-troubleshooting.rst b/source/deployment-guide/mobile/mobile-troubleshooting.rst index 2f7d659ead8..0c510fbaaeb 100644 --- a/source/deployment-guide/mobile/mobile-troubleshooting.rst +++ b/source/deployment-guide/mobile/mobile-troubleshooting.rst @@ -1,6 +1,9 @@ Mobile deployment troubleshooting ================================== +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + I keep getting a message "Cannot connect to the server. Please check your server URL and internet connection." -------------------------------------------------------------------------------------------------------------- diff --git a/source/deployment-guide/mobile/secure-mobile-file-storage.rst b/source/deployment-guide/mobile/secure-mobile-file-storage.rst index e65b137cf14..58467df3c51 100644 --- a/source/deployment-guide/mobile/secure-mobile-file-storage.rst +++ b/source/deployment-guide/mobile/secure-mobile-file-storage.rst @@ -1,7 +1,7 @@ Secure file storage ==================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This document outlines the security measures governing file storage in the Mattermost mobile app for iOS and Android. It describes how files are stored, accessed, and protected within the application container, addressing concerns related to sensitive data on mobile devices. The objective is to ensure that only authorized personnel can view, access, or share such data while preventing exposure to unauthorized parties and ensuring isolation from third-party applications. diff --git a/source/deployment-guide/postgres-migration-assist-tool.rst b/source/deployment-guide/postgres-migration-assist-tool.rst index b7a6c04a745..6bde522aa50 100644 --- a/source/deployment-guide/postgres-migration-assist-tool.rst +++ b/source/deployment-guide/postgres-migration-assist-tool.rst @@ -1,7 +1,7 @@ Automated PostgreSQL migration =============================== -.. include:: ../_static/badges/allplans-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: Migrating databases can be a daunting task, and it can be easy to overlook or misinterpret some of the required steps if you haven't performed a migration before. Our ``migration-assist`` tool provides an efficient, error-free migration experience that automates the :doc:`tasks to be executed `, even in air-gapped deployment environments. diff --git a/source/deployment-guide/postgres-migration.rst b/source/deployment-guide/postgres-migration.rst index 830ae98f1ba..f73f1dccac3 100644 --- a/source/deployment-guide/postgres-migration.rst +++ b/source/deployment-guide/postgres-migration.rst @@ -1,7 +1,7 @@ Migration guidelines from MySQL to PostgreSQL ============================================= -.. include:: ../_static/badges/allplans-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: From Mattermost v8.0, :ref:`PostgreSQL ` is our database of choice for Mattermost to enhance the platform’s performance and capabilities. Recognizing the importance of supporting the community members who are interested in migrating from a MySQL database, we have taken proactive measures to provide guidance and best practices. diff --git a/source/deployment-guide/quick-start-evaluation.rst b/source/deployment-guide/quick-start-evaluation.rst index 3f891e413b6..436ec95eae3 100644 --- a/source/deployment-guide/quick-start-evaluation.rst +++ b/source/deployment-guide/quick-start-evaluation.rst @@ -102,7 +102,7 @@ Deployment options 2. Access Mattermost at ``http://localhost:8065`` - 3. Create your first admin account when prompted. + 3. Create your first admin account when prompted. Next steps ---------- diff --git a/source/deployment-guide/server/deploy-kubernetes.rst b/source/deployment-guide/server/deploy-kubernetes.rst index 4cc24161b4e..d9d65bf75cb 100644 --- a/source/deployment-guide/server/deploy-kubernetes.rst +++ b/source/deployment-guide/server/deploy-kubernetes.rst @@ -1,7 +1,7 @@ Deploy Mattermost on Kubernetes =============================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Mattermost server can be deployed on various Kubernetes platforms, providing a scalable and robust infrastructure for your team communication needs. This guide covers deployment options for major cloud providers and general Kubernetes installations. diff --git a/source/deployment-guide/server/image-proxy.rst b/source/deployment-guide/server/image-proxy.rst index 653c0d4847a..1ceed74345d 100644 --- a/source/deployment-guide/server/image-proxy.rst +++ b/source/deployment-guide/server/image-proxy.rst @@ -1,7 +1,7 @@ (Optional) Use an Image proxy ============================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: When enabled, the image proxy needs to be publicly accessible to both the Mattermost client and server. diff --git a/source/deployment-guide/server/pre-authentication-secrets.rst b/source/deployment-guide/server/pre-authentication-secrets.rst index 2c7252c8cb6..0038d6278e2 100644 --- a/source/deployment-guide/server/pre-authentication-secrets.rst +++ b/source/deployment-guide/server/pre-authentication-secrets.rst @@ -1,7 +1,7 @@ Pre-authentication secrets ========================== -.. include:: ../../_static/badges/ent-adv-selfhosted.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: From Mattermost server v10.12 and mobile v2.32, Mattermost deployments can use a reverse proxy to validate pre-authentication secrets before allowing desktop and mobile requests to reach the Mattermost server. This adds an additional security layer by checking for the ``X-Mattermost-Preauth-Secret`` header. diff --git a/source/deployment-guide/server/prepare-mattermost-mysql-database.rst b/source/deployment-guide/server/prepare-mattermost-mysql-database.rst index 3ea248281c3..a2879247441 100644 --- a/source/deployment-guide/server/prepare-mattermost-mysql-database.rst +++ b/source/deployment-guide/server/prepare-mattermost-mysql-database.rst @@ -3,7 +3,7 @@ Prepare your Mattermost MySQL database ====================================== -.. include:: ../../_static/badges/allplans-selfhosted.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: .. important:: diff --git a/source/deployment-guide/software-hardware-requirements.rst b/source/deployment-guide/software-hardware-requirements.rst index bad5d187bbe..463bea644e1 100644 --- a/source/deployment-guide/software-hardware-requirements.rst +++ b/source/deployment-guide/software-hardware-requirements.rst @@ -1,9 +1,6 @@ Software and hardware requirements ================================== -.. include:: ../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - This guide outlines minimum software and hardware requirements for deploying Mattermost. Requirements may vary based on utilization and observing performance of pilot projects is recommended prior to scale out. Deployment overview diff --git a/source/deployment-guide/transport-encryption.rst b/source/deployment-guide/transport-encryption.rst index 93e7eea9b42..cce2766c356 100644 --- a/source/deployment-guide/transport-encryption.rst +++ b/source/deployment-guide/transport-encryption.rst @@ -1,7 +1,7 @@ Configuring transport encryption ================================= -.. include:: ../_static/badges/ent-selfhosted.rst +.. include:: ../_static/badges/ent-plus.rst :start-after: :nosearch: The components of the Mattermost setup are shown in the following diagram, including the transport encryption used. Aside from the encryption between the nodes of the Mattermost cluster, all transports rely on TLS encryption. @@ -16,9 +16,6 @@ The components of the Mattermost setup are shown in the following diagram, inclu Configuring proxy to Mattermost transport encryption ----------------------------------------------------- -.. include:: ../_static/badges/ent-selfhosted.rst - :start-after: :nosearch: - Mattermost is able to encrypt the traffic between the proxy and the application server using TLS. Prerequisites @@ -130,9 +127,6 @@ Finally, on the **NGINX server**, reload the configuration to ensure that reques Configuring database transport encryption ------------------------------------------ -.. include:: ../_static/badges/ent-selfhosted.rst - :start-after: :nosearch: - Mattermost is able to encrypt the traffic between the database and the application using TLS. This guide describes the setup steps for a single, separate MySQL server. Prerequisites @@ -174,7 +168,7 @@ Any connection to the MySQL server must now be made with secure transport enable Last but not least, restart the server and confirm it is up and running: - .. code-block:: sh +.. code-block:: sh systemctl restart mysql systemctl status mysql @@ -252,9 +246,6 @@ Once complete, restart the Mattermost server and ensure the system is operationa Configuring cluster transport encryption ----------------------------------------- -.. include:: ../_static/badges/ent-selfhosted.rst - :start-after: :nosearch: - Mattermost is able to encrypt the messages sent within the cluster of a deployment using SSH tunneling. The guide walks through the deployment of this solution on Ubuntu 20.04, but it can be adapted for any Linux operating system. While this document only describes the configuration of a three-node cluster, it is by no means limited to that number. diff --git a/source/end-user-guide/agents.rst b/source/end-user-guide/agents.rst index a2cee43f987..99b5080b485 100644 --- a/source/end-user-guide/agents.rst +++ b/source/end-user-guide/agents.rst @@ -1,7 +1,7 @@ AI Agents =========== -.. include:: ../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: .. note:: diff --git a/source/end-user-guide/collaborate/access-your-workspace.rst b/source/end-user-guide/collaborate/access-your-workspace.rst index 827ffffc5d4..de019d6dddd 100644 --- a/source/end-user-guide/collaborate/access-your-workspace.rst +++ b/source/end-user-guide/collaborate/access-your-workspace.rst @@ -1,6 +1,9 @@ Access your workspace ===================== +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + Access your Mattermost instance with your credentials using a web browser, the desktop app, or the mobile app for iOS or Android. Depending on how Mattermost is configured, you'll log in using your email address, username, or single sign-on (SSO) username, and your password. See the :doc:`Client availability ` documentation to learn which features are available on different Mattermost clients. .. tip:: diff --git a/source/end-user-guide/collaborate/agents-context-management.rst b/source/end-user-guide/collaborate/agents-context-management.rst index 57ddc0d9908..b67bf58398e 100644 --- a/source/end-user-guide/collaborate/agents-context-management.rst +++ b/source/end-user-guide/collaborate/agents-context-management.rst @@ -1,7 +1,7 @@ Agents context management ========================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Mattermost Agents are designed to handle context efficiently, ensuring that only necessary information is sent to the Large Language Model (LLM) for generating accurate responses. This document outlines how Agents process and include relevant context. The company name, the server name, and the time are always passed to the LLM to ensure accurate and contextually relevant responses. diff --git a/source/end-user-guide/collaborate/archive-unarchive-channels.rst b/source/end-user-guide/collaborate/archive-unarchive-channels.rst index ff2a2f232a3..d678000dea7 100644 --- a/source/end-user-guide/collaborate/archive-unarchive-channels.rst +++ b/source/end-user-guide/collaborate/archive-unarchive-channels.rst @@ -1,7 +1,7 @@ Archive and unarchive channels ============================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Archive a channel diff --git a/source/end-user-guide/collaborate/audio-and-screensharing.rst b/source/end-user-guide/collaborate/audio-and-screensharing.rst index 361ef7fffdf..8263d8f3a0a 100644 --- a/source/end-user-guide/collaborate/audio-and-screensharing.rst +++ b/source/end-user-guide/collaborate/audio-and-screensharing.rst @@ -1,6 +1,9 @@ Audio and Screensharing ======================= +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + Mattermost Calls offers native real-time chat, self-hosted audio calls, and screen sharing within your own network, enabling secure, effective team communication and collaboration. Learn more about :doc:`deploying Mattermost Calls ` in a self-hosted environment and :doc:`making calls ` with Mattermost. With calls and screen sharing, Mattermost ensures that communications remain uninterrupted, even during maintenance or outages, and scales effortlessly to meet your team’s growing needs, safeguarding the integrity of mission-critical operations. @@ -12,13 +15,13 @@ Functionality includes: - **Screen Share**: Share your screen during calls to collaborate visually on tasks, review documents, or troubleshoot live issues. - **Chat/Messaging During Calls**: Exchange messages alongside audio communication to enhance clarity, drop links, and provide visual context. - **Search Chat History Post-Call**: Access in-call messages later to retain decision trails, links, and key points discussed. -- **Host Controls**: Manage participants, mute/unmute, and control the flow of conversations during conferences for structured engagements. *(Professional, Enterprise)* -- **Call Recording**: Record voice sessions for review, compliance, or sharing with unavailable team members. *(Enterprise)* -- **Call Transcription**: Convert spoken content into text to support documentation, compliance, and improved accessibility. *(Enterprise)* -- **Live Captioning**: Provide real-time subtitles for inclusivity, accessibility, and support in noisy or multilingual environments. *(Enterprise)* -- **AI Call Summarization**: Automatically generate concise summaries of calls to save time and preserve key outcomes. *(Enterprise)* -- **Advanced Security Controls**: Enforce stricter encryption, access policies, and controls for high-assurance environments. *(Enterprise)* -- **High Availability**: Maintain service continuity through system failover and backup call paths. *(Enterprise)* +- **Host Controls**: Manage participants, mute/unmute, and control the flow of conversations during conferences for structured engagements. +- **Call Recording**: Record voice sessions for review, compliance, or sharing with unavailable team members. *(Enterprise, Enterprise Advanced)* +- **Call Transcription**: Convert spoken content into text to support documentation, compliance, and improved accessibility. *(Enterprise, Enterprise Advanced)* +- **Live Captioning**: Provide real-time subtitles for inclusivity, accessibility, and support in noisy or multilingual environments. *(Enterprise, Enterprise Advanced)* +- **AI Call Summarization**: Automatically generate concise summaries of calls to save time and preserve key outcomes. *(Enterprise, Enterprise Advanced)* +- **Advanced Security Controls**: Enforce stricter encryption, access policies, and controls for high-assurance environments. *(Enterprise, Enterprise Advanced)* +- **High Availability**: Maintain service continuity through system failover and backup call paths. *(Enterprise, Enterprise Advanced)* Video conferencing integrations ------------------------------- diff --git a/source/end-user-guide/collaborate/browse-channels.rst b/source/end-user-guide/collaborate/browse-channels.rst index 1fafaa28056..4be5dee086c 100644 --- a/source/end-user-guide/collaborate/browse-channels.rst +++ b/source/end-user-guide/collaborate/browse-channels.rst @@ -1,7 +1,7 @@ Browse channels ================ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: .. tab:: Web/Desktop @@ -49,9 +49,7 @@ Browse channels You can filter the list of channels by public, archived, or shared channels. -.. tip:: - - Want to see all of the channels you're already a member of, or can't find a specific private channel? Using a browser or the desktop app, select **Find Channel** in the channel sidebar to see all of the channels you're currently a member of across all of your teams, including public and private channels, direct and group messages, channels with unread messages, and threads. Channels you have muted aren't included in results. +Want to see all of the channels you're already a member of, or can't find a specific private channel? Using a browser or the desktop app, select **Find Channel** in the channel sidebar to see all of the channels you're currently a member of across all of your teams, including public and private channels, direct and group messages, channels with unread messages, and threads. Channels you have muted aren't included in results. Revisit recent channels ----------------------- diff --git a/source/end-user-guide/collaborate/channel-header-purpose.rst b/source/end-user-guide/collaborate/channel-header-purpose.rst index d3fa4ed73a9..b2bbb387d2c 100644 --- a/source/end-user-guide/collaborate/channel-header-purpose.rst +++ b/source/end-user-guide/collaborate/channel-header-purpose.rst @@ -1,7 +1,7 @@ Communicate a channel's focus and scope ======================================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Every channel in Mattermost serves a purpose and exists for a reason. You can communicate a channel's focus and scope in 3 ways: diff --git a/source/end-user-guide/collaborate/channel-naming-conventions.rst b/source/end-user-guide/collaborate/channel-naming-conventions.rst index d844f5dc259..3dec3f38539 100644 --- a/source/end-user-guide/collaborate/channel-naming-conventions.rst +++ b/source/end-user-guide/collaborate/channel-naming-conventions.rst @@ -1,7 +1,7 @@ Channel naming conventions ========================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: All organizations are different and have different communication needs. The importance of organizing your conversations increases as your user base grows. The following are ideas for how you might want to name, group, and structure your channels. If you change your mind about a channel's name, you can :doc:`rename it `. diff --git a/source/end-user-guide/collaborate/channel-types.rst b/source/end-user-guide/collaborate/channel-types.rst index aae1ccb609e..7d972f7836b 100644 --- a/source/end-user-guide/collaborate/channel-types.rst +++ b/source/end-user-guide/collaborate/channel-types.rst @@ -1,7 +1,7 @@ Channel types ============= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Channels are used to organize conversations across different topics. The channels you're a member of display in the left pane. Learn how to create channels by visiting the :doc:`create channels ` documentation. diff --git a/source/end-user-guide/collaborate/client-availability.rst b/source/end-user-guide/collaborate/client-availability.rst index b5c62689f80..58d8c7de4f0 100644 --- a/source/end-user-guide/collaborate/client-availability.rst +++ b/source/end-user-guide/collaborate/client-availability.rst @@ -1,6 +1,9 @@ Client Availability =================== +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + The following tables highlight the end user features of Mattermost and their support across Web, Desktop, and Mobile applications (iOS and Android). Messages diff --git a/source/end-user-guide/collaborate/collaborate-within-channels.rst b/source/end-user-guide/collaborate/collaborate-within-channels.rst index 829d099a445..b6b1ddf4445 100644 --- a/source/end-user-guide/collaborate/collaborate-within-channels.rst +++ b/source/end-user-guide/collaborate/collaborate-within-channels.rst @@ -1,7 +1,7 @@ Collaborate within channels =========================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Channels are where you connect, collaborate, and communicate with your team about various topics or projects. Use channels to organize conversations across different topics. as you're :doc:`sending messages `, :doc:`replying to messages `, and :ref:`participating in conversation threads `. diff --git a/source/end-user-guide/collaborate/collaborate-within-connected-microsoft-teams.rst b/source/end-user-guide/collaborate/collaborate-within-connected-microsoft-teams.rst index 4cb668f1cca..f3c89dabc65 100644 --- a/source/end-user-guide/collaborate/collaborate-within-connected-microsoft-teams.rst +++ b/source/end-user-guide/collaborate/collaborate-within-connected-microsoft-teams.rst @@ -1,7 +1,7 @@ Collaborate within Microsoft Teams =================================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: The Mattermost for Microsoft Teams integration enables you to break through siloes in a mixed Mattermost and Teams environment by forwarding real-time chat notifications from Teams to Mattermost. @@ -18,7 +18,6 @@ Connect your Mattermost account to your Microsoft Teams account .. note:: Your System Administrator must install and enable the :doc:`Mattermost for Microsoft Teams integration ` and ensure :ref:`support for notifications is enabled ` in order for you to connect your account and recieve chat notifications. - Once the integration is installed and configured by a System Administrator, you can connect your Mattermost user account to your Microsoft Teams account. You only need to complete this step once. diff --git a/source/end-user-guide/collaborate/communicate-with-messages.rst b/source/end-user-guide/collaborate/communicate-with-messages.rst index 5d30bcb4fa6..d3c1fd366d4 100644 --- a/source/end-user-guide/collaborate/communicate-with-messages.rst +++ b/source/end-user-guide/collaborate/communicate-with-messages.rst @@ -1,7 +1,7 @@ Communicate with messages and threads ===================================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: :doc:`Sending messages `, :doc:`replying to messages `, and :ref:`participating in discussion threads ` are important ways to keep conversations active with your team. diff --git a/source/end-user-guide/collaborate/convert-group-messages.rst b/source/end-user-guide/collaborate/convert-group-messages.rst index 6a9e4e7b155..4eb2e67abb3 100644 --- a/source/end-user-guide/collaborate/convert-group-messages.rst +++ b/source/end-user-guide/collaborate/convert-group-messages.rst @@ -1,7 +1,7 @@ Convert group messages to private channels ========================================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: From Mattermost v9.1, you can change the members of your group conversation by converting the group message to a private channel. When a group message is converted to private, its history and membership are preserved. Membership in a private channel remains as invitation only. diff --git a/source/end-user-guide/collaborate/convert-public-channels.rst b/source/end-user-guide/collaborate/convert-public-channels.rst index a467b4304f2..9dafc9c6491 100644 --- a/source/end-user-guide/collaborate/convert-public-channels.rst +++ b/source/end-user-guide/collaborate/convert-public-channels.rst @@ -1,7 +1,7 @@ Convert public channels to private channels =========================================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: You must be a system admin or team admin to convert public channels to private channels. When a channel is converted from public to private, its history and membership are preserved. Membership in a private channel remains as invitation only. Publicly-shared files remain accessible to anyone with the link. diff --git a/source/end-user-guide/collaborate/create-channels.rst b/source/end-user-guide/collaborate/create-channels.rst index 4facc5e7f99..1246d94ec9f 100644 --- a/source/end-user-guide/collaborate/create-channels.rst +++ b/source/end-user-guide/collaborate/create-channels.rst @@ -1,7 +1,7 @@ Create channels =============== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Anyone can create public channels, private channels, direct messages, and group messages unless the system admin has :doc:`restricted permissions to do so using advanced permissions `. Enterprise system administrators can also configure channels as :ref:`read-only `. diff --git a/source/end-user-guide/collaborate/display-channel-banners.rst b/source/end-user-guide/collaborate/display-channel-banners.rst index d29ac650d65..327c29f2e6e 100644 --- a/source/end-user-guide/collaborate/display-channel-banners.rst +++ b/source/end-user-guide/collaborate/display-channel-banners.rst @@ -1,7 +1,7 @@ Display channel banners ======================= -.. include:: ../../_static/badges/ent-adv-cloud-selfhosted.rst +.. include:: ../../_static/badges/ent-adv.rst :start-after: :nosearch: From Mattermost v10.9, users with admin permissions can enable channel banners to remind channel members about being diligent to avoid data spillage in channels that aren't intended for classified or sensitive information. These non-dismissible banners can be styled using Markdown and are visible across all Mattermost clients, including web browsers, the desktop app, and the mobile app. diff --git a/source/end-user-guide/collaborate/favorite-channels.rst b/source/end-user-guide/collaborate/favorite-channels.rst index 4adc703595d..703f262d4b1 100644 --- a/source/end-user-guide/collaborate/favorite-channels.rst +++ b/source/end-user-guide/collaborate/favorite-channels.rst @@ -1,13 +1,13 @@ Mark channels as favorites ========================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: You can mark public and private channels, as well as direct and group messages as favorites so they're easy to access later. Favorite channels display in the **Favorites** category in the channel sidebar. - .. image:: ../../images/favorites-list-sidebar.png - :alt: Favorite channels display in the channel sidebar. +.. image:: ../../images/favorites-list-sidebar.png + :alt: Favorite channels display in the channel sidebar. To mark a channel as a **Favorite**: @@ -23,9 +23,7 @@ To mark a channel as a **Favorite**: To remove a channel from your **Favorites** list, select the |favorite-icon| icon again. - .. tip:: - - - Alternatively to mark channels as favorites, select the channel name, select the **View Info** |channel-info| icon, then select **Favorite** in the right pane. Select **Favorited** to remove the channel from your list of favorites. + Alternatively to mark channels as favorites, select the channel name, select the **View Info** |channel-info| icon, then select **Favorite** in the right pane. Select **Favorited** to remove the channel from your list of favorites. .. tab:: Mobile @@ -47,8 +45,6 @@ To mark a channel as a **Favorite**: :alt: Tap on Favorite to mark the channel as one of the favorites. :scale: 30 -.. tip:: - Alternatively, you can mark a favorite channel as follows: 1. In a channel, tap the channel name at the top of the screen. diff --git a/source/end-user-guide/collaborate/format-messages.rst b/source/end-user-guide/collaborate/format-messages.rst index 2b167a7f211..0b1a3b5e83b 100644 --- a/source/end-user-guide/collaborate/format-messages.rst +++ b/source/end-user-guide/collaborate/format-messages.rst @@ -1,10 +1,7 @@ Format messages =============== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - -.. include:: ../../_static/badges/academy-message-formatting.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Use the messaging formatting toolbar @@ -688,3 +685,6 @@ Math Formulas .. image:: ../../images/latex-codeblock.png :alt: A LaTeX code block math equation sample. + +.. include:: ../../_static/badges/academy-message-formatting.rst + :start-after: :nosearch: diff --git a/source/end-user-guide/collaborate/forward-messages.rst b/source/end-user-guide/collaborate/forward-messages.rst index 34d39154cf2..82c2d4cc73b 100644 --- a/source/end-user-guide/collaborate/forward-messages.rst +++ b/source/end-user-guide/collaborate/forward-messages.rst @@ -1,7 +1,7 @@ Forward messages ================ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: From Mattermost v7.2, using a web browser or the desktop app, you can forward messages in public channels to other public channels. From Mattermost v7.5, you can also forward messages from bots and webhooks. diff --git a/source/end-user-guide/collaborate/install-android-app.rst b/source/end-user-guide/collaborate/install-android-app.rst index 1c7e26ebdad..9f4ed64af1c 100644 --- a/source/end-user-guide/collaborate/install-android-app.rst +++ b/source/end-user-guide/collaborate/install-android-app.rst @@ -1,6 +1,9 @@ Install the Mattermost Android mobile app ========================================= +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + Take Mattermost wherever you go by `installing the Mattermost mobile app `_ on your Android mobile device running Android 7.0 or later. 1. On your device, visit the Play Store. diff --git a/source/end-user-guide/collaborate/install-desktop-app.rst b/source/end-user-guide/collaborate/install-desktop-app.rst index c495a2f0520..1f87eef136c 100644 --- a/source/end-user-guide/collaborate/install-desktop-app.rst +++ b/source/end-user-guide/collaborate/install-desktop-app.rst @@ -1,6 +1,9 @@ Install the Mattermost desktop app ================================== +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + Download and install the Mattermost desktop app `for macOS from the App Store `_, `for Windows from the Microsoft Store `_, or by :doc:`using a package manager (Linux) `. When new desktop app releases become available, your desktop app is automatically updated. We strongly recommend installing the desktop app on a local drive. Network shares aren't supported. diff --git a/source/end-user-guide/collaborate/install-ios-app.rst b/source/end-user-guide/collaborate/install-ios-app.rst index c2f91e7e5df..27017afe390 100644 --- a/source/end-user-guide/collaborate/install-ios-app.rst +++ b/source/end-user-guide/collaborate/install-ios-app.rst @@ -1,6 +1,9 @@ Install the Mattermost iOS mobile app ===================================== +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + Take Mattermost wherever you go by `installing the Mattermost mobile app `_ on your iOS mobile device running iOS 12.1 or later. 1. On your device, visit the App Store. diff --git a/source/end-user-guide/collaborate/invite-people.rst b/source/end-user-guide/collaborate/invite-people.rst index df5891c3872..4eef3cabe14 100644 --- a/source/end-user-guide/collaborate/invite-people.rst +++ b/source/end-user-guide/collaborate/invite-people.rst @@ -1,7 +1,7 @@ Invite people to your workspace ================================ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Anyone can invite people to Mattermost teams and channels, unless your system admin has :doc:`disabled ` your ability to do so. diff --git a/source/end-user-guide/collaborate/join-leave-channels.rst b/source/end-user-guide/collaborate/join-leave-channels.rst index a3a3d7d8efd..8c4a15ad21a 100644 --- a/source/end-user-guide/collaborate/join-leave-channels.rst +++ b/source/end-user-guide/collaborate/join-leave-channels.rst @@ -1,7 +1,7 @@ Join and leave channels ======================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Join a channel diff --git a/source/end-user-guide/collaborate/keyboard-accessibility.rst b/source/end-user-guide/collaborate/keyboard-accessibility.rst index 41ada363bea..798aa1f3cf9 100644 --- a/source/end-user-guide/collaborate/keyboard-accessibility.rst +++ b/source/end-user-guide/collaborate/keyboard-accessibility.rst @@ -1,7 +1,7 @@ Keyboard accessibility ======================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Navigational keyboard shortcuts help you use Mattermost in a web browser or the desktop app without needing a mouse. Below is a list of supported accessibility shortcuts. diff --git a/source/end-user-guide/collaborate/keyboard-shortcuts.rst b/source/end-user-guide/collaborate/keyboard-shortcuts.rst index de1af9ad2d8..1cef276c68f 100644 --- a/source/end-user-guide/collaborate/keyboard-shortcuts.rst +++ b/source/end-user-guide/collaborate/keyboard-shortcuts.rst @@ -1,6 +1,9 @@ Mattermost keyboard shortcuts ============================= +.. include:: ../../_static/badges/all-commercial.rst + :start-after: :nosearch: + .. toctree:: :maxdepth: 1 :hidden: @@ -8,9 +11,6 @@ Mattermost keyboard shortcuts Keyboard accessibility -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Mattermost keyboard shortcuts help you make a more efficient use of your keyboard when using Mattermost in a web browser or the desktop app. .. tip:: diff --git a/source/end-user-guide/collaborate/learn-about-roles.rst b/source/end-user-guide/collaborate/learn-about-roles.rst index 6e99dfbae9a..fe104d0732b 100644 --- a/source/end-user-guide/collaborate/learn-about-roles.rst +++ b/source/end-user-guide/collaborate/learn-about-roles.rst @@ -1,7 +1,7 @@ Learn about Mattermost roles ============================ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: There are 6 types of user roles with different permission levels in Mattermost: `system admin <#system-admin>`__, `team admin <#team-admin>`__, `channel admin <#channel-admin>`__, `member <#member>`__, `guest <#guest>`__, and `deactivated <#deactivated>`__. diff --git a/source/end-user-guide/collaborate/log-out.rst b/source/end-user-guide/collaborate/log-out.rst index 7a236b52fd0..3a1dcb3811c 100644 --- a/source/end-user-guide/collaborate/log-out.rst +++ b/source/end-user-guide/collaborate/log-out.rst @@ -1,7 +1,7 @@ Log out of Mattermost ===================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: You can log out of Mattermost from your profile picture. Select **Log Out** to log out of all teams on the server. diff --git a/source/end-user-guide/collaborate/make-calls.rst b/source/end-user-guide/collaborate/make-calls.rst index 710427f7dc1..974877e6b7e 100644 --- a/source/end-user-guide/collaborate/make-calls.rst +++ b/source/end-user-guide/collaborate/make-calls.rst @@ -1,7 +1,7 @@ Make calls ============ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Using a web browser, the desktop app, or the mobile app, you can `join a call <#join-a-call>`__ or `start a call <#start-a-call>`__, `share your screen <#share-screen>`__, raise your hand, `react using emojis <#react-using-emojis>`__ during a call, `chat in a thread <#chat-in-a-call>`__, and continue working in Mattermost during a call. @@ -13,9 +13,6 @@ Using a web browser, the desktop app, or the mobile app, you can `join a call <# - Enterprise customers can also `record calls <#record-a-call>`__, enable :ref:`live text captions ` during calls, and `transcribe recorded calls <#transcribe-recorded-calls>`__. We recommend that Enterprise self-hosted customers looking for group calls beyond 50 concurrent users consider using the :ref:`dedicated rtcd service `. - Mattermost Cloud users can start calling right out of the box. For Mattermost self-hosted deployments, System admins need to enable and configure the plugin :ref:`using the System Console `. -.. include:: ../../_static/badges/academy-calls.rst - :start-after: :nosearch: - Join a call ----------- @@ -59,9 +56,6 @@ Start a call Host controls ------------- -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - From Mattermost v9.9, and Mattermost mobile v2.17, call host controls are available and include the ability to `transfer host duties <#transfer-host-duties>`__, `remove call participants <#remove-call-participants>`__, `stop a screen share <#stop-a-screen-share>`__, `mute or unmute participants <#mute-or-nmute-participants>`__, `lower raised hands <#lower-raised-hands>`__, and `end the call for everyone <#end-the-call-for-everyone>`__. Host controls are available to call hosts and admins in both the call widget by selecting the **More** |more-icon| icon next to a participant's name, and in the expanded the call window as hosts hover over a call participant in the list. @@ -169,7 +163,7 @@ A chat thread is created automatically for every new call. Record a call ------------- -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: From Mattermost v7.7, if you're the host of a meeting, you can record the call, unless your system admin has :ref:`disabled the host's ability to do so `. @@ -214,7 +208,7 @@ To record a call: Live captions during calls --------------------------------- -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: From Mattermost v9.7, and Mattermost mobile app v.2.16, all call participants can display real-time text captions by selecting the **More** |more-icon| icon and **Show live captions** when the call is being recorded, and when :ref:`live captions are enabled `. Live captions can be helpful in cases where noise is preventing you from hearing the audio of participants clearly. @@ -229,7 +223,7 @@ By default, live captions display in English. Your Mattermost system admin can : Transcribe recorded calls -------------------------------- -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: From Mattermost v9.4, and Mattermost mobile app v.2.13, call recordings can include text captions, and a transcription text file can be generated, unless your system admin has :ref:`disabled the ability to transcribe call recordings `. diff --git a/source/end-user-guide/collaborate/manage-channel-bookmarks.rst b/source/end-user-guide/collaborate/manage-channel-bookmarks.rst index ca4e8b2ebf8..b8a9ff594a9 100644 --- a/source/end-user-guide/collaborate/manage-channel-bookmarks.rst +++ b/source/end-user-guide/collaborate/manage-channel-bookmarks.rst @@ -1,7 +1,7 @@ Manage channel bookmarks ========================= -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: From Mattermost v10.1, you can bookmark up to 50 links or files to the top of channels for quick and easy access, unless your system admin has disabled your ability to do so. Bookmarks display directly under channel headers. Files added as channel bookmarks are also :doc:`searchable ` in Mattermost. diff --git a/source/end-user-guide/collaborate/manage-channel-members.rst b/source/end-user-guide/collaborate/manage-channel-members.rst index 804ffa46d48..2ae22ba7532 100644 --- a/source/end-user-guide/collaborate/manage-channel-members.rst +++ b/source/end-user-guide/collaborate/manage-channel-members.rst @@ -3,7 +3,7 @@ Manage channel members .. The Add People option on mobile isn't yet supported, so this page doesn't yet include mobile app details. -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Add members to a channel diff --git a/source/end-user-guide/collaborate/mark-channels-unread.rst b/source/end-user-guide/collaborate/mark-channels-unread.rst index 1493b917f68..15a702a0892 100644 --- a/source/end-user-guide/collaborate/mark-channels-unread.rst +++ b/source/end-user-guide/collaborate/mark-channels-unread.rst @@ -1,7 +1,7 @@ Mark messages as unread ======================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: If you read messages in a channel, but don't have time to address them right away, you can mark that channel as unread. Hover over the channel name in the channel sidebar, select the **More** |more-icon-vertical| option, then select **Mark as Unread**. diff --git a/source/end-user-guide/collaborate/mark-messages-unread.rst b/source/end-user-guide/collaborate/mark-messages-unread.rst index 3b9dcb55114..83eab9d5b08 100644 --- a/source/end-user-guide/collaborate/mark-messages-unread.rst +++ b/source/end-user-guide/collaborate/mark-messages-unread.rst @@ -1,7 +1,7 @@ Mark messages as unread ======================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: If you read a message, but don't have time to address it right away, you can mark that message as unread. Marking a message as unread displays the channel as bold in the channel sidebar, and groups the message with all other unread messages. diff --git a/source/end-user-guide/collaborate/mention-people.rst b/source/end-user-guide/collaborate/mention-people.rst index 962c937b5f2..42c5e05ef0e 100644 --- a/source/end-user-guide/collaborate/mention-people.rst +++ b/source/end-user-guide/collaborate/mention-people.rst @@ -1,7 +1,7 @@ Mention people in messages ========================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: When you want to get the attention of specific Mattermost users, you can use @mentions. Mattermost supports the following types of @mentions: @@ -66,7 +66,7 @@ You can ignore channel-wide mentions in specific channels by enabling the **Chan @groupname ---------- -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: This feature enables system admins to configure custom mentions for :doc:`LDAP synced groups ` via the Group Configuration page. This functionality is also supported on the mobile app (from v1.34) if the AD/LDAP groups feature is enabled. The mobile app supports auto-suggesting groups, highlights group member mentions, and also provides a warning dialog when a mention will notify more than five users. @@ -89,9 +89,6 @@ As with ``@username`` mentions, use *@* to bring up a list of groups that can be @customusergroupname -------------------- -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - You can add groups of users to a channel or team by :doc:`creating a custom group ` and @mentioning that custom group in a channel. - Mattermost prompts to you to add any users who aren't already members of that channel to the channel. diff --git a/source/end-user-guide/collaborate/message-priority.rst b/source/end-user-guide/collaborate/message-priority.rst index 5cc4a858fdb..83ca6bc9595 100644 --- a/source/end-user-guide/collaborate/message-priority.rst +++ b/source/end-user-guide/collaborate/message-priority.rst @@ -1,7 +1,7 @@ Set message priority ==================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: From Mattermost v7.7 and mobile v2.4, you can add a message priority label to root messages to make important messages requiring timely action or response more visible and less likely to be overlooked. @@ -21,9 +21,6 @@ When you send a priority message, the priority label displays next to your name Send persistent notifications ----------------------------- -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - From Mattermost v8.0, when you add an urgent priority label, and your message @mentions at least one other user, `Mattermost Enterprise or Professional `__ customers can enable persistent notifications which notify recipients at regular intervals and for a set amount of time until the recipient acknowledges, reacts, or replies to the message. To enable persistent notifications for a message: @@ -54,9 +51,6 @@ To stop receiving persistent notifications, you can reply to the thread, select Request acknowledgements ------------------------ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - `Mattermost Enterprise or Professional `__ customers can additionally request that recipients actively acknowledge the message to track that messages have been seen and actioned. By default, marking a message as Urgent priority automatically requests an acknowledgement. When you request acknowlegement of a message, an **Acknowledge** |acknowledge-button| button is added below the sent message. You can mark message as acknowledged by selecting the button, and you can hover over the **Acknowledged** |acknowledge-button| icon to review who has acknowledged the message. diff --git a/source/end-user-guide/collaborate/message-reminders.rst b/source/end-user-guide/collaborate/message-reminders.rst index d6c1f360cab..dc549f387da 100644 --- a/source/end-user-guide/collaborate/message-reminders.rst +++ b/source/end-user-guide/collaborate/message-reminders.rst @@ -1,7 +1,7 @@ Set a reminder ============== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: From Mattermost v7.10, using Mattermost in a web browser or the desktop app, you can set 1 timed reminder on a post made in a channel, direct message, and group message. The ability to set up recurring reminders isn't supported. diff --git a/source/end-user-guide/collaborate/navigate-between-channels.rst b/source/end-user-guide/collaborate/navigate-between-channels.rst index 49c4054cd8f..0f7beaf146e 100644 --- a/source/end-user-guide/collaborate/navigate-between-channels.rst +++ b/source/end-user-guide/collaborate/navigate-between-channels.rst @@ -1,7 +1,7 @@ Navigate channels ================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Navigate between channels diff --git a/source/end-user-guide/collaborate/organize-conversations.rst b/source/end-user-guide/collaborate/organize-conversations.rst index e32a0c8e579..c321dff71ba 100644 --- a/source/end-user-guide/collaborate/organize-conversations.rst +++ b/source/end-user-guide/collaborate/organize-conversations.rst @@ -1,7 +1,7 @@ Organize conversations using threaded discussions ==================================================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Threads are a key part of the messaging experience in Mattermost. They're used to organize conversations and enable users to discuss topics without adding noise to channels or direct messages. diff --git a/source/end-user-guide/collaborate/organize-using-custom-user-groups.rst b/source/end-user-guide/collaborate/organize-using-custom-user-groups.rst index a16898ec98f..ec3b6e1f3f2 100644 --- a/source/end-user-guide/collaborate/organize-using-custom-user-groups.rst +++ b/source/end-user-guide/collaborate/organize-using-custom-user-groups.rst @@ -1,7 +1,7 @@ Manage custom groups ==================== -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Custom groups reduce noise and improve focus by notifying the right people in a channel at the right time, while maintaining transparency for all members in that channel. Custom user groups let you notify up to 256 users at a time rather than notifying users individually. diff --git a/source/end-user-guide/collaborate/organize-using-teams.rst b/source/end-user-guide/collaborate/organize-using-teams.rst index ed754f19452..3d4ea14bd66 100644 --- a/source/end-user-guide/collaborate/organize-using-teams.rst +++ b/source/end-user-guide/collaborate/organize-using-teams.rst @@ -1,7 +1,7 @@ Organize using teams ==================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: .. toctree:: @@ -16,9 +16,6 @@ A team is a digital :doc:`workspace ` wher Users with the **Create Teams** permission can `create new teams <#create-a-team>`__ and :doc:`manage team settings ` for existing teams. System admins can grant the **Create Team** permission to roles via the :ref:`System scheme ` or the :ref:`Team override scheme `. -.. include:: ../../_static/badges/academy-teams.rst - :start-after: :nosearch: - Single team versus multiple teams ---------------------------------- diff --git a/source/end-user-guide/collaborate/react-with-emojis-gifs.rst b/source/end-user-guide/collaborate/react-with-emojis-gifs.rst index 16bc3fa529f..284e623f1bb 100644 --- a/source/end-user-guide/collaborate/react-with-emojis-gifs.rst +++ b/source/end-user-guide/collaborate/react-with-emojis-gifs.rst @@ -1,7 +1,7 @@ React with emojis and GIFs =========================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Emojis and GIFs are small, digital images, animated images, or icons you can use to communicate or express concepts such as emotions, humor, and physical gestures in your messages. diff --git a/source/end-user-guide/collaborate/rename-channels.rst b/source/end-user-guide/collaborate/rename-channels.rst index 81f4a4fc25f..8371942a865 100644 --- a/source/end-user-guide/collaborate/rename-channels.rst +++ b/source/end-user-guide/collaborate/rename-channels.rst @@ -1,7 +1,7 @@ Rename channels =============== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Anyone can rename the channels they belong to, unless the system admin has :doc:`restricted the permissions to do so using advanced permissions `. diff --git a/source/end-user-guide/collaborate/reply-to-messages.rst b/source/end-user-guide/collaborate/reply-to-messages.rst index a3b434fbbe6..fcbab2fb726 100644 --- a/source/end-user-guide/collaborate/reply-to-messages.rst +++ b/source/end-user-guide/collaborate/reply-to-messages.rst @@ -1,7 +1,7 @@ Reply to messages ================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: .. tab:: Web/Desktop diff --git a/source/end-user-guide/collaborate/save-pin-messages.rst b/source/end-user-guide/collaborate/save-pin-messages.rst index 534c5541401..3a9495105d3 100644 --- a/source/end-user-guide/collaborate/save-pin-messages.rst +++ b/source/end-user-guide/collaborate/save-pin-messages.rst @@ -1,7 +1,7 @@ Save and pin messages ===================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: You have two ways to mark a post to make it easy to find later: diff --git a/source/end-user-guide/collaborate/schedule-messages.rst b/source/end-user-guide/collaborate/schedule-messages.rst index c8fd3e05f3d..801ff903c03 100644 --- a/source/end-user-guide/collaborate/schedule-messages.rst +++ b/source/end-user-guide/collaborate/schedule-messages.rst @@ -1,7 +1,7 @@ Schedule messages ================== -.. include:: ../../_static/badges/ent-pro-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: There are times when you want to send a message, but you don’t want it sent immediately. For example, it may be after working hours for the recipient. Scheduled messages can include a :doc:`priority `, :ref:`request acknowledgements `, include :doc:`file attachments `, and include anything that a non-scheduled message can contain, except :doc:`slash commands `. diff --git a/source/end-user-guide/collaborate/search-for-messages.rst b/source/end-user-guide/collaborate/search-for-messages.rst index dfbc21678c4..77835300e3a 100644 --- a/source/end-user-guide/collaborate/search-for-messages.rst +++ b/source/end-user-guide/collaborate/search-for-messages.rst @@ -1,14 +1,11 @@ Search for messages =================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Use Mattermost search to find messages, replies, and the contents of files. You can also search by `hashtags <#hashtags>`__ and perform more advanced searches using `search modifiers <#search-modifiers>`__. -.. include:: ../../_static/badges/academy-search.rst - :start-after: :nosearch: - Search for message ------------------- diff --git a/source/end-user-guide/collaborate/send-messages.rst b/source/end-user-guide/collaborate/send-messages.rst index 7a51f3683e5..1b3830853d1 100644 --- a/source/end-user-guide/collaborate/send-messages.rst +++ b/source/end-user-guide/collaborate/send-messages.rst @@ -1,7 +1,7 @@ Send messages ============= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: You can send messages in public and private channels as well as to other users in Mattermost. Depending on when you compose a message, you can send it immediately, :doc:`schedule it for later `, or :doc:`set its priority `. diff --git a/source/end-user-guide/collaborate/share-files-in-messages.rst b/source/end-user-guide/collaborate/share-files-in-messages.rst index 97189b5cacc..590b109a819 100644 --- a/source/end-user-guide/collaborate/share-files-in-messages.rst +++ b/source/end-user-guide/collaborate/share-files-in-messages.rst @@ -1,7 +1,7 @@ Share files in messages ======================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: With file attachments, you can share additional information that helps your team to visually understand your ideas. Sharing videos, voice recordings, screenshots, and photos can make your messages more effective and clear. diff --git a/source/end-user-guide/collaborate/share-links.rst b/source/end-user-guide/collaborate/share-links.rst index e4393f8d130..cbb54bdc57b 100644 --- a/source/end-user-guide/collaborate/share-links.rst +++ b/source/end-user-guide/collaborate/share-links.rst @@ -1,7 +1,7 @@ Share links to channels and messages ==================================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: You can share links to Mattermost `channels <#share-channel-links>`__ and `messages <#share-message-links>`__ with other Mattermost users. diff --git a/source/end-user-guide/collaborate/team-keyboard-shortcuts.rst b/source/end-user-guide/collaborate/team-keyboard-shortcuts.rst index fd6c6eccc22..ed436e26dfe 100644 --- a/source/end-user-guide/collaborate/team-keyboard-shortcuts.rst +++ b/source/end-user-guide/collaborate/team-keyboard-shortcuts.rst @@ -1,7 +1,7 @@ Team keyboard shortcuts ======================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Keyboard shortcuts help you make a more efficient use of your keyboard when navigating Mattermost teams in a web browser or the desktop app. diff --git a/source/end-user-guide/collaborate/team-settings.rst b/source/end-user-guide/collaborate/team-settings.rst index 94606877a4c..5d9090959b7 100644 --- a/source/end-user-guide/collaborate/team-settings.rst +++ b/source/end-user-guide/collaborate/team-settings.rst @@ -1,7 +1,7 @@ Team settings ============= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Team settings enable system and team administrators to adjust settings applied to a specific team. Using Mattermost in a web browser or the desktop app, select the team name to access **Team Settings**. diff --git a/source/end-user-guide/collaborate/view-system-information.rst b/source/end-user-guide/collaborate/view-system-information.rst index 5857a9dc882..00f11a0ee94 100644 --- a/source/end-user-guide/collaborate/view-system-information.rst +++ b/source/end-user-guide/collaborate/view-system-information.rst @@ -1,7 +1,7 @@ View system information ======================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: You can view technical details about your Mattermost server, including version information and system metrics. This information is useful when working with Mattermost support or troubleshooting issues. diff --git a/source/end-user-guide/end-user-guide-index.rst b/source/end-user-guide/end-user-guide-index.rst index 7b3575d1fae..475bb20a23f 100644 --- a/source/end-user-guide/end-user-guide-index.rst +++ b/source/end-user-guide/end-user-guide-index.rst @@ -1,9 +1,6 @@ End User Guide ================ -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - If you're using Mattermost to connect and collaborate, build repeatable, automated processes, and making Mattermost match your work preferences, this Mattermost end user product documentation is for you. In this documentation, you'll learn about using Mattermost. Your Mattermost system admin has deployed Mattermost for your organization. A live Mattermost instance is ready for you to log into using your user credentials. Your Mattermost workspace is where you'll send and receive messages, see activity notifications, create, run, and participate in playbook runs, and where you'll customize look and feel through workspace preferences. @@ -27,9 +24,6 @@ In this documentation, you'll learn about using Mattermost. Your Mattermost syst * :doc:`AI Agents ` - Learn how to use AI agents to help you make decisions, find information, and automate repetative tasks. * :doc:`Customize Your Preferences ` - Learn how to make Mattermost match the way you prefer to work. -.. include:: ../_static/badges/academy-platform-overview.rst - :start-after: :nosearch: - .. image:: ../images/Channels_Hero.png :alt: An example of the Mattermost screen that includes teams, the channel sidebar, an active conversation in the center pane, reply threads in the right-hand pane. diff --git a/source/end-user-guide/messaging-collaboration.rst b/source/end-user-guide/messaging-collaboration.rst index c71d126c190..51094d06fc7 100644 --- a/source/end-user-guide/messaging-collaboration.rst +++ b/source/end-user-guide/messaging-collaboration.rst @@ -1,7 +1,7 @@ Messaging Collaboration ======================================= -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: Mattermost provides 1:1 and group messaging that features integrated voice/video conferencing, file, image, and link sharing, rich markdown formatting, and a fully searchable message history. With Mattermost, you can keep all of your team's communications in one place and remove information and organizational silos. @@ -11,9 +11,6 @@ This Mattermost end user documentation is designed for anyone who wants guidance Getting Started --------------- -.. include:: ../_static/badges/academy-channels.rst - :start-after: :nosearch: - .. toctree:: :maxdepth: 1 :hidden: diff --git a/source/end-user-guide/preferences.rst b/source/end-user-guide/preferences.rst index a23e545a0a3..ed79e4d6dcf 100644 --- a/source/end-user-guide/preferences.rst +++ b/source/end-user-guide/preferences.rst @@ -1,14 +1,11 @@ Customize your preferences ========================== -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: You can customize many aspects of your Mattermost experience based on your preferences, including notifications for Mattermost activity, how unread channels are organized, the number of direct messages displayed, your Mattermost look and feel, and more! -.. include:: ../_static/badges/academy-customize-ui.rst - :start-after: :nosearch: - .. tip:: Download `this guide to customizing Mattermost for technical teams `_ to learn how to get more from the platform. diff --git a/source/end-user-guide/preferences/connect-multiple-workspaces.rst b/source/end-user-guide/preferences/connect-multiple-workspaces.rst index 8a3e2eec8b6..1e4cd883d5e 100644 --- a/source/end-user-guide/preferences/connect-multiple-workspaces.rst +++ b/source/end-user-guide/preferences/connect-multiple-workspaces.rst @@ -1,7 +1,7 @@ Connect to multiple Mattermost workspaces ========================================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: diff --git a/source/end-user-guide/preferences/customize-desktop-app-experience.rst b/source/end-user-guide/preferences/customize-desktop-app-experience.rst index 2adf8d747ca..4699670b9da 100644 --- a/source/end-user-guide/preferences/customize-desktop-app-experience.rst +++ b/source/end-user-guide/preferences/customize-desktop-app-experience.rst @@ -1,7 +1,7 @@ Customize your Desktop App experience ===================================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: You can customize your desktop app further with additional settings. Select the tab below that matches your operating system to learn more about what's available. diff --git a/source/end-user-guide/preferences/customize-your-channel-sidebar.rst b/source/end-user-guide/preferences/customize-your-channel-sidebar.rst index 802bf086bcd..656573c09dc 100644 --- a/source/end-user-guide/preferences/customize-your-channel-sidebar.rst +++ b/source/end-user-guide/preferences/customize-your-channel-sidebar.rst @@ -1,7 +1,7 @@ Customize your channel sidebar ============================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Conversations in Mattermost are crucial to company productivity and success. Keeping conversations organized in the sidebar creates an efficient workplace. Using a web browser or the desktop app, you can customize your own channel sidebar based on how you prefer to use Mattermost. Customizations you make are only visible to you, are visible when using the mobile app, and won't affect what your teammates see in their sidebars. diff --git a/source/end-user-guide/preferences/customize-your-theme.rst b/source/end-user-guide/preferences/customize-your-theme.rst index 69b24597c04..45da18d4974 100644 --- a/source/end-user-guide/preferences/customize-your-theme.rst +++ b/source/end-user-guide/preferences/customize-your-theme.rst @@ -3,7 +3,7 @@ Customize your Mattermost theme =============================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: The colors of the Mattermost user interface are customizable. You can choose from `five standard themes <#standard-themes>`__ designed by Mattermost, or design your own custom theme. Your theme changes apply to all teams you're a member of, and are visible across all Mattermost clients. Mattermost Enterprise customers can configure a different theme for every team they're a member of. @@ -136,7 +136,7 @@ One Dark Theme .. image:: ../../images/OneDark.png :alt: One Dark Theme -`Visit the one-dark-mattermost GitHub repository online: `__. +`Visit the one-dark-mattermost GitHub repository online: `__ Want this theme? Copy and paste the following code into Mattermost: @@ -150,7 +150,7 @@ Discord Dark Theme (New) .. image:: ../../images/DiscordNewDarkTheme.png :alt: Discord New Dark Theme -`Visit the mattermost-discord-dark GitHub repository online: `__. +`Visit the mattermost-discord-dark GitHub repository online: `__ Want this theme? Copy and paste the following code into Mattermost: @@ -158,7 +158,6 @@ Want this theme? Copy and paste the following code into Mattermost: {"sidebarBg": "#121214", "sidebarText": "#ffffff", "sidebarUnreadText": "#ffffff", "sidebarTextHoverBg": "#1d1d1e", "sidebarTextActiveBorder": "#ffffff", "sidebarTextActiveColor": "#ffffff", "sidebarHeaderBg": "#121214", "sidebarHeaderTextColor": "#ffffff", "sidebarTeamBarBg": "#121214", "onlineIndicator": "#43a25a", "awayIndicator": "#ca9654", "dndIndicator": "#d83a42", "mentionBg": "#6e84d2", "mentionBj": "#6e84d2", "mentionColor": "#ffffff", "centerChannelBg": "#1a1a1e", "centerChannelColor": "#efeff0", "newMessageSeparator": "#ff4d4d", "linkColor": "#2095e8", "buttonBg": "#5865f2", "buttonColor": "#ffffff", "errorTextColor": "#ff6461", "mentionHighlightBg": "#a4850f", "mentionHighlightLink": "#a4850f", "codeTheme": "monokai"} - Discord Dark Theme (Old) ^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/source/end-user-guide/preferences/manage-advanced-options.rst b/source/end-user-guide/preferences/manage-advanced-options.rst index ee10f9398ac..750ed2e2a28 100644 --- a/source/end-user-guide/preferences/manage-advanced-options.rst +++ b/source/end-user-guide/preferences/manage-advanced-options.rst @@ -1,7 +1,7 @@ Manage advanced options ======================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Using Mattermost in a web browser or the desktop app, you can customize advanced Mattermost options based on your preferences. Select the gear icon |gear| next to your profile picture, then select **Advanced**. diff --git a/source/end-user-guide/preferences/manage-your-channel-specific-notifications.rst b/source/end-user-guide/preferences/manage-your-channel-specific-notifications.rst index 561d5d4ee23..af704478429 100644 --- a/source/end-user-guide/preferences/manage-your-channel-specific-notifications.rst +++ b/source/end-user-guide/preferences/manage-your-channel-specific-notifications.rst @@ -1,7 +1,7 @@ Manage your channel-specific notifications =========================================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: By default, your web and desktop notification preferences apply to all channels you’re a member of. You can customize your per-channel notification preferences for any channel you're a member of for the following actions: diff --git a/source/end-user-guide/preferences/manage-your-desktop-notifications.rst b/source/end-user-guide/preferences/manage-your-desktop-notifications.rst index bbd1bec3e18..57e81058d28 100644 --- a/source/end-user-guide/preferences/manage-your-desktop-notifications.rst +++ b/source/end-user-guide/preferences/manage-your-desktop-notifications.rst @@ -1,7 +1,7 @@ Manage your desktop notifications ================================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: .. |dot-badge| image:: ../../images/dot-badge.png diff --git a/source/end-user-guide/preferences/manage-your-display-options.rst b/source/end-user-guide/preferences/manage-your-display-options.rst index f8be96db59f..32d6140ddf1 100644 --- a/source/end-user-guide/preferences/manage-your-display-options.rst +++ b/source/end-user-guide/preferences/manage-your-display-options.rst @@ -1,7 +1,7 @@ Manage your display options =========================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: You can customize Mattermost display options based on your preferences. diff --git a/source/end-user-guide/preferences/manage-your-mentions-keywords-notifications.rst b/source/end-user-guide/preferences/manage-your-mentions-keywords-notifications.rst index d2c6e18806d..34442db83a5 100644 --- a/source/end-user-guide/preferences/manage-your-mentions-keywords-notifications.rst +++ b/source/end-user-guide/preferences/manage-your-mentions-keywords-notifications.rst @@ -1,7 +1,7 @@ Manage your @mention and keyword notifications ============================================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: You're :doc:`notified ` in a :doc:`web browser `, the :doc:`desktop app `, and on your :doc:`mobile device `, when you're @mentioned by your username or first name, @mentioned as part of a user group, and for matches to keywords you're following. @@ -27,9 +27,6 @@ For example, you can receive notifications for all messages and threads related Passively track keywords (no notification) ------------------------------------------ -.. include:: ../../_static/badges/ent-pro-only.rst - :start-after: :nosearch: - From Mattermost v9.3, Mattermost Enterprise and Professional customers interested calling attention to specific topics of interest across channels can do so without sending notifications to a Mattermost client. Using a web browser or the desktop app, you can passively track key terms by specifying single or multiple words to be highlighted in all channels you're a member of. Keywords and phrases are automatically highlighted using a color based on your :doc:`Mattermost theme `. diff --git a/source/end-user-guide/preferences/manage-your-mobile-notifications.rst b/source/end-user-guide/preferences/manage-your-mobile-notifications.rst index c3c22eccd2b..9e7e6438d5a 100644 --- a/source/end-user-guide/preferences/manage-your-mobile-notifications.rst +++ b/source/end-user-guide/preferences/manage-your-mobile-notifications.rst @@ -1,7 +1,7 @@ Manage your mobile notifications ================================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: .. |numbered-badge| image:: ../../images/numbered-badge.png diff --git a/source/end-user-guide/preferences/manage-your-notifications.rst b/source/end-user-guide/preferences/manage-your-notifications.rst index d699d139e67..cba999c5f1c 100644 --- a/source/end-user-guide/preferences/manage-your-notifications.rst +++ b/source/end-user-guide/preferences/manage-your-notifications.rst @@ -1,7 +1,7 @@ Manage your notifications ========================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: .. |dot-badge| image:: ../../images/dot-badge.png @@ -26,9 +26,6 @@ Manage your notifications Mattermost notifies you of new activity you're directly involved in. How you're notified depends on what Mattermost client you're using, the type of Mattermost activity you're being notified about, and how you prefer to be notified. -.. include:: ../../_static/badges/academy-notifications.rst - :start-after: :nosearch: - .. tip:: **Missing notifications?** diff --git a/source/end-user-guide/preferences/manage-your-plugin-preferences.rst b/source/end-user-guide/preferences/manage-your-plugin-preferences.rst index 826158c8801..cfeec61f7b9 100644 --- a/source/end-user-guide/preferences/manage-your-plugin-preferences.rst +++ b/source/end-user-guide/preferences/manage-your-plugin-preferences.rst @@ -6,7 +6,7 @@ Using Mattermost in a web browser or the desktop app, you can customize Mattermo Microsoft Teams plugin preferences ---------------------------------- -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Select **MS Teams** to connect your Mattermost and Microsoft Teams accounts, and manage notification preferences for Microsoft Teams chats and group chats. See the :ref:`connect your account `. @@ -18,11 +18,11 @@ Select **MS Teams** to connect your Mattermost and Microsoft Teams accounts, and Calls plugin preferences ------------------------ -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Select **Calls** to specify the audio devices, including micrphone and speaker, used for Mattermost calls. .. tip:: - Download our `Mattermost Calls datasheet `_ to learn how Calls make it easy for teams to adapt their communication to a wider variety of situations. \ No newline at end of file + Download our `Mattermost Calls datasheet `_ to learn how Calls make it easy for teams to adapt their communication to a wider variety of situations. \ No newline at end of file diff --git a/source/end-user-guide/preferences/manage-your-profile.rst b/source/end-user-guide/preferences/manage-your-profile.rst index 38d65fc239d..2a8d3c4b189 100644 --- a/source/end-user-guide/preferences/manage-your-profile.rst +++ b/source/end-user-guide/preferences/manage-your-profile.rst @@ -1,7 +1,7 @@ Manage your Mattermost profile ============================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Select your profile picture and select **Profile** to manage the details of your Mattermost profile, including your name, username, nickname, email, and profile picture. diff --git a/source/end-user-guide/preferences/manage-your-security-preferences.rst b/source/end-user-guide/preferences/manage-your-security-preferences.rst index 79dd960a7c9..fdd0e199e0a 100644 --- a/source/end-user-guide/preferences/manage-your-security-preferences.rst +++ b/source/end-user-guide/preferences/manage-your-security-preferences.rst @@ -1,7 +1,7 @@ Manage your security preferences ================================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Select your profile picture, select **Profile**, and then select **Security** to configure your password, view access history, and to view or logout of active sessions. diff --git a/source/end-user-guide/preferences/manage-your-sidebar-options.rst b/source/end-user-guide/preferences/manage-your-sidebar-options.rst index 9fcbc09f35e..01b682954c3 100644 --- a/source/end-user-guide/preferences/manage-your-sidebar-options.rst +++ b/source/end-user-guide/preferences/manage-your-sidebar-options.rst @@ -1,7 +1,7 @@ Manage your sidebar options =========================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Using Mattermost in a web browser or the desktop app, you can customize your Mattermost sidebar based on your preferences. Select the gear icon |gear| next to your profile picture, then select **Sidebar**. diff --git a/source/end-user-guide/preferences/manage-your-thread-reply-notifications.rst b/source/end-user-guide/preferences/manage-your-thread-reply-notifications.rst index ba2d7d86596..ee60923f432 100644 --- a/source/end-user-guide/preferences/manage-your-thread-reply-notifications.rst +++ b/source/end-user-guide/preferences/manage-your-thread-reply-notifications.rst @@ -1,7 +1,7 @@ Manage your thread reply notifications ====================================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: You're :doc:`notified ` in a :doc:`web browser `, the :doc:`desktop app `, and on your :doc:`mobile device `, for threads you're following when you're @mentioned or the messages contain a keyword you're tracking. diff --git a/source/end-user-guide/preferences/manage-your-web-notifications.rst b/source/end-user-guide/preferences/manage-your-web-notifications.rst index df68c12c6e2..7c94f61f06a 100644 --- a/source/end-user-guide/preferences/manage-your-web-notifications.rst +++ b/source/end-user-guide/preferences/manage-your-web-notifications.rst @@ -1,7 +1,7 @@ Manage your web notifications ============================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: .. |chrome-mention-badge| image:: ../../images/chrome-mention-badge.png diff --git a/source/end-user-guide/preferences/set-your-status-availability.rst b/source/end-user-guide/preferences/set-your-status-availability.rst index 21480e497a2..931c99fdbc0 100644 --- a/source/end-user-guide/preferences/set-your-status-availability.rst +++ b/source/end-user-guide/preferences/set-your-status-availability.rst @@ -1,7 +1,7 @@ Set your status and availability ================================= -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Let your team know whether you're available by setting a :ref:`custom status ` and your :ref:`availability ` in Mattermost. diff --git a/source/end-user-guide/preferences/troubleshoot-notifications.rst b/source/end-user-guide/preferences/troubleshoot-notifications.rst index eebbf35e069..2514710f2a2 100644 --- a/source/end-user-guide/preferences/troubleshoot-notifications.rst +++ b/source/end-user-guide/preferences/troubleshoot-notifications.rst @@ -1,7 +1,7 @@ Troubleshoot notifications ========================== -.. include:: ../../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: The Mattermost notifications you receive depend on your `Mattermost preferences <#check-your-mattermost-preferences>`__, the `Mattermost client <#check-your-mattermost-client-settings>`__ you're using, and the `operating system (OS) <#check-your-operating-system-settings>`__ you're running Mattermost on. diff --git a/source/end-user-guide/project-management/boards-settings.rst b/source/end-user-guide/project-management/boards-settings.rst index 1ec490b4042..adfcf78af1e 100644 --- a/source/end-user-guide/project-management/boards-settings.rst +++ b/source/end-user-guide/project-management/boards-settings.rst @@ -1,7 +1,7 @@ Settings ======== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Set language diff --git a/source/end-user-guide/project-management/calculations.rst b/source/end-user-guide/project-management/calculations.rst index 545619656b7..7b43687f93c 100644 --- a/source/end-user-guide/project-management/calculations.rst +++ b/source/end-user-guide/project-management/calculations.rst @@ -1,7 +1,7 @@ Work with calculations ====================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: When you view a board in table or board view, you can use calculations to answer basic metric questions without needing to create complex reports. Hover over the bottom of a column to display the **Calculate** feature, then select the arrow to open the menu options. diff --git a/source/end-user-guide/project-management/groups-filter-sort.rst b/source/end-user-guide/project-management/groups-filter-sort.rst index 683b757f0c6..87a6265d959 100644 --- a/source/end-user-guide/project-management/groups-filter-sort.rst +++ b/source/end-user-guide/project-management/groups-filter-sort.rst @@ -1,7 +1,7 @@ Work with groups, filter, and sort ================================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Your board can be grouped, filtered, and sorted into different views using a range of properties. This gives you a powerful way to track work from various perspectives. When used in conjunction with :ref:`saved views `, you can create multiple views with different groupings and filters for quick access without having to reapply the groupings and filters every time. diff --git a/source/end-user-guide/project-management/migrate-to-boards.rst b/source/end-user-guide/project-management/migrate-to-boards.rst index 763423ab2d2..6b53bfac577 100644 --- a/source/end-user-guide/project-management/migrate-to-boards.rst +++ b/source/end-user-guide/project-management/migrate-to-boards.rst @@ -1,7 +1,7 @@ Import, export, and migrate =========================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Import and export a board archive diff --git a/source/end-user-guide/project-management/navigate-boards.rst b/source/end-user-guide/project-management/navigate-boards.rst index 7f97b0d57e4..d12ee1377fe 100644 --- a/source/end-user-guide/project-management/navigate-boards.rst +++ b/source/end-user-guide/project-management/navigate-boards.rst @@ -1,7 +1,7 @@ Navigate boards =============== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Access boards diff --git a/source/end-user-guide/project-management/share-and-collaborate.rst b/source/end-user-guide/project-management/share-and-collaborate.rst index c48f88fd01f..a3304cff1c2 100644 --- a/source/end-user-guide/project-management/share-and-collaborate.rst +++ b/source/end-user-guide/project-management/share-and-collaborate.rst @@ -1,7 +1,7 @@ Share and collaborate ===================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Board permissions diff --git a/source/end-user-guide/project-management/work-with-boards.rst b/source/end-user-guide/project-management/work-with-boards.rst index 001a552d1f5..7003a319651 100644 --- a/source/end-user-guide/project-management/work-with-boards.rst +++ b/source/end-user-guide/project-management/work-with-boards.rst @@ -1,7 +1,7 @@ Work with boards ================ -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: Start by selecting the type of board you want to use. A board contains cards, which typically track tasks or topics, and views, which define how to display the cards, or a subset of them. Views can display cards in a board, table, calendar, or gallery layout, optionally filtered and grouped by a property (e.g., priority, status, etc). diff --git a/source/end-user-guide/project-management/work-with-cards.rst b/source/end-user-guide/project-management/work-with-cards.rst index d0c3353c924..bd9bc6e5a05 100644 --- a/source/end-user-guide/project-management/work-with-cards.rst +++ b/source/end-user-guide/project-management/work-with-cards.rst @@ -1,7 +1,7 @@ Work with cards =============== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: A card consists of: diff --git a/source/end-user-guide/project-management/work-with-views.rst b/source/end-user-guide/project-management/work-with-views.rst index fdadd982c28..9db1be4bca6 100644 --- a/source/end-user-guide/project-management/work-with-views.rst +++ b/source/end-user-guide/project-management/work-with-views.rst @@ -1,7 +1,7 @@ Work with saved views ===================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/entry-ent.rst :start-after: :nosearch: You can change board views to adjust how your cards are represented. To add a new view to a board, from the board header, select the menu next to the current view name. Scroll down and select **+ Add view**, then select the new visualization you’d like to use. diff --git a/source/end-user-guide/project-task-management.rst b/source/end-user-guide/project-task-management.rst index e0ee5f92863..4ce586f899c 100644 --- a/source/end-user-guide/project-task-management.rst +++ b/source/end-user-guide/project-task-management.rst @@ -1,7 +1,7 @@ Project and Task Management ============================ -.. include:: ../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../_static/badges/entry-ent.rst :start-after: :nosearch: Mattermost Boards provides tight integration between project management and Mattermost to align, define, organize, track, and manage work across teams. diff --git a/source/end-user-guide/workflow-automation.rst b/source/end-user-guide/workflow-automation.rst index 34cf32dcc7b..f6d36da8461 100644 --- a/source/end-user-guide/workflow-automation.rst +++ b/source/end-user-guide/workflow-automation.rst @@ -1,7 +1,7 @@ Workflow Automation ===================== -.. include:: ../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: Mattermost Playbooks provides structure, monitoring and automation for repeatable, team-based processes integrated with the Mattermost platform. Playbooks are :doc:`configurable checklists ` for teams to achieve :doc:`specific and predictable outcomes `, such as incident response, software release management, and logistical operations. @@ -50,9 +50,6 @@ Usage Use collaborative playbooks to orchestrate prescribed workflows and define, streamline, and document complex, recurring operations, and help your organization stay in command with integrated communication, collaboration, and status dashboards managing your workflow life cycles. -.. include:: ../_static/badges/academy-playbooks.rst - :start-after: :nosearch: - Try it yourself! ~~~~~~~~~~~~~~~~ diff --git a/source/end-user-guide/workflow-automation/interact-with-playbooks.rst b/source/end-user-guide/workflow-automation/interact-with-playbooks.rst index ef55f8153f5..47846eb9e35 100644 --- a/source/end-user-guide/workflow-automation/interact-with-playbooks.rst +++ b/source/end-user-guide/workflow-automation/interact-with-playbooks.rst @@ -1,7 +1,7 @@ Interact with playbooks ======================= -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Slash commands diff --git a/source/end-user-guide/workflow-automation/learn-about-playbooks.rst b/source/end-user-guide/workflow-automation/learn-about-playbooks.rst index 44b54150f6d..a2e1248beb3 100644 --- a/source/end-user-guide/workflow-automation/learn-about-playbooks.rst +++ b/source/end-user-guide/workflow-automation/learn-about-playbooks.rst @@ -1,7 +1,7 @@ Learn about collaborative playbooks ==================================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: A collaborative playbook is a repeatable process that is measured and refined over time. For example, the steps you follow when dealing with an outage, a software release, or welcoming a new member of your team can all be made into a playbook. diff --git a/source/end-user-guide/workflow-automation/metrics-and-goals.rst b/source/end-user-guide/workflow-automation/metrics-and-goals.rst index 4cc527a38f8..c2ded217a83 100644 --- a/source/end-user-guide/workflow-automation/metrics-and-goals.rst +++ b/source/end-user-guide/workflow-automation/metrics-and-goals.rst @@ -1,7 +1,7 @@ Metrics and goals ================= -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Workflow dashboards unlock insights about the performance of workflows across organizations. They compare the output metrics from different runs of collaborative playbooks, against targets and historical performance. Each time a collaborative playbook is run, you can update the workflow dashboard for the team and stakeholders to review, where dashboard components are customized per playbook. @@ -54,7 +54,7 @@ The lower half of the page shows a list of finished runs with metrics values. Yo Export channel data ~~~~~~~~~~~~~~~~~~~ -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: See the :doc:`export channel data ` documentation for details on working with channel export functionality. \ No newline at end of file diff --git a/source/end-user-guide/workflow-automation/notifications-and-updates.rst b/source/end-user-guide/workflow-automation/notifications-and-updates.rst index 327b1a5290b..6a9f180e165 100644 --- a/source/end-user-guide/workflow-automation/notifications-and-updates.rst +++ b/source/end-user-guide/workflow-automation/notifications-and-updates.rst @@ -1,7 +1,7 @@ Notifications and updates ========================= -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: There are multiple ways to receive collaborative playbook updates and notifications. diff --git a/source/end-user-guide/workflow-automation/share-and-collaborate.rst b/source/end-user-guide/workflow-automation/share-and-collaborate.rst index e9b60d9d9e0..5903da316f0 100644 --- a/source/end-user-guide/workflow-automation/share-and-collaborate.rst +++ b/source/end-user-guide/workflow-automation/share-and-collaborate.rst @@ -1,10 +1,9 @@ Share and collaborate ===================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: - There are different ways for teams to access and interact with collaborative playbooks. This is managed in the System Console using permissions. Permissions can be granted in a variety of ways, to allow for different combinations of access and visibility. Permissions are provided using: @@ -102,7 +101,7 @@ To import a playbook, go to the Playbooks screen, and select **Import**. Choose Export channel data -------------------- -.. include:: ../../_static/badges/ent-only.rst +.. include:: ../../_static/badges/ent-plus.rst :start-after: :nosearch: See the :doc:`export channel data ` documentation for details on working with channel export functionality. \ No newline at end of file diff --git a/source/end-user-guide/workflow-automation/work-with-playbooks.rst b/source/end-user-guide/workflow-automation/work-with-playbooks.rst index 74dc3e73f98..8529b381860 100644 --- a/source/end-user-guide/workflow-automation/work-with-playbooks.rst +++ b/source/end-user-guide/workflow-automation/work-with-playbooks.rst @@ -1,7 +1,7 @@ Work with collaborative playbooks ================================== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: A collaborative playbook is a checklist of the tasks that make up your processes. Collaborative playbooks allow you to take codified knowledge and processes and make them accessible and editable by your organization and team. When you're setting up your playbook, you'll be able to break tasks down, and assign actions to them - such as using a slash command to start a Zoom call. You can also decide whether to use the same channel every time your playbook is run, or a new one. diff --git a/source/end-user-guide/workflow-automation/work-with-runs.rst b/source/end-user-guide/workflow-automation/work-with-runs.rst index d3771610eb3..cd7272d781e 100644 --- a/source/end-user-guide/workflow-automation/work-with-runs.rst +++ b/source/end-user-guide/workflow-automation/work-with-runs.rst @@ -1,7 +1,7 @@ Work with runs ============== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: A run is the execution of a collaborative playbook. You can start each run in a new channel or you can elect to use the same channel for multiple runs. diff --git a/source/end-user-guide/workflow-automation/work-with-tasks.rst b/source/end-user-guide/workflow-automation/work-with-tasks.rst index 40c7cc95b62..a418b1de62a 100644 --- a/source/end-user-guide/workflow-automation/work-with-tasks.rst +++ b/source/end-user-guide/workflow-automation/work-with-tasks.rst @@ -1,7 +1,7 @@ Work with tasks =============== -.. include:: ../../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../../_static/badges/all-commercial.rst :start-after: :nosearch: Tasks and due dates diff --git a/source/get-help/community-for-mattermost.rst b/source/get-help/community-for-mattermost.rst index 701b2e17188..09d1d058883 100644 --- a/source/get-help/community-for-mattermost.rst +++ b/source/get-help/community-for-mattermost.rst @@ -1,7 +1,7 @@ Community for Mattermost ======================== -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: Join the `Mattermost Community server `_ directly from your Microsoft 365, Microsoft Outlook, or Microsoft Teams instance! diff --git a/source/integrations-guide/built-in-slash-commands.rst b/source/integrations-guide/built-in-slash-commands.rst index c6251893db7..7f87e7fe45a 100644 --- a/source/integrations-guide/built-in-slash-commands.rst +++ b/source/integrations-guide/built-in-slash-commands.rst @@ -1,7 +1,7 @@ Built-In Slash Commands ============================ -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: The following built-in slash comamnds are available in your Mattermost :doc:`workspace `. diff --git a/source/integrations-guide/github.rst b/source/integrations-guide/github.rst index 83ef6cda2d6..ac3a0d20ffb 100644 --- a/source/integrations-guide/github.rst +++ b/source/integrations-guide/github.rst @@ -1,7 +1,7 @@ Connect GitHub to Mattermost ============================= -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: Minimize distractions and reduce context switching between your GitHub code repositories and your communication platform by integrating GitHub with Mattermost. Help your teams stay focused and productive with real-time updates on commits, pull requests, issues, and more directly from Mattermost channels. diff --git a/source/integrations-guide/gitlab.rst b/source/integrations-guide/gitlab.rst index 446f971ecb4..8f4ccf01e36 100644 --- a/source/integrations-guide/gitlab.rst +++ b/source/integrations-guide/gitlab.rst @@ -1,7 +1,7 @@ Connect GitLab to Mattermost ================================ -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: Minimize distractions and reduce context switching between your GitLab code repositories and your communication platform by integrating GitLab with Mattermost. You control which events trigger notifications beyond default events, including merges, issue comments, merge request comments, pipelines, pull reviews, and many more. Help your teams stay focused and productive with daily task summaries, real-time updates and notifications on new and closed merge requests, new and closed issues, and tag creation events, directly from Mattermost channel subscriptions. diff --git a/source/integrations-guide/incoming-webhooks.rst b/source/integrations-guide/incoming-webhooks.rst index 2e691690776..68b19e455f5 100644 --- a/source/integrations-guide/incoming-webhooks.rst +++ b/source/integrations-guide/incoming-webhooks.rst @@ -1,5 +1,8 @@ Incoming Webhooks -================= +================== + +.. include:: ../_static/badges/all-commercial.rst + :start-after: :nosearch: **Technical complexity:** :ref:`No-code ` diff --git a/source/integrations-guide/jira.rst b/source/integrations-guide/jira.rst index ef3b4c77f5d..5868ccde3a7 100644 --- a/source/integrations-guide/jira.rst +++ b/source/integrations-guide/jira.rst @@ -1,7 +1,7 @@ Connect Jira to Mattermost ============================ -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: Minimize distractions, reduce context switching between your project management tool and your communication platform by integrating Jira with Mattermost. You control which events trigger notifications including issue creation, field-specific issue updates, reopened, resolved, or deleted issues, as well as new, updated, or deleted issue comments. Create Jira issues directly from Mattermost conversations, attach messages to Jira issues, transition and assign Jira issues, and follow up on action items in real-time, directly from Mattermost channel subscriptions. diff --git a/source/integrations-guide/mattermost-mission-collaboration-for-m365.rst b/source/integrations-guide/mattermost-mission-collaboration-for-m365.rst index 30ffaf85279..b277958dd9c 100644 --- a/source/integrations-guide/mattermost-mission-collaboration-for-m365.rst +++ b/source/integrations-guide/mattermost-mission-collaboration-for-m365.rst @@ -1,7 +1,7 @@ Connect Microsoft 365, Teams, and Outlook with Mattermost ========================================================== -.. include:: ../_static/badges/ent-adv-cloud-selfhosted.rst +.. include:: ../_static/badges/ent-adv.rst :start-after: :nosearch: Mattermost Mission Collaboration for Microsoft extends Microsoft for mission-critical coordination, command and control, incident response, and DevSecOps workflows in demanding environments, including air-gapped and classified networks by embedding Mattermost inside Teams. Use data-sovereign tools like secure chat, Playbooks, and Calls directly within M365, Teams, and Outlook. diff --git a/source/integrations-guide/microsoft-calendar.rst b/source/integrations-guide/microsoft-calendar.rst index f0db78731d7..fff08ecbab8 100644 --- a/source/integrations-guide/microsoft-calendar.rst +++ b/source/integrations-guide/microsoft-calendar.rst @@ -1,7 +1,7 @@ Connect Microsoft Calendar to Mattermost ========================================= -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: Connect your Microsoft M365 Calendar to your Mattermost instance to receive daily summaries of calendar events, synchronize your M365 status in Mattermost, and accept or decline calendar invites from Mattermost. diff --git a/source/integrations-guide/microsoft-teams-meetings.rst b/source/integrations-guide/microsoft-teams-meetings.rst index bff09543a87..0ea8274c0ba 100644 --- a/source/integrations-guide/microsoft-teams-meetings.rst +++ b/source/integrations-guide/microsoft-teams-meetings.rst @@ -1,7 +1,7 @@ Connect Microsoft Teams Meetings to Mattermost ============================================== -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: Start and join voice calls, video calls, and use screen sharing with your team members in Microsoft Teams without leaving Mattermost. diff --git a/source/integrations-guide/microsoft-teams-sync.rst b/source/integrations-guide/microsoft-teams-sync.rst index 0ef1ed5be53..0ace35c803f 100644 --- a/source/integrations-guide/microsoft-teams-sync.rst +++ b/source/integrations-guide/microsoft-teams-sync.rst @@ -1,14 +1,11 @@ Connect Microsoft Teams to Mattermost ===================================== -.. include:: ../_static/badges/ent-cloud-selfhosted.rst +.. include:: ../_static/badges/entry-ent.rst :start-after: :nosearch: Break through siloes in a mixed Mattermost and Microsoft Teams environment by forwarding real-time chat notifications from Microsoft Teams to Mattermost. -.. include:: ../_static/badges/academy-msteams.rst - :start-after: :nosearch: - Deploy ------- diff --git a/source/integrations-guide/no-code-automation.rst b/source/integrations-guide/no-code-automation.rst index ea90785e32d..506ee9c4af6 100644 --- a/source/integrations-guide/no-code-automation.rst +++ b/source/integrations-guide/no-code-automation.rst @@ -1,6 +1,9 @@ No-Code Automation =================== +.. include:: ../_static/badges/all-commercial.rst + :start-after: :nosearch: + **Technical complexity:** :ref:`No-code ` Platforms like n8n, Zapier, or Make provide powerful visual editors that support thousands of connected tools, with triggers and actions that integrate Mattermost to external services, enabling teams to build complex workflows without writing code. Admins migrating from tools like Slack Workflow Builder can recreate familiar automations in Mattermost using these platforms. diff --git a/source/integrations-guide/outgoing-webhooks.rst b/source/integrations-guide/outgoing-webhooks.rst index f28597e76fb..4a7784d4780 100644 --- a/source/integrations-guide/outgoing-webhooks.rst +++ b/source/integrations-guide/outgoing-webhooks.rst @@ -1,6 +1,9 @@ Outgoing Webhooks ================= +.. include:: ../_static/badges/all-commercial.rst + :start-after: :nosearch: + **Technical complexity:** :ref:`Low-code ` Outgoing webhooks can be used to create rich, interactive experiences in Mattermost by letting external services respond with rich message attachments, such as structured fields, buttons, and menus. Additionally, these responses can trigger interactive dialog forms where users provide additional input directly in Mattermost, or interactive messages that update dynamically based on user actions. Together, these capabilities turn simple keyword triggers into powerful in-product workflows that streamline how teams interact with external systems, all with minimal coding required. diff --git a/source/integrations-guide/plugins.rst b/source/integrations-guide/plugins.rst index 300d8b3095b..1643b7275c7 100644 --- a/source/integrations-guide/plugins.rst +++ b/source/integrations-guide/plugins.rst @@ -25,10 +25,7 @@ Custom-built plugins **Technical complexity:** :ref:`Pro-code ` -.. include:: ../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - -Building a custom plugin is a **software development** task, using ``Go`` for the server-side functionality and optionally ``TypeScript/React`` for UI components. Developers should be comfortable with Git, modern build tooling, and the `Mattermost Plugin API `_, including lifecycle hooks, KV storage, slash commands, and interactivity. Knowledge of testing, logging, and security best practices is essential for production-ready plugins, along with experience packaging and deploying plugins through the System Console or CLI. For teams without these skills, simpler options like webhooks, slash commands, or no-code workflow tools may be more practical. +Building a custom plugin for your self-hosted deployment is a **software development** task, using ``Go`` for the server-side functionality and optionally ``TypeScript/React`` for UI components. Developers should be comfortable with Git, modern build tooling, and the `Mattermost Plugin API `_, including lifecycle hooks, KV storage, slash commands, and interactivity. Knowledge of testing, logging, and security best practices is essential for production-ready plugins, along with experience packaging and deploying plugins through the System Console or CLI. For teams without these skills, simpler options like webhooks, slash commands, or no-code workflow tools may be more practical. Plugins can authenticate and interact with Mattermost through `bot accounts `_, utilizing the `RESTful API `_. diff --git a/source/integrations-guide/restful-api.rst b/source/integrations-guide/restful-api.rst index 22296e22ba4..e2862114a78 100644 --- a/source/integrations-guide/restful-api.rst +++ b/source/integrations-guide/restful-api.rst @@ -1,6 +1,9 @@ RESTful API ============ +.. include:: ../_static/badges/all-commercial.rst + :start-after: :nosearch: + **Technical complexity:** :ref:`Pro-code ` Full developer control for automation, bots, and integrations. diff --git a/source/integrations-guide/run-slash-commands.rst b/source/integrations-guide/run-slash-commands.rst index 3a64c09d3dd..80ad6cea636 100644 --- a/source/integrations-guide/run-slash-commands.rst +++ b/source/integrations-guide/run-slash-commands.rst @@ -1,7 +1,7 @@ Run Slash Commands ================== -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: Using a slash command is as easy as composing a message. Instead of message text, you start slash commands with a slash character: ``/``. diff --git a/source/integrations-guide/servicenow.rst b/source/integrations-guide/servicenow.rst index 329bcb08dbe..89be3bd90ce 100644 --- a/source/integrations-guide/servicenow.rst +++ b/source/integrations-guide/servicenow.rst @@ -1,7 +1,7 @@ Connect ServiceNow to Mattermost ================================= -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: Minimize distractions and reduce context switching by bridging the gap between IT service management (ITSM) and team communication. Create and manage incident reports, change requests, and service tickets, as well as manage event-driven notification subscriptions for ServiceNow record changes, in real-time, and automate routine tasks to decrease response times without leaving Mattermost. diff --git a/source/integrations-guide/slash-commands.rst b/source/integrations-guide/slash-commands.rst index 9bb2bf36d2c..396c763e92e 100644 --- a/source/integrations-guide/slash-commands.rst +++ b/source/integrations-guide/slash-commands.rst @@ -1,6 +1,9 @@ Slash Commands =============== +.. include:: ../_static/badges/all-commercial.rst + :start-after: :nosearch: + .. toctree:: :maxdepth: 1 :hidden: diff --git a/source/integrations-guide/webhook-integrations.rst b/source/integrations-guide/webhook-integrations.rst index b884bbef228..851c24af678 100644 --- a/source/integrations-guide/webhook-integrations.rst +++ b/source/integrations-guide/webhook-integrations.rst @@ -1,6 +1,9 @@ Webhooks ======== +.. include:: ../_static/badges/all-commercial.rst + :start-after: :nosearch: + .. toctree:: :maxdepth: 1 :hidden: diff --git a/source/integrations-guide/zoom.rst b/source/integrations-guide/zoom.rst index 4b73e17304d..5983d2f738b 100644 --- a/source/integrations-guide/zoom.rst +++ b/source/integrations-guide/zoom.rst @@ -1,7 +1,7 @@ Connect Zoom to Mattermost =========================== -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst +.. include:: ../_static/badges/all-commercial.rst :start-after: :nosearch: diff --git a/source/product-overview/cloud-dedicated.rst b/source/product-overview/cloud-dedicated.rst index dee21f7b0ac..10c769b61c5 100644 --- a/source/product-overview/cloud-dedicated.rst +++ b/source/product-overview/cloud-dedicated.rst @@ -1,9 +1,6 @@ Cloud Dedicated =============== -.. include:: ../_static/badges/ent-cloud-dedicated.rst - :start-after: :nosearch: - Mattermost Cloud Dedicated is designed for larger organizations with higher demands for performance, scalability, customizability, and compliance looking to offload operational overhead and focus on more business-critical tasks. Your own private Mattermost instance running :doc:`Mattermost Enterprise ` is a Kubernetes cluster hosted and managed by Mattermost that runs on dedicated cloud infrastructure, where resources are exclusively available for your organization. diff --git a/source/product-overview/cloud-shared.rst b/source/product-overview/cloud-shared.rst index 2871d3e0f7f..ce3f4c33b40 100644 --- a/source/product-overview/cloud-shared.rst +++ b/source/product-overview/cloud-shared.rst @@ -1,9 +1,6 @@ Cloud Shared ============= -.. include:: ../_static/badges/ent-cloud-only.rst - :start-after: :nosearch: - Mattermost Cloud Shared is designed as a cost-effective solution for companies who don't have strict security and compliance requirements that need a straightforward, managed communication platform without the necessity for extensive customization or dedicated resources. Your Mattermost deployment is isolated, is fully hosted and managed by Mattermost, and runs :doc:`Mattermost Enterprise ` on shared infrastructure where resources are shared among multiple Mattermost customers, which might affect performance during peak times. diff --git a/source/product-overview/cloud-subscriptions.rst b/source/product-overview/cloud-subscriptions.rst index ad031f812c5..54a01ebc6c4 100644 --- a/source/product-overview/cloud-subscriptions.rst +++ b/source/product-overview/cloud-subscriptions.rst @@ -1,9 +1,6 @@ Cloud ====== -.. include:: ../_static/badges/ent-cloud-only.rst - :start-after: :nosearch: - .. toctree:: :maxdepth: 1 :hidden: diff --git a/source/product-overview/cloud-vpc-private-connectivity.rst b/source/product-overview/cloud-vpc-private-connectivity.rst index 4aab2d7d339..49b0602fa5c 100644 --- a/source/product-overview/cloud-vpc-private-connectivity.rst +++ b/source/product-overview/cloud-vpc-private-connectivity.rst @@ -1,7 +1,7 @@ Cloud VPC Private Connectivity =============================== -.. include:: ../_static/badges/ent-cloud-only.rst +.. include:: ../_static/badges/ent-cloud-dedicated.rst :start-after: :nosearch: Virtual Private Cloud (VPC) Private Connectivity (Private Link) offers Enterprise Cloud customers tailored solutions for private connectivity needs with Mattermost Cloud. These options enable customers to access Mattermost Cloud through AWS's network without using the public internet, or allow the Mattermost Infrastructure team to manage a Mattermost instance hosted in the customer's VPC via an EKS cluster. diff --git a/source/product-overview/desktop-app-changelog.md b/source/product-overview/desktop-app-changelog.md index ace3978bffd..fbdd706fc47 100644 --- a/source/product-overview/desktop-app-changelog.md +++ b/source/product-overview/desktop-app-changelog.md @@ -1,8 +1,5 @@ # Desktop App Changelog -```{include} ../_static/badges/allplans-cloud-selfhosted.md -``` - This changelog summarizes updates to Mattermost desktop app releases for [Mattermost](https://mattermost.com). ```{Important} diff --git a/source/product-overview/desktop.rst b/source/product-overview/desktop.rst index 696a5bb09da..68aa59932b2 100644 --- a/source/product-overview/desktop.rst +++ b/source/product-overview/desktop.rst @@ -4,9 +4,6 @@ Desktop .. meta:: :page_title: Mattermost Desktop App -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - The Mattermost desktop app is available for Linux, Mac, and Windows operating systems. The Desktop App supports all the features of the web experience, and enable users to :doc:`connect to multiple Mattermost servers ` from a single interface, navigate between servers using keyboard shortcuts, and :doc:`customize their desktop user experience `. .. toctree:: diff --git a/source/product-overview/editions-and-offerings.rst b/source/product-overview/editions-and-offerings.rst index 470736756ee..9b9fae77ac2 100644 --- a/source/product-overview/editions-and-offerings.rst +++ b/source/product-overview/editions-and-offerings.rst @@ -17,9 +17,6 @@ Once you’ve installed Mattermost Enterprise Edition in your preferred environm Mattermost Entry ~~~~~~~~~~~~~~~~ -.. include:: ../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - Mattermost Entry gives small, forward-leaning teams a **free, production-ready Intelligent Mission Environment** to get started on improving their mission-critical secure collaborative workflows. This offering includes: - Teams and channels for one-to-one and group messaging, file sharing, and unlimited search history with threaded messaging, emoji, and custom emoji with 10,000 messages history and 10,000 monthly push notifications. @@ -63,9 +60,6 @@ The following sections outline our paid offerings which provide commercial suppo Mattermost Enterprise Advanced ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../_static/badges/cloud-selfhosted.rst - :start-after: :nosearch: - Built for **multi-domain secure operations**, Enterprise Advanced builds on all Enterprise-level secure collaborative workflow capabilities with specialized features for environments requiring the strictest security, compliance, and operational integrity, including: - :doc:`Classified and Sensitive Information Controls ` @@ -76,9 +70,6 @@ Built for **multi-domain secure operations**, Enterprise Advanced builds on all Mattermost Enterprise ~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../_static/badges/cloud-selfhosted.rst - :start-after: :nosearch: - Mattermost Enterprise supports large-scale, mission-critical **secure collaborative workflows** with robust security, compliance, and productivity tooling. It builds on core ChatOps capabilities from the Professional offering, plus: - :doc:`Enterprise-scale search with dedicated indexing and usage resourcing via cluster support `. @@ -107,9 +98,6 @@ Mattermost Enterprise supports large-scale, mission-critical **secure collaborat Mattermost Professional ~~~~~~~~~~~~~~~~~~~~~~~ -.. include:: ../_static/badges/selfhosted-only.rst - :start-after: :nosearch: - Professional best serves technical and operational teams of up to 500 users looking to run **Sovereign ChatOps workflows**, with advanced collaboration and security controls. This offering provides robust collaboration and administration tools including: - Teams and channels for one-to-one and group messaging, file sharing, and unlimited search history with threaded messaging, emoji, and custom emoji. @@ -146,6 +134,5 @@ Since 2016, Mattermost has partnered with GitLab to include Team Edition in the In 2025, GitLab began evaluating the removal of Mattermost from the Omnibus package to reduce its size. This prompted both companies to redefine their shared offering. As part of this transition, SSO is being removed from the Team Edition, aligning it with its intended scope for small teams and hobbyist use. Advanced access controls features will continue to be available in the commercial editions, including Mattermost Entry (free). Gitlab Omnibus will ship with the v10.11 ESR, enabling continued use of Gitlab SSO until a redefinition of the partnership is determined. Please see more details in `this forum post `_. Mattermost, Inc. offers its software under different licenses, including open source. An open source “community edition” of the offering is compiled from the `Mattermost open source project `_ under a reciprocal open source license agreement, and in accordance with the `Mattermost trademark policy `_, which requires Mattermost wordmark and trademark be replaced, unless in some circumstances special permission is extended. The purpose of the reciprocal open source license, known as AGPLv3 or “GNU Affero General Public License”, is to have the benefits of open source reach the broader community. Community members creating derivative works of the open source code base are required to use the same reciprocal open source license, AGPLv3, to downstream beneficiaries. - Organizations who prefer not to use a reciprocal open source license can choose to use one of the Enterprise Edition offerings under a commercial license. diff --git a/source/product-overview/mattermost-desktop-releases.md b/source/product-overview/mattermost-desktop-releases.md index 37e9ed395e5..cd575463761 100644 --- a/source/product-overview/mattermost-desktop-releases.md +++ b/source/product-overview/mattermost-desktop-releases.md @@ -1,8 +1,5 @@ # Desktop Releases -```{include} ../_static/badges/allplans-cloud-selfhosted.md -``` - ```{Important} ```{include} common-esr-support.md ``` diff --git a/source/product-overview/mattermost-mobile-releases.md b/source/product-overview/mattermost-mobile-releases.md index dda0f774586..1cd9103eaae 100644 --- a/source/product-overview/mattermost-mobile-releases.md +++ b/source/product-overview/mattermost-mobile-releases.md @@ -1,8 +1,5 @@ # Mobile Releases -```{include} ../_static/badges/allplans-cloud-selfhosted.md -``` - ```{Important} ```{include} common-esr-support.md ``` diff --git a/source/product-overview/mattermost-server-releases.md b/source/product-overview/mattermost-server-releases.md index 27ca18532d2..a6848e5718b 100644 --- a/source/product-overview/mattermost-server-releases.md +++ b/source/product-overview/mattermost-server-releases.md @@ -6,9 +6,6 @@ :page_title: Mattermost Server Releases ``` -```{include} ../_static/badges/allplans-selfhosted.md -``` - ```{Important} ```{include} common-esr-support-upgrade.md ``` diff --git a/source/product-overview/mobile-app-changelog.md b/source/product-overview/mobile-app-changelog.md index f5b072b37ea..1e63e49b036 100644 --- a/source/product-overview/mobile-app-changelog.md +++ b/source/product-overview/mobile-app-changelog.md @@ -1,8 +1,5 @@ # Mobile Apps Changelog -```{include} ../_static/badges/allplans-cloud-selfhosted.md -``` - This changelog summarizes updates to Mattermost mobile apps releases for [Mattermost](https://mattermost.com). ```{Important} diff --git a/source/product-overview/mobile.rst b/source/product-overview/mobile.rst index a614beefbde..de40bb1ddfc 100644 --- a/source/product-overview/mobile.rst +++ b/source/product-overview/mobile.rst @@ -4,9 +4,6 @@ Mobile .. meta:: :page_title: Mattermost Mobile App -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - Mattermost users can take Mattermost wherever they go by installing the Mattermost mobile app on their iOS or Android mobile device. diff --git a/source/product-overview/plans.md b/source/product-overview/plans.md index 97a1d358c5c..c1aa93ffe5d 100644 --- a/source/product-overview/plans.md +++ b/source/product-overview/plans.md @@ -329,7 +329,7 @@ -See a [complete list of features](https://mattermost.com/pricing) on the Mattermost website. Features with an asterick next to the checkmark indicate rate usage limitation. Please see more information [here](https://docs.mattermost.com/product-overview/editions-and-offerings.html). +See a [complete list of features](https://mattermost.com/pricing) on the Mattermost website. Features with an asterisk (``*``) next to the check mark indicate rate usage limitation. Please see more information [here](https://docs.mattermost.com/product-overview/editions-and-offerings.html). ```{note} Mattermost Enterprise Advanced requires a Mattermost Server running v10.9 or later and a PostgreSQL database. Enterprise plugins must be updated to support the new license (most of which are pre-packaged from v10.9). diff --git a/source/product-overview/release-policy.md b/source/product-overview/release-policy.md index b41440e5f31..8fff1b95748 100644 --- a/source/product-overview/release-policy.md +++ b/source/product-overview/release-policy.md @@ -1,8 +1,5 @@ # Release Policy -```{include} ../_static/badges/allplans-selfhosted.md -``` - This page describes Mattermost’s release policy, and our recommended practices around releases, including extended support releases, so that you can allocate your IT resources effectively. To ensure a secure, functional, performant, and efficient Mattermost deployment, system admins managing a self-hosted deployment need to be proactive in: @@ -26,9 +23,6 @@ See the full list of all Mattermost Server and desktop app releases and life cyc (extended-support-releases)= ## Extended Support Releases -```{include} ../_static/badges/ent-only.md -``` - Mattermost Extended Support Releases (ESRs) are a strategic choice for organizations looking for stability and reduced frequency of updates. Using ESRs can minimize disruptions associated with frequent upgrades, making them an attractive option for environments where stability is paramount. Starting with the August 2025 Mattermost server and desktop app releases (server v10.11 and desktop app v5.13), Mattermost has adjusted the ESR life cycle as follows: @@ -74,9 +68,6 @@ The chart above shows both release dates and end-of-life dates for each version. (esr-notifications)= ### ESR Notifications -```{include} ../_static/badges/ent-only.md -``` - When an ESR is at the end of its life cycle, there will be announcements ahead of time to provide time for people to test, certify, and deploy a newer ESR version before support ends. After a release reaches its end-of-life, no further updates will be provided for that version. To receive updates about Extended Support Releases, sign up for [our mailing list](https://mattermost.com/newsletter/). @@ -119,4 +110,4 @@ The following table lists all releases across Mattermost v7.0, v8.0, and v9.0, i | v7.3 | Feature | 2022-12-15 | | v7.2 | Feature | 2022-11-15 | | v7.1 | Extended | 2023-04-15 | -| v7.0 | Major | 2022-09-15 | +| v7.0 | Major | 2022-09-15 | \ No newline at end of file diff --git a/source/product-overview/releases-lifecycle.rst b/source/product-overview/releases-lifecycle.rst index 3cdf7de551e..c46cc16ed27 100644 --- a/source/product-overview/releases-lifecycle.rst +++ b/source/product-overview/releases-lifecycle.rst @@ -1,9 +1,6 @@ Releases and Life Cycle ======================= -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - .. include:: common-esr-support-rst.rst .. toctree:: diff --git a/source/product-overview/self-hosted-subscriptions.rst b/source/product-overview/self-hosted-subscriptions.rst index fe1b32a7b90..61e8d918060 100644 --- a/source/product-overview/self-hosted-subscriptions.rst +++ b/source/product-overview/self-hosted-subscriptions.rst @@ -1,9 +1,6 @@ Self-Hosted ============ -.. include:: ../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - Buy a subscription ------------------ diff --git a/source/product-overview/server.rst b/source/product-overview/server.rst index 692096833a0..0ae1f2d5fa0 100644 --- a/source/product-overview/server.rst +++ b/source/product-overview/server.rst @@ -4,9 +4,6 @@ Server .. meta:: :page_title: Mattermost Server -.. include:: ../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - Mattermost Server installs as a single compiled binary file that includes the RESTful JSON web service, authentication client, authentication provider, notification service, and data management service. The Mattermost Server can be deployed in stand-alone or high availability mode where two or more servers are clustered together using gossip protocol and a proxy server that routes traffic from client applications to healthy servers in the cluster. .. toctree:: diff --git a/source/product-overview/version-archive.rst b/source/product-overview/version-archive.rst index 922bfd99356..eaef1a18466 100644 --- a/source/product-overview/version-archive.rst +++ b/source/product-overview/version-archive.rst @@ -1,9 +1,6 @@ Version Archive ================ -.. include:: ../_static/badges/allplans-selfhosted.rst - :start-after: :nosearch: - .. include:: common-esr-support-rst.rst If you want to check that the version of Mattermost you are installing is the official, unmodified version, compare the SHA-256 checksum or the file's GPG signature with the one published in this version archive. To verify the GPG signature of a Mattermost release, use the public key stored at the following URL: https://deb.packages.mattermost.com/pubkey.gpg. diff --git a/source/scripts/generate-certificates/gencert.md b/source/scripts/generate-certificates/gencert.md index 5c53db3cf0c..1e5d99d06bb 100644 --- a/source/scripts/generate-certificates/gencert.md +++ b/source/scripts/generate-certificates/gencert.md @@ -1,5 +1,8 @@ # gencert.sh for Mattermost +.. include:: ../../_static/badges/all-commercial.md + :start-after: :nosearch: + Generate a self-signed x509v3 certificate for use with multiple URLs / IPs. ## Generate Certificates