Skip to content

DocsBrokenWindow: Migrate experimental config settings to consistent format #8166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

DocsBrokenWindow: Migrate experimental config settings to consistent format #8166

wants to merge 12 commits into from
+939 −707

Conversation

cwarnermm
Copy link
Member

Addresses issue #8157

Convert experimental configuration settings from single-column to standard two-column table format for consistency with other configuration documentation.

Changes

  • Converted 47+ of 53 experimental settings to standard two-column format
  • Left column: Description, options, defaults
  • Right column: System Config path, config.json setting, Environment variable
  • Improved readability and consistency across all experimental settings sections
  • Maintained all existing content while standardizing presentation

Fixes inconsistent formatting identified in user feedback where experimental settings didn't follow the standard model used by other configuration settings.

🤖 Generated with Claude Code

@claude @cwarnermm
Migrate experimental config settings to consistent format
77f6681 
Convert experimental configuration settings from single-column to standard two-column table format for consistency with other configuration documentation.

Key changes:
- Converted 47+ of 53 experimental settings to standard two-column format
- Left column: Description, options, defaults
- Right column: System Config path, config.json setting, Environment variable
- Improved readability and consistency across all experimental settings sections
- Maintained all existing content while standardizing presentation

Fixes inconsistent formatting identified in user feedback where experimental 
settings didn't follow the standard model used by other configuration settings.

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>
@cwarnermm cwarnermm added the 2: Editor Review Requires review by an editor label Jul 7, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 7, 2025

Newest code from mattermost has been published to preview environment for Git SHA 77f6681

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 8, 2025

Newest code from mattermost has been published to preview environment for Git SHA 037d91e

@github-actions GitHub Actions
Copy link

Newest code from mattermost has been published to preview environment for Git SHA efad283

@cwarnermm
Copy link
Member Author

LoginButtonColor

  • EmailSettings Default: #0000
  • LdapSettings Default: #0000
  • SamlSettings Default: #34a28b
  • Possible Values: Any hex color code string
  • Environment Variables: MM_EMAILSETTINGS_LOGINBUTTONCOLOR,
    MM_LDAPSETTINGS_LOGINBUTTONCOLOR, MM_SAMLSETTINGS_LOGINBUTTONCOLOR

LoginButtonBorderColor

  • EmailSettings Default: #2389D7
  • LdapSettings Default: #2389D7
  • SamlSettings Default: #2389D7
  • Possible Values: Any hex color code string
  • Environment Variables: MM_EMAILSETTINGS_LOGINBUTTONBORDERCOLOR,
    MM_LDAPSETTINGS_LOGINBUTTONBORDERCOLOR,
    MM_SAMLSETTINGS_LOGINBUTTONBORDERCOLOR

LoginButtonTextColor

  • EmailSettings Default: #2389D7
  • LdapSettings Default: #2389D7
  • SamlSettings Default: #ffffff
  • Possible Values: Any hex color code string
  • Environment Variables: MM_EMAILSETTINGS_LOGINBUTTONTEXTCOLOR,
    MM_LDAPSETTINGS_LOGINBUTTONTEXTCOLOR,
    MM_SAMLSETTINGS_LOGINBUTTONTEXTCOLOR

Link and Email Settings

LinkMetadataTimeoutMilliseconds

  • Default: 5000 (5 seconds)
  • Possible Values: Any positive integer (> 0)
  • Environment Variable:
    MM_EXPERIMENTALSETTINGS_LINKMETADATATIMEOUTMILLISECONDS

EmailBatchingBufferSize

  • Default: 256
  • Possible Values: Any positive integer (> 0)
  • Environment Variable: MM_EMAILSETTINGS_EMAILBATCHINGBUFFERSIZE

EmailBatchingInterval

  • Default: 30 seconds
  • Possible Values: Any integer ≥ 30
  • Environment Variable: MM_EMAILSETTINGS_EMAILBATCHINGINTERVAL

User and Team Settings

EnableUserDeactivation

  • Default: false
  • Possible Values: true or false
  • Environment Variable: MM_TEAMSETTINGS_ENABLEUSERDEACTIVATION

ExperimentalEnableAutomaticReplies

  • Default: false
  • Possible Values: true or false
  • Environment Variable:
    MM_TEAMSETTINGS_EXPERIMENTALENABLEAUTOMATICREPLIES

ExperimentalPrimaryTeam

  • Default: "" (empty string)
  • Possible Values: Any string (team name)
  • Environment Variable: MM_TEAMSETTINGS_EXPERIMENTALPRIMARYTEAM

Channel and Message Settings

EnableChannelViewedMessages

  • Default: true
  • Possible Values: true or false
  • Environment Variable: MM_SERVICESETTINGS_ENABLECHANNELVIEWEDMESSAGES

ExperimentalEnableDefaultChannelLeaveJoinMessages

  • Default: true
  • Possible Values: true or false
  • Environment Variable:
    MM_SERVICESETTINGS_EXPERIMENTALENABLEDEFAULTCHANNELLEAVEJOINMESSAGES

EnableUserTypingMessages

  • Default: true
  • Possible Values: true or false
  • Environment Variable: MM_SERVICESETTINGS_ENABLEUSERTYPINGMESSAGES

TimeBetweenUserTypingUpdatesMilliseconds

  • Default: 5000 (5 seconds)
  • Possible Values: Any positive integer
  • Environment Variable:
    MM_SERVICESETTINGS_TIMEBETWEENUSERTYPINGUPDATESMILLISECONDS

Security Settings

ExperimentalEnableHardenedMode

  • Default: false
  • Possible Values: true or false
  • Environment Variable: MM_SERVICESETTINGS_EXPERIMENTALENABLEHARDENEDMODE

Theme Settings

EnableThemeSelection

  • Default: true
  • Possible Values: true or false
  • Environment Variable: MM_THEMESETTINGS_ENABLETHEMESELECTION

AllowCustomThemes

  • Default: true
  • Possible Values: true or false
  • Environment Variable: MM_THEMESETTINGS_ALLOWCUSTOMTHEMES

DefaultTheme

  • Default: "default"
  • Possible Values: Any string (theme name)
  • Environment Variable: MM_THEMESETTINGS_DEFAULTTHEME

Tutorial and Onboarding Settings

EnableTutorial

  • Default: true
  • Possible Values: true or false
  • Environment Variable: MM_SERVICESETTINGS_ENABLETUTORIAL

EnableOnboardingFlow

  • Default: true
  • Possible Values: true or false
  • Environment Variable: MM_SERVICESETTINGS_ENABLEONBOARDINGFLOW

@github-actions GitHub Actions
Copy link

Newest code from mattermost has been published to preview environment for Git SHA bcfdea6

@github-actions GitHub Actions
Copy link

Newest code from mattermost has been published to preview environment for Git SHA 53f73d0

@cwarnermm
Copy link
Member Author

@claude - Incorporate the configuration setting defaults, possible values, and environment variable details via #8166 (comment)

@claude Claude
Copy link
Contributor

claude bot commented Jul 11, 2025 •
edited
Loading

Claude finished @cwarnermm's task —— View job

Configuration settings successfully updated! ✅

Completed Tasks:

  • Read the current experimental-configuration-settings.rst file
  • Analyze the configuration details from the previous comment
  • Update LoginButtonColor settings with environment variables and defaults
  • Update LoginButtonBorderColor settings with environment variables and defaults
  • Update LoginButtonTextColor settings with environment variables and defaults
  • Update EmailBatchingBufferSize with environment variable
  • Update EmailBatchingInterval with environment variable
  • Update EnableUserDeactivation with environment variable
  • Update EnableThemeSelection with environment variable
  • Update AllowCustomThemes with environment variable
  • Update DefaultTheme with environment variable
  • Update LinkMetadataTimeoutMilliseconds with environment variable
  • Update SAML login button settings with environment variables and defaults
  • Commit and push changes

Summary

Successfully incorporated all the configuration setting details from your comment into the experimental configuration settings documentation. The updates include:

Login Button Settings Updated:

  • AD/LDAP LoginButtonColor: Added env var MM_LDAPSETTINGS_LOGINBUTTONCOLOR and default #0000
  • AD/LDAP LoginButtonBorderColor: Added env var MM_LDAPSETTINGS_LOGINBUTTONBORDERCOLOR and default #2389D7
  • AD/LDAP LoginButtonTextColor: Added env var MM_LDAPSETTINGS_LOGINBUTTONTEXTCOLOR and default #2389D7
  • Email LoginButtonColor: Added env var MM_EMAILSETTINGS_LOGINBUTTONCOLOR and default #0000
  • Email LoginButtonBorderColor: Added env var MM_EMAILSETTINGS_LOGINBUTTONBORDERCOLOR and default #2389D7
  • Email LoginButtonTextColor: Added env var MM_EMAILSETTINGS_LOGINBUTTONTEXTCOLOR and default #2389D7
  • SAML LoginButtonColor: Added env var MM_SAMLSETTINGS_LOGINBUTTONCOLOR and default #34a28b
  • SAML LoginButtonBorderColor: Added env var MM_SAMLSETTINGS_LOGINBUTTONBORDERCOLOR and default #2389D7
  • SAML LoginButtonTextColor: Added env var MM_SAMLSETTINGS_LOGINBUTTONTEXTCOLOR and default #ffffff

Other Settings Updated:

  • EmailBatchingBufferSize: Added env var MM_EMAILSETTINGS_EMAILBATCHINGBUFFERSIZE
  • EmailBatchingInterval: Added env var MM_EMAILSETTINGS_EMAILBATCHINGINTERVAL
  • EnableUserDeactivation: Added env var MM_TEAMSETTINGS_ENABLEUSERDEACTIVATION
  • EnableThemeSelection: Added env var MM_THEMESETTINGS_ENABLETHEMESELECTION
  • AllowCustomThemes: Added env var MM_THEMESETTINGS_ALLOWCUSTOMTHEMES
  • DefaultTheme: Added env var MM_THEMESETTINGS_DEFAULTTHEME
  • LinkMetadataTimeoutMilliseconds: Added env var MM_EXPERIMENTALSETTINGS_LINKMETADATATIMEOUTMILLISECONDS

All settings now maintain the consistent two-column table format with proper environment variables and default values. The changes have been committed and pushed to the PR branch.

@claude @cwarnermm
Update experimental config settings with environment variables and de…
c891b06 
…faults

- Add environment variables for login button color settings (AD/LDAP, Email, SAML)
- Add environment variables for email batching settings
- Add environment variables for user deactivation and theme settings
- Include proper default values for all login button color settings
- Ensure consistent two-column table format across all settings

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>
@github-actions GitHub Actions
Copy link

Newest code from mattermost has been published to preview environment for Git SHA c891b06

@github-actions GitHub Actions
Copy link

Newest code from mattermost has been published to preview environment for Git SHA fc3d1f7

@github-actions GitHub Actions
Copy link

Newest code from mattermost has been published to preview environment for Git SHA 05fb6dd

@cwarnermm
Copy link
Member Author

ServiceSettings

  • MM_SERVICESETTINGS_ENABLECHANNELVIEWEDMESSAGES
  • MM_SERVICESETTINGS_ENABLETUTORIAL
  • MM_SERVICESETTINGS_ENABLEONBOARDINGFLOW
  • MM_SERVICESETTINGS_ENABLEUSERTYPINGMESSAGES
  • MM_SERVICESETTINGS_TIMEBETWEENUSERTYPINGUPDATESMILLISECONDS
  • MM_SERVICESETTINGS_ENABLEPOSTSEARCH
  • MM_SERVICESETTINGS_ENABLEFILESEARCH
  • MM_SERVICESETTINGS_ENABLEUSERSTATUSES
  • MM_SERVICESETTINGS_WEBSOCKETSECUREPORT
  • MM_SERVICESETTINGS_WEBSOCKETPORT
  • MM_SERVICESETTINGS_ENABLELOCALMODE
  • MM_SERVICESETTINGS_LOCALMODESOCKETLOCATION
  • MM_SERVICESETTINGS_DEVELOPERFLAGS

Fields Actually in TeamSettings (not ServiceSettings)

  • MM_TEAMSETTINGS_EXPERIMENTALENABLEAUTOMATICREPLIES
  • MM_TEAMSETTINGS_EXPERIMENTALPRIMARYTEAM
  • MM_TEAMSETTINGS_USERSTATUSAWAYTIMEOUT
  • MM_TEAMSETTINGS_EXPERIMENTALDEFAULTCHANNELS

Fields Actually in EmailSettings

  • MM_EMAILSETTINGS_USECHANNELINEMAILNOTIFICATIONS
  • MM_EMAILSETTINGS_PUSHNOTIFICATIONBUFFER

ExperimentalSettings

  • MM_EXPERIMENTALSETTINGS_RESTRICTSYSTEMADMIN
  • MM_EXPERIMENTALSETTINGS_CLIENTSIDECERTENABLE
  • MM_EXPERIMENTALSETTINGS_CLIENTSIDECERTCHECK

Fields Actually in FileSettings

  • MM_FILESETTINGS_MAXIMAGERESOLUTION
  • MM_FILESETTINGS_MAXIMAGEDECODERCONCURRENCY
  • MM_FILESETTINGS_INITIALFONT
  • MM_FILESETTINGS_AMAZONS3SIGNV2

Fields Actually in Other Settings

  • MM_METRICSSETTINGS_BLOCKPROFILERATE
  • MM_PLUGINSETTINGS_ENABLEUPLOADS
  • MM_PLUGINSETTINGS_ALLOWINSECUREDOWNLOADURL
  • MM_PLUGINSETTINGS_ENABLEHEALTHCHECK
  • MM_PLUGINSETTINGS_DIRECTORY
  • MM_PLUGINSETTINGS_CLIENTDIRECTORY

BleveSettings

  • MM_BLEVESETTINGS_ENABLEINDEXING
  • MM_BLEVESETTINGS_INDEXDIR
  • MM_BLEVESETTINGS_ENABLESEARCHING
  • MM_BLEVESETTINGS_ENABLEAUTOCOMPLETE

ExperimentalAuditSettings

  • MM_EXPERIMENTALAUDITSETTINGS_ADVANCEDLOGGINGJSON
  • MM_EXPERIMENTALAUDITSETTINGS_FILEMAXBACKUPS

ThemeSettings

  • MM_THEMESETTINGS_ALLOWEDTHEMES

ComplianceSettings

  • MM_COMPLIANCESETTINGS_DIRECTORY

ExportSettings

  • MM_EXPORTSETTINGS_DIRECTORY
  • MM_EXPORTSETTINGS_RETENTIONDAYS

ImportSettings

  • MM_IMPORTSETTINGS_DIRECTORY
  • MM_IMPORTSETTINGS_RETENTIONDAYS

MessageExportSettings

  • MM_MESSAGEEXPORTSETTINGS_EXPORTFROMTIMESTAMP
  • MM_MESSAGEEXPORTSETTINGS_GLOBALRELAYSETTINGS_SMTPSERVERTIMEOUT

OAuth Settings

  • MM_GOOGLESETTINGS_SCOPE
  • MM_OFFICE365SETTINGS_SCOPE

SamlSettings

  • MM_SAMLSETTINGS_SCOPINGIDPPROVIDERID
  • MM_SAMLSETTINGS_SCOPINGIDPNAME

JobSettings

  • MM_JOBSETTINGS_RUNJOBS
  • MM_JOBSETTINGS_RUNSCHEDULER
  • MM_JOBSETTINGS_CLEANUPJOBSTHRESHOLDDAYS
  • MM_JOBSETTINGS_CLEANUPCONFIGTHRESHOLDDAYS

@cwarnermm
Copy link
Member Author

@claude - ensure the environment variables in #8166 (comment) are added to the file for each config setting where applicable

@claude Claude
Copy link
Contributor

claude bot commented Jul 15, 2025 •
edited
Loading

Claude encountered an error —— View job

Working on adding environment variables to experimental configuration settings...

Task: Add Environment Variables to Configuration Settings

Todo List:

  • Read the current experimental-configuration-settings.rst file
  • Analyze the environment variables from the comment
  • Map environment variables to configuration settings
  • Update ServiceSettings environment variables (13 settings updated)
  • Update TeamSettings environment variables (4 settings updated)
  • Update EmailSettings environment variables (2 settings updated)
  • Update ExperimentalSettings environment variables (3 settings updated)
  • Update FileSettings environment variables (4 settings updated)
  • Update Other Settings environment variables (MetricsSettings, PluginSettings, etc.)
  • Update BleveSettings environment variables
  • Update ExperimentalAuditSettings environment variables
  • Update ThemeSettings environment variables
  • Update ComplianceSettings environment variables
  • Update ExportSettings environment variables
  • Update ImportSettings environment variables
  • Update MessageExportSettings environment variables
  • Update OAuth Settings environment variables
  • Update SamlSettings environment variables
  • Update JobSettings environment variables
  • Commit and push changes

Progress Update

✅ ServiceSettings Complete - Updated 13 configuration settings with their environment variables
✅ TeamSettings Complete - Updated 4 configuration settings with their environment variables
✅ EmailSettings Complete - Updated 2 configuration settings with their environment variables
✅ ExperimentalSettings Complete - Updated 3 configuration settings with their environment variables
✅ FileSettings Complete - Updated 4 configuration settings with their environment variables

@github-actions GitHub Actions
Copy link

Newest code from mattermost has been published to preview environment for Git SHA 54801cb

@cwarnermm
Copy link
Member Author

Ready for final preview review.

@github-actions GitHub Actions
Copy link

Newest code from mattermost has been published to preview environment for Git SHA 4f9fa23

@github-actions GitHub Actions
Copy link

Newest code from mattermost has been published to preview environment for Git SHA d9d4658

@cwarnermm cwarnermm changed the title Migrate experimental config settings to consistent format DocsBrokenWindow: Migrate experimental config settings to consistent format Oct 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

2: Editor Review Requires review by an editor Guidance

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@cwarnermm