From 9f2fcf598ce5eec921a374575c285af166e652e8 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Thu, 9 Jan 2025 16:51:59 -0500 Subject: [PATCH] Added clarity on how to access config settings in the System Console --- .../authentication-configuration-settings.rst | 11 ++++++-- .../cloud-billing-account-settings.rst | 2 +- .../compliance-configuration-settings.rst | 9 ++++++- source/configure/configuration-settings.rst | 7 +++-- .../environment-configuration-settings.rst | 27 ++++++++++++++----- .../integrations-configuration-settings.rst | 9 ++++++- source/configure/optimize-your-workspace.rst | 2 +- .../plugins-configuration-settings.rst | 24 ++++++++++++++++- .../reporting-configuration-settings.rst | 2 +- .../self-hosted-account-settings.rst | 2 +- .../configure/site-configuration-settings.rst | 9 ++++++- ...user-management-configuration-settings.rst | 2 +- source/guides/administration.rst | 6 ++++- .../get-started-with-administration.rst | 4 +++ source/manage/cloud-ip-filtering.rst | 4 +-- 15 files changed, 96 insertions(+), 24 deletions(-) diff --git a/source/configure/authentication-configuration-settings.rst b/source/configure/authentication-configuration-settings.rst index ab444f8e13b..436ff1f3c86 100644 --- a/source/configure/authentication-configuration-settings.rst +++ b/source/configure/authentication-configuration-settings.rst @@ -4,14 +4,14 @@ Authentication configuration settings .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -Mattermost supports up to four distinct, concurrent methods of **Authentication**: +Mattermost supports up to 4 distinct, concurrent methods of user authentication: - An OpenID provider - A SAML provider - An LDAP instance (e.g., Active Directory, OpenLDAP) - Email and Password -Both self-hosted and Cloud admins can access the following configuration settings in **System Console > Authentication**. Self-hosted admins can also edit the ``config.json`` file as described in the following tables. +Review and manage the following authentication configuration options in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **Authentication**: - `Signup <#signup>`__ - `Email <#email>`__ @@ -23,6 +23,13 @@ Both self-hosted and Cloud admins can access the following configuration setting - `OpenID Connect <#openid-connect>`__ - `Guest Access <#guest-access>`__ +.. tip:: + + System admins managing a self-hosted Mattermost deployment can edit the ``config.json`` file as described in the following tables. Each configuration value below includes a JSON path to access the value programmatically in the ``config.json`` file using a JSON-aware tool. For example, the ``EnableUserCreation`` value is under ``TeamSettings``. + + - If using a tool such as `jq `__, you'd enter: ``cat config/config.json | jq '.TeamSettings.EnableUserCreation'`` + - When working with the ``config.json`` file manually, look for an object such as ``TeamSettings``, then within that object, find the key ``EnableUserCreation``. + ---- Signup diff --git a/source/configure/cloud-billing-account-settings.rst b/source/configure/cloud-billing-account-settings.rst index 510b24617a0..56c2f97a7b0 100644 --- a/source/configure/cloud-billing-account-settings.rst +++ b/source/configure/cloud-billing-account-settings.rst @@ -4,7 +4,7 @@ Cloud workspace subscription, billing, and account settings .. include:: ../_static/badges/allplans-cloud.rst :start-after: :nosearch: -Go to **System Console > Billing and Account** to manage the following aspects of your Cloud deployment: +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 - Manage the :doc:`product subscription ` and account details for your Mattermost Cloud deployment. diff --git a/source/configure/compliance-configuration-settings.rst b/source/configure/compliance-configuration-settings.rst index 19c82afa9ee..fb6c68aa36a 100644 --- a/source/configure/compliance-configuration-settings.rst +++ b/source/configure/compliance-configuration-settings.rst @@ -4,13 +4,20 @@ Compliance configuration settings .. include:: ../_static/badges/ent-cloud-selfhosted.rst :start-after: :nosearch: -Both self-hosted and Cloud admins can access the following configuration settings in **System Console > Compliance**. Self-hosted admins can also edit the ``config.json`` file as described in the following tables. +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**: - `Data Retention Policies <#data-retention-policies>`__ - `Compliance Export <#compliance-export>`__ - `Compliance Monitoring <#compliance-monitoring>`__ - `Custom Terms of Service <#custom-terms-of-service>`__ +.. tip:: + + System admins managing a self-hosted Mattermost deployment can edit the ``config.json`` file as described in the following tables. Each configuration value below includes a JSON path to access the value programmatically in the ``config.json`` file using a JSON-aware tool. For example, the ``MessageRetentionDays`` value is under ``DataRetentionSettings``. + + - If using a tool such as `jq `__, you'd enter: ``cat config/config.json | jq '.DataRetentionSettings.MessageRetentionDays'`` + - When working with the ``config.json`` file manually, look for an object such as ``DataRetentionSettings``, then within that object, find the key ``MessageRetentionDays``. + ---- Data retention policies diff --git a/source/configure/configuration-settings.rst b/source/configure/configuration-settings.rst index b134bf290e2..4934c84b441 100644 --- a/source/configure/configuration-settings.rst +++ b/source/configure/configuration-settings.rst @@ -4,11 +4,12 @@ Configuration settings .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -System admins for both self-hosted and Cloud Mattermost deployments can manage Mattermost configuration using the System Console. For self-hosted deployments, admins can additionally edit the ``config.json`` file. +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**. .. note:: - Mattermost requires write permissions to the ``config.json`` file; otherwise, configuration changes made within the System Console will have no effect. + - In self-hosted Mattermost deployments, configuration settings are maintained in the ``config.json`` configuration file, located in the ``mattermost/config`` directory, or :doc:`stored in the database `. System admins managing self-hosted deployments can also modify the ``config.json`` file directly using a text editor. + - Mattermost requires write permissions to the ``config.json`` file; otherwise, configuration changes made within the System Console will have no effect. Mattermost configuration settings are organized into the following categories within the System Console: @@ -24,8 +25,6 @@ Mattermost configuration settings are organized into the following categories wi - :doc:`Compliance configuration settings ` - :doc:`Experimental configuration settings ` -In self-hosted Mattermost deployments, configuration settings are maintained in the ``config.json`` configuration file, located in the ``mattermost/config`` directory, or :doc:`stored in the database `. System admins managing self-hosted deployments can also modify the ``config.json`` file directly using a text editor. - Configuration in database -------------------------- diff --git a/source/configure/environment-configuration-settings.rst b/source/configure/environment-configuration-settings.rst index 4e5101e11b3..51e1894caae 100644 --- a/source/configure/environment-configuration-settings.rst +++ b/source/configure/environment-configuration-settings.rst @@ -4,14 +4,29 @@ Environment configuration settings .. include:: ../_static/badges/allplans-selfhosted.rst :start-after: :nosearch: -.. tip:: - - Each configuration value below includes a JSON path to access the value programmatically in the ``config.json`` file using a JSON-aware tool. For example, the ``SiteURL`` value is under ``ServiceSettings``. +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**: + +- `Web server <#web-server>`__ +- `Database <#database>`__ +- `Elasticsearch <#elasticsearch>`__ +- `File storage <#file-storage>`__ +- `Image proxy <#image-proxy>`__ +- `SMTP <#smtp>`__ +- `Push notification server <#push-notification-server>`__ +- `High availaiblity <#high-availability>`__ cluster-based settings +- `Rate limiting <#rate-limiting>`__ +- `Logging <#logging>`__ +- `Session lengths <#session-lengths>`__ +- `Performance monitoring <#performance-monitoring>`__ +- `Developer <#developer>`__ settings +- `config.json-only settings <#config-json-only-settings>`__ + +.. tip:: + + System admins managing a self-hosted Mattermost deployment can edit the ``config.json`` file as described in the following tables. Each configuration value below includes a JSON path to access the value programmatically in the ``config.json`` file using a JSON-aware tool. For example, the ``SiteURL`` value is under ``ServiceSettings``. - If using a tool such as `jq `__, you'd enter: ``cat config/config.json | jq '.ServiceSettings.SiteURL'`` - - When working with the ``config.json`` file manually, look for the key ``ServiceSettings``, then within that object, find the key ``SiteURL``. - -Both self-hosted and Cloud admins can access the following configuration settings in **System Console > Environment**. Self-hosted admins can also edit the ``config.json`` file as described in the following tables. + - When working with the ``config.json`` file manually, look for an object such as ``ServiceSettings``, then within that object, find the key ``SiteURL``. Web server ---------- diff --git a/source/configure/integrations-configuration-settings.rst b/source/configure/integrations-configuration-settings.rst index 6e7c6f36a70..de4d76dd538 100644 --- a/source/configure/integrations-configuration-settings.rst +++ b/source/configure/integrations-configuration-settings.rst @@ -4,13 +4,20 @@ Integrations configuration settings .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -Both self-hosted and Cloud admins can access the following configuration settings in **System Console > Integrations**. Self-hosted admins can also edit the ``config.json`` file as described in the following tables. +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**: - `Integrations management <#integrations-management>`__ - `Bot Accounts <#bot-acocunts>`__ - `GIF <#gif>`__ - `CORS <#cors>`__ +.. tip:: + + System admins managing a self-hosted Mattermost deployment can edit the ``config.json`` file as described in the following tables. Each configuration value below includes a JSON path to access the value programmatically in the ``config.json`` file using a JSON-aware tool. For example, the ``EnableIncomingWebhooks`` value is under ``ServiceSettings``. + + - If using a tool such as `jq `__, you'd enter: ``cat config/config.json | jq '.ServiceSettings.EnableIncomingWebhooks'`` + - When working with the ``config.json`` file manually, look for an object such as ``ServiceSettings``, then within that object, find the key ``EnableIncomingWebhooks``. + ---- Integrations management diff --git a/source/configure/optimize-your-workspace.rst b/source/configure/optimize-your-workspace.rst index c1ea6c95d3c..b382d684412 100644 --- a/source/configure/optimize-your-workspace.rst +++ b/source/configure/optimize-your-workspace.rst @@ -6,7 +6,7 @@ Optimize your Mattermost workspace 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. -System admins can access their workspace optimization page in the System Console by going to **Reporting > Workspace Optimization**. +System admins can access their workspace optimization page in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and going to **Reporting > Workspace Optimization**. .. image:: ../images/workspace-optimization.png :alt: Review your workspace health and growth scores, then take advantage of recommended optimizations. diff --git a/source/configure/plugins-configuration-settings.rst b/source/configure/plugins-configuration-settings.rst index b6e45cb01fa..b73cf0c051e 100644 --- a/source/configure/plugins-configuration-settings.rst +++ b/source/configure/plugins-configuration-settings.rst @@ -4,7 +4,29 @@ Plugins configuration settings .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -Self-hosted can manage the following configuration settings in **System Console > Plugins** or by editing the ``config.json`` file as described in the following tables. +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**: + +- `Plugin management <#plugin-management>`__ +- `Calls <#calls>`__ +- `GitLab <#gitlab>`__ +- `GitHub <#github>`__ +- `Jira <#jira>`__ +- `Legal Hold <#legal-hold>`__ +- `Microsoft Calendar <#microsoft-calendar>`__ +- `MS Teams <#ms-teams>`__ +- `Performance metrics <#performance-metrics>`__ +- `Collaborative playbooks <#collaborative-playbooks>`__ +- `User satisfaction surveys <#user-satisfaction-surveys>`__ +- `ServiceNow <#servicenow>`__ +- `Zoom <#zoom>`__ +- `config.json-only settings <#config-json-only-settings>`__ + +.. tip:: + + System admins managing a self-hosted Mattermost deployment can edit the ``config.json`` file as described in the following tables. Each configuration value below includes a JSON path to access the value programmatically in the ``config.json`` file using a JSON-aware tool. For example, the ``Enable`` value is under ``PluginSettings``. + + - If using a tool such as `jq `__, you'd enter: ``cat config/config.json | jq '.PluginSettings.Enable'`` + - When working with the ``config.json`` file manually, look for an object such as ``PluginSettings``, then within that object, find the key ``Enable``. ---- diff --git a/source/configure/reporting-configuration-settings.rst b/source/configure/reporting-configuration-settings.rst index c1e9f32558c..8635ca238e3 100644 --- a/source/configure/reporting-configuration-settings.rst +++ b/source/configure/reporting-configuration-settings.rst @@ -4,7 +4,7 @@ Reporting configuration settings .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -View statistics for your overall deployment and specific teams as well as access server logs by going to **System Console > Reporting**. The following reporting configuration settings are available: +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**: - `Site statistics <#site-statistics>`__ - `Team statistics <#team-statistics>`__ diff --git a/source/configure/self-hosted-account-settings.rst b/source/configure/self-hosted-account-settings.rst index 17830132411..79e8615d21f 100644 --- a/source/configure/self-hosted-account-settings.rst +++ b/source/configure/self-hosted-account-settings.rst @@ -4,7 +4,7 @@ Self-hosted workspace edition and license settings .. include:: ../_static/badges/allplans-selfhosted.rst :start-after: :nosearch: -Go to **System Console > About** to manage the following aspects of your self-hosted deployment: +Review and manage the following aspects of your self-hosted deployment by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **About**: - View the :doc:`edition ` of your Mattermost self-hosted deployment. - Manage your :doc:`product subscription `. diff --git a/source/configure/site-configuration-settings.rst b/source/configure/site-configuration-settings.rst index 023051471b9..fca99e6a6b8 100644 --- a/source/configure/site-configuration-settings.rst +++ b/source/configure/site-configuration-settings.rst @@ -4,7 +4,7 @@ Site configuration settings .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -Both self-hosted and Cloud admins can access the following configuration settings in the System Console by going to **Site Configuration**. Self-hosted admins can also edit the ``config.json`` file as described in the following tables. +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**: - `Customization <#customization>`__ - `Localization <#localization>`__ @@ -18,6 +18,13 @@ Both self-hosted and Cloud admins can access the following configuration setting - `Notices <#notices>`__ - `Connected Workspaces <#connected-workspaces>`__ +.. tip:: + + System admins managing a self-hosted Mattermost deployment can edit the ``config.json`` file as described in the following tables. Each configuration value below includes a JSON path to access the value programmatically in the ``config.json`` file using a JSON-aware tool. For example, the ``SiteName`` value is under ``TeamSettings``. + + - If using a tool such as `jq `__, you'd enter: ``cat config/config.json | jq '.TeamSettings.SiteName'`` + - When working with the ``config.json`` file manually, look for an object such as ``TeamSettings``, then within that object, find the key ``SiteName``. + ---- Customization diff --git a/source/configure/user-management-configuration-settings.rst b/source/configure/user-management-configuration-settings.rst index 4db556da040..f8271b84e1e 100644 --- a/source/configure/user-management-configuration-settings.rst +++ b/source/configure/user-management-configuration-settings.rst @@ -4,7 +4,7 @@ User management configuration settings .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -Manage your Mattermost users including their access permissions, groups, teams, channels, as well as their access to the System Console. Access user management options in the System Console by going to **User Management**: +Review and manage the following in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **User Management**: - `Users <#users>`__ - `Groups <#groups>`__ diff --git a/source/guides/administration.rst b/source/guides/administration.rst index d83f3da82fb..a265506b546 100644 --- a/source/guides/administration.rst +++ b/source/guides/administration.rst @@ -14,7 +14,11 @@ Manage Mattermost Self-hosted administration Other resources -This guide is for people who administer an existing Mattermost server. It’s divided into four parts: +This guide is for people who administer an existing Mattermost server using the System Console, the ``config.json`` file, or through the management of environment variables. + +As a system admin, access the System Console by selecting the **Product** |product-list| menu and selecting **System Console**. + +This administrative guide is divided into 4 parts: * :doc:`Get started ` - An overview of standard configurations and features for both self-hosted and Cloud deployments. * :doc:`Cloud workspace management ` - Detailed information about admin capabilities of Mattermost Cloud deployments. diff --git a/source/guides/get-started-with-administration.rst b/source/guides/get-started-with-administration.rst index 8eca98b1137..bc687ad7514 100644 --- a/source/guides/get-started-with-administration.rst +++ b/source/guides/get-started-with-administration.rst @@ -38,6 +38,10 @@ Get started with administration These resources will help you get started with your Mattermost self-hosted or Cloud workspace. +.. tip:: + + As a system admin, access the System Console by selecting the **Product** |product-list| menu and selecting **System Console**. + * **Mattermost feature labels** - Learn what :doc:`Mattermost feature labels `, including :ref:`Experimental `, :ref:`Beta `, :ref:`General Availability `, and :ref:`Deprecated ` mean to the status, maturity, and support level of Mattermost product features and functionality in your Mattermost deployment. * **Optimize your workspace** - Review health and growth scores for your Mattermost workspace, and take necessary action using the :doc:`workspace optimization ` page in the System Console. * **Configure your workspace** - Mattermost offers extensive configuration options for both :doc:`self-hosted Mattermost servers and Mattermost Cloud workspaces `, and provides a list of :doc:`deprecated configuration settings ` no longer supported. diff --git a/source/manage/cloud-ip-filtering.rst b/source/manage/cloud-ip-filtering.rst index 62edeb83bf3..d6f0168fe4f 100644 --- a/source/manage/cloud-ip-filtering.rst +++ b/source/manage/cloud-ip-filtering.rst @@ -9,8 +9,8 @@ IP filtering is a powerful security feature that allows system admins to control Configure IP filtering ------------------------ -1. **Log in as system admin**: Access the System Console of your workspace, ensuring your user is a system admin. -2. **Go to Site Configuration**: Once logged in, go to the **Site Configuration** section. +1. **Log in as system admin**: As a system admin, access the System Console of your workspace by selecting the **Product** |product-list| menu and selecting **System Console**. +2. **Go to Site Configuration**: Go to the **Site Configuration** section. 3. **Access IP Filtering Settings**: Under **Site Configuration**, select **IP Filtering** to access the IP Filtering settings. .. image:: ../images/system-console-ip-filtering.png