Skip to content

Commit

Permalink
Merge branch 'master' into install-docs-updates
Browse files Browse the repository at this point in the history
  • Loading branch information
cwarnermm authored Feb 19, 2025
2 parents ddff5a0 + 1867052 commit 31e3535
Show file tree
Hide file tree
Showing 14 changed files with 554 additions and 510 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,4 @@ source/developer/localization.md
# Generated PKI files
*.key
*.crt
.aider*
45 changes: 45 additions & 0 deletions fix_config_settings.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import re
import sys
from pathlib import Path

if len(sys.argv) != 2:
print("Usage: python fix_config_settings.py <rst_file_path>")
sys.exit(1)

def to_slug(text):
# Convert text to lowercase and replace spaces with hyphens
slug = text.lower().replace(' ', '-')
# Remove any characters that aren't alphanumeric or hyphens
slug = re.sub(r'[^a-z0-9-]', '', slug)
# Replace multiple hyphens with single hyphen
slug = re.sub(r'-+', '-', slug)
return slug

def process_file(filepath):
with open(filepath, 'r', encoding='utf-8') as f:
content = f.read()

# Find all config:setting directives and their associated headings
pattern = r'\.\.[\s]*config:setting::[\s]*([^\n]+)[\s\S]*?(?=^[^\s#].*$\n[-~=]+$)(.*?)\n[-~=]+'
matches = re.finditer(pattern, content, re.MULTILINE)

for match in matches:
directive_value = match.group(1).strip()
heading = match.group(2).strip()

# Convert heading to slug format
heading_slug = to_slug(heading)

if directive_value != heading_slug:
# Replace the directive value with the heading slug
old_directive = f'.. config:setting:: {directive_value}'
new_directive = f'.. config:setting:: {heading_slug}'
content = content.replace(old_directive, new_directive)

# Write the modified content back to the file
with open(filepath, 'w', encoding='utf-8') as f:
f.write(content)

if __name__ == '__main__':
filepath = sys.argv[1]
process_file(filepath)
2 changes: 1 addition & 1 deletion source/about/mattermost-mobile-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ We strongly recommend using the latest mobile app release available that contain

| **Release** | **Released on** | **Support ends** | **Compatible with** |
|:---|:---|:---|:---|
| v2.25 {ref}`FEATURE <release-v2-25-0>` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.25.0) \| {ref}`Changelog <release-v2-25-0>` | 2025-02-16 | 2025-03-15 | {ref}`v10.5 <release-v10-5-extended-support-release>`, {ref}`v10.4 <release-v10.4-feature-release>`, {ref}`v10.3 <release-v10.3-feature-release>`, {ref}`v9.11 <release-v9-11-extended-support-release>` |
| v2.25 {ref}`FEATURE <release-v2-25-0>` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.25.0) \| {ref}`Changelog <release-v2-25-0>` | 2025-02-16 | 2025-03-15 | {ref}`v10.5 <release-v10.5-extended-support-release>`, {ref}`v10.4 <release-v10.4-feature-release>`, {ref}`v10.3 <release-v10.3-feature-release>`, {ref}`v9.11 <release-v9-11-extended-support-release>` |
| v2.24 {ref}`FEATURE <release-v2-24-1>` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.24.1) \| {ref}`Changelog <release-v2-24-1>` | 2025-01-16 | 2025-02-15 | {ref}`v10.4 <release-v10.4-feature-release>`, {ref}`v10.3 <release-v10.3-feature-release>`, {ref}`v10.2 <release-v10.2-feature-release>`, {ref}`v9.11 <release-v9-11-extended-support-release>` |
| v2.23 {ref}`FEATURE <release-v2-23-1>` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.23.1) \| {ref}`Changelog <release-v2-23-1>` | 2024-12-16 | 2025-01-15 | {ref}`v10.3 <release-v10.3-feature-release>`, {ref}`v10.2 <release-v10.2-feature-release>`, {ref}`v10.1 <release-v10.1-feature-release>`, {ref}`v9.11 <release-v9-11-extended-support-release>` |
| v2.22 {ref}`FEATURE <release-v2-22-0>` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.22.0) \| {ref}`Changelog <release-v2-22-0>` | 2024-11-15 | 2024-12-15 | {ref}`v10.2 <release-v10.2-feature-release>`, {ref}`v10.1 <release-v10.1-feature-release>`, {ref}`v10.0 <release-v10.0-major-release>`, {ref}`v9.11 <release-v9-11-extended-support-release>`, {ref}`v9.5 <release-v9-5-extended-support-release>` |
Expand Down
164 changes: 82 additions & 82 deletions source/configure/authentication-configuration-settings.rst

Large diffs are not rendered by default.

40 changes: 20 additions & 20 deletions source/configure/compliance-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Changes to properties in this section require a server restart before taking eff

Access the following configuration settings in the System Console by going to **Compliance > Data Retention Policies**.

.. config:setting:: dataretention-globalmessagepolicy
.. config:setting:: global-retention-policy-for-messages
:displayname: Global retention policy for messages (Data Retention)
:systemconsole: Compliance > Data Retention Policies
:configjson: .DataRetentionSettings.MessageRetentionDays
Expand All @@ -61,7 +61,7 @@ By default, messages are kept forever. If **Hours**, **Days**, or **Years** is c

From Mattermost v9.5, when a ``MessageRetentionHours`` value is configured, the ``MessageRetentionDays`` value must be 0 in the ``config.json`` file. Conversely, when a ``MessageRetentionDays`` value is configured, the ``MessageRetentionHours`` value must be ``0``.

.. config:setting:: dataretention-globalfilepolicy
.. config:setting:: global-retention-policy-for-files
:displayname: Global retention policy for files (Data Retention)
:systemconsole: Compliance > Data Retention Policies
:configjson: .DataRetentionSettings.FileRetentionDays
Expand All @@ -87,7 +87,7 @@ By default, files are kept forever. If **Hours**, **Days**, or **Years** is chos

From Mattermost v9.5, when a ``FileRetentionHours`` value is configured, the ``FileRetentionDays`` value must be 0 in the ``config.json`` file. Conversely, when a ``FileRetentionDays`` value is configured, the ``FileRetentionHours`` value must be ``0``.

.. config:setting:: dataretention-customretentionpolicy
.. config:setting:: custom-retention-policy
:displayname: Custom retention policy (Data Retention)
:systemconsole: Compliance > Data Retention Policies
:configjson: .DataRetentionSettings.DeletionJobStartTime
Expand All @@ -103,7 +103,7 @@ Custom retention policy

Set how long Mattermost keeps messages and files across specific teams and channels by specifying a name for the custom retention policy, setting a duration value in days or years, and specifying the teams and channels that will follow this policy.

.. config:setting:: dataretention-deletiontime
.. config:setting:: data-deletion-time
:displayname: Data deletion time (Data Retention)
:systemconsole: Compliance > Data Retention Policies
:configjson: .DataRetentionSettings.DeletionJobStartTime
Expand Down Expand Up @@ -144,7 +144,7 @@ Compliance export

Access the following configuration settings in the System Console by going to **Compliance > Compliance Export**.

.. config:setting:: compliance-exportenable
.. config:setting:: enable-compliance-export
:displayname: Enable compliance export (Compliance Export)
:systemconsole: Compliance > Compliance Export
:configjson: .MessageExportSettings.EnableExport
Expand All @@ -166,7 +166,7 @@ Enable compliance export
| This feature's ``config.json`` setting is ``"EnableExport": false`` with options ``true`` and ``false``. |
+----------------------------------------------------------------------------------------------------------+

.. config:setting:: compliance-exporttime
.. config:setting:: compliance-export-time
:displayname: Compliance export time (Compliance Export)
:systemconsole: Compliance > Compliance Export
:configjson: .MessageExportSettings.DailyRunTime
Expand All @@ -186,7 +186,7 @@ This setting is based on the local time of the server.
| This feature's ``config.json`` setting is ``"DailyRunTime": 01:00`` with 24-hour timestamp input in the form ``"HH:MM"``. |
+---------------------------------------------------------------------------------------------------------------------------+

.. config:setting:: compliance-exportformat
.. config:setting:: export-file-format
:displayname: Export file format (Compliance Export)
:systemconsole: Compliance > Compliance Export
:configjson: .MessageExportSettings.ExportFormat
Expand All @@ -204,7 +204,7 @@ Currently supported formats are CSV, Actiance XML, and Global Relay EML.

If Global Relay is chosen, the following options will be presented:

.. config:setting:: compliance-exportglobalrelaycustomertype
.. config:setting:: global-relay-customer-account
:displayname: Global Relay customer account (Compliance Export - Global Relay EML)
:systemconsole: Compliance > Compliance Export
:configjson: .MessageExportSettings.GlobalRelaySettings.CustomerType
Expand All @@ -222,7 +222,7 @@ Type of Global Relay customer account your organization has. Can be one of: ``A9
| This feature's ``config.json`` setting is ``"CustomerType": "A9"`` with options ``"A9``, ``"A10"``, and ``CUSTOM``. |
+---------------------------------------------------------------------------------------------------------------------+

.. config:setting:: compliance-exportglobalrelaysmtpuser
.. config:setting:: global-relay-smtp-username
:displayname: Global Relay SMTP username (Compliance Export - Global Relay EML)
:systemconsole: Compliance > Compliance Export
:configjson: .MessageExportSettings.GlobalRelaySettings.SmtpUsername
Expand All @@ -240,7 +240,7 @@ The username for authenticating to the Global Relay SMTP server.
| This feature's ``config.json`` setting is ``"SmtpUsername": ""`` with string input. |
+-------------------------------------------------------------------------------------+

.. config:setting:: compliance-exportglobalrelaysmtppassword
.. config:setting:: global-relay-smtp-password
:displayname: Global Relay SMTP password (Compliance Export - Global Relay EML)
:systemconsole: Compliance > Compliance Export
:configjson: .MessageExportSettings.GlobalRelaySettings.SMTPPassword
Expand All @@ -258,7 +258,7 @@ The password associated with the Global Relay SMTP username.
| This feature's ``config.json`` setting is ``"SmtpPassword": ""`` with string input. |
+-------------------------------------------------------------------------------------+

.. config:setting:: compliance-exportglobalrelayemail
.. config:setting:: global-relay-email-address
:displayname: Global Relay email address (Compliance Export - Global Relay EML)
:systemconsole: Compliance > Compliance Export
:configjson: .MessageExportSettings.GlobalRelaySettings.EmailAddress
Expand All @@ -276,7 +276,7 @@ The email address your Global Relay server monitors for incoming compliance expo
| This feature's ``config.json`` setting is ``"EmailAddress": ""`` with string input. |
+-------------------------------------------------------------------------------------+

.. config:setting:: compliance-exportglobalrelaysmtpserver
.. config:setting:: smtp-server-name
:displayname: SMTP server name (Compliance Export - Global Relay EML)
:systemconsole: Compliance > Compliance Export
:configjson: .MessageExportSettings.GlobalRelaySettings.CustomSMTPServerName
Expand All @@ -292,7 +292,7 @@ The SMTP server name URL that will receive your Global Relay EML file when a `cu
| This feature's ``config.json`` setting is ``".MessageExportSettings.GlobalRelaySettings.CustomSMTPServerName": ""`` with string input. |
+----------------------------------------------------------------------------------------------------------------------------------------+

.. config:setting:: compliance-exportglobalrelaysmtpport
.. config:setting:: smtp-server-port
:displayname: SMTP server port (Compliance Export - Global Relay EML)
:systemconsole: Compliance > Compliance Export
:configjson: .MessageExportSettings.GlobalRelaySettings.CustomSMTPPort
Expand Down Expand Up @@ -327,7 +327,7 @@ Settings used to enable and configure Mattermost compliance reports.

Access the following configuration settings in the System Console by going to **Compliance > Compliance Monitoring**.

.. config:setting:: compliance-monitorenable
.. config:setting:: enable-compliance-reporting
:displayname: Enable compliance reporting (Compliance Monitoring)
:systemconsole: Compliance > Compliance Monitoring
:configjson: .ComplianceSettings.Enable
Expand All @@ -349,7 +349,7 @@ Enable compliance reporting
| This feature's ``config.json`` setting is ``"Enable": false`` with options ``true`` and ``false``. |
+----------------------------------------------------------------------------------------------------+

.. config:setting:: compliance-monitordirectory
.. config:setting:: compliance-report-directory
:displayname: Compliance report directory (Compliance Monitoring)
:systemconsole: Compliance > Compliance Monitoring
:configjson: .ComplianceSettings.Directory
Expand All @@ -367,7 +367,7 @@ Sets the directory where compliance reports are written.
| This feature's ``config.json`` setting is ``"Directory": "./data/"`` with string input. |
+-----------------------------------------------------------------------------------------+

.. config:setting:: compliance-monitorenabledaily
.. config:setting:: enable-compliance-reportingdaily
:displayname: Enable daily report (Compliance Monitoring)
:systemconsole: Compliance > Compliance Monitoring
:configjson: .ComplianceSettings.EnableDaily
Expand All @@ -389,7 +389,7 @@ Enable daily report
| This feature's ``config.json`` setting is ``"EnableDaily": false`` with options ``true`` and ``false``. |
+---------------------------------------------------------------------------------------------------------+

.. config:setting:: compliance-monitorbatchsize
.. config:setting:: batch-size
:displayname: Batch size (Compliance Monitoring)
:systemconsole: Compliance > Compliance Monitoring
:configjson: .ComplianceSettings.BatchSize
Expand Down Expand Up @@ -417,7 +417,7 @@ Custom terms of service

Access the following configuration settings in the System Console by going to **Compliance > Custom Terms of Service**.

.. config:setting:: compliance-ctosenable
.. config:setting:: enable-custom-terms-of-service
:displayname: Enable custom terms of service (Custom Terms of Service)
:systemconsole: Compliance > Custom Terms of Service
:configjson: .SupportSettings.CustomTermsOfServiceEnabled
Expand All @@ -438,7 +438,7 @@ Enable custom terms of service

**False**: During account creation or login, users can review Terms of Service by accessing the link configured via **System Console > Legal and Support > Terms of Service link**.

.. config:setting:: compliance-ctostext
.. config:setting:: custom-terms-of-service-text
:displayname: Custom terms of service text (Custom Terms of Service)
:systemconsole: Compliance > Custom Terms of Service
:configjson: N/A
Expand All @@ -452,7 +452,7 @@ Custom terms of service text

Text that will appear in your custom Terms of Service. Supports Markdown-formatted text.

.. config:setting:: compliance-ctosreacceptanceperiod
.. config:setting:: re-acceptance-period
:displayname: Re-acceptance period (Custom Terms of Service)
:systemconsole: Compliance > Custom Terms of Service
:configjson: .SupportSettings.CustomTermsOfServiceReAcceptancePeriod
Expand Down
Loading

0 comments on commit 31e3535

Please sign in to comment.