Added new disable cloud config setting for self-hosted deployments (#…

…7012) * Update conf.py * Update download-latest-tarball.rst * Update download-latest-tarball.rst * Update download-latest-tarball.rst * Update download-latest-tarball.rst * Corrected config setting name for onboarding flow (#7006) * Added new disable cloud config setting for self-hosted deployments * Incorporated reviewer feedback --------- Co-authored-by: Amy Blais <[email protected]>
mattermost · Apr 16, 2024 · 3869c77 · 3869c77
1 parent 078db8d
commit 3869c77
Showing 1 changed file with 35 additions and 1 deletion.
diff --git a/source/configure/environment-configuration-settings.rst b/source/configure/environment-configuration-settings.rst
@@ -22,6 +22,7 @@ Both self-hosted and Cloud admins can access the following configuration setting
 - `Session Lengths <#session-lengths>`__
 - `Performance Monitoring <#performance-monitoring>`__
 - `Developer <#developer>`__
+- `config. json-only settings <#config-json-only-settings>`__
 
 ----
 
@@ -164,4 +165,37 @@ Developer
   :start-after: :nosearch:
 
 .. include:: developer-mode-configuration-settings.rst
-    :start-after: :nosearch:
+    :start-after: :nosearch:
+
+config.json-only settings
+-------------------------
+
+.. include:: ../_static/badges/allplans-selfhosted.rst
+  :start-after: :nosearch:
+
+.. config:setting:: disable-customer-portal-requests
+  :displayname: Disable customer portal requests
+  :systemconsole: N/A
+  :configjson: .CloudSettings.Disable
+  :environment: MM_CLOUDSETTINGS_DISABLE
+  :description: Enable or disable server requests to the Mattermost Customer Portal.
+
+  - **true**: Server-side requests made to the customer portal are enabled, but will always fail in air-gapped and restricted environments.
+  - **false**: **(Default)** Server-side requests made to the customer portal are disabled.
+
+Disable Customer Portal requests
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
++-----------------------------------------------+---------------------------------------------------------------------------+
+| Enable or disable customer portal requests.   | - System Config path: **N/A**                                             |
+|                                               | - ``config.json setting``: ``".CloudSettings.Disable": false",``          |
+| - **true**: Server-side requests made to the  | - Environment variable: ``MM_CLOUDSETTINGS_DISABLE``                      |
+|   Mattermost Customer Portal are enabled,     |                                                                           |
+|   but will always fail in air-gapped and      |                                                                           |
+|   restricted deployment environments.         |                                                                           |
+| - **false**: **(Default)** Server-side        |                                                                           |
+|   requests made to the customer portal are    |                                                                           |
+|   disabled.                                   |                                                                           |
++-----------------------------------------------+---------------------------------------------------------------------------+
+| **Note**: Cloud admins can’t modify this configuration setting.                                                           |
++-----------------------------------------------+---------------------------------------------------------------------------+