From e6981651755ab25fdafd98ab5338c9a517527a15 Mon Sep 17 00:00:00 2001 From: Vishal Date: Tue, 14 Jan 2025 17:59:53 +0530 Subject: [PATCH 01/23] Update manual-postgres-migration.rst (#7687) * Update manual-postgres-migration.rst Copy the MM config from MySQL DB not from postgres. --------- Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> --- source/deploy/manual-postgres-migration.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/deploy/manual-postgres-migration.rst b/source/deploy/manual-postgres-migration.rst index 7a82fec0477..bc67a5eb136 100644 --- a/source/deploy/manual-postgres-migration.rst +++ b/source/deploy/manual-postgres-migration.rst @@ -295,7 +295,7 @@ Use the ``mmctl config migrate`` command to :ref:`migrate your config :@:5432/?sslmode=disable&connect_timeout=10" /opt/mattermost/config/config.json --local + mmctl config migrate ":@tcp(:3306)/?charset=utf8mb4,utf8&readTimeout=30s&writeTimeout=30s&multiStatements=true" /opt/mattermost/config/config.json --local Where ````, ````, ````, and ```` are replaced with your environment values. Ensure you use ``--local`` when running this command. The first parameters (````, ````) is the database the configuration is stored in, the second parameter (````, ````) is the file we are saving the configuration to. From 959dd12dbd760848a5f0ff553746c7e93734f04e Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Tue, 14 Jan 2025 10:40:06 -0500 Subject: [PATCH 02/23] Documented new accessibility compliance policy page (#7697) * Added new accessibility page * Update source/about/accessibility-compliance-policy.rst Co-authored-by: Matthew Birtch * Update source/about/accessibility-compliance-policy.rst Co-authored-by: Matthew Birtch * Update source/about/accessibility-compliance-policy.rst Co-authored-by: Matthew Birtch * Update source/about/accessibility-compliance-policy.rst Co-authored-by: Matthew Birtch * Update source/about/accessibility-compliance-policy.rst Co-authored-by: Matthew Birtch * Update source/about/accessibility-compliance-policy.rst Co-authored-by: Matthew Birtch * Update source/about/accessibility-compliance-policy.rst Co-authored-by: Matthew Birtch * Update source/about/accessibility-compliance-policy.rst Co-authored-by: Matthew Birtch * Incorporated reviewer feedback * Update source/about/accessibility-compliance-policy.rst Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> --------- Co-authored-by: Matthew Birtch Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> --- .../about/accessibility-compliance-policy.rst | 47 ++ .../about/certifications-and-compliance.rst | 8 +- source/about/faq-general.rst | 2 +- source/about/vpat.rst | 530 ------------------ source/guides/about-mattermost.rst | 6 +- source/overview/index.rst | 2 + 6 files changed, 58 insertions(+), 537 deletions(-) create mode 100644 source/about/accessibility-compliance-policy.rst delete mode 100644 source/about/vpat.rst diff --git a/source/about/accessibility-compliance-policy.rst b/source/about/accessibility-compliance-policy.rst new file mode 100644 index 00000000000..1a12b76a08d --- /dev/null +++ b/source/about/accessibility-compliance-policy.rst @@ -0,0 +1,47 @@ +Accessibility compliance policy +================================ + +Digital accessibility removes barriers to ensure full participation with digital experiences. People with disabilities may use assistive technology like screen readers or alternative input devices. We prioritize accessibility to deliver an experience that works for everyone, involving accessible designs, compatible code, and a logical, functional user interface for all. + +This policy outlines our commitment to accessibility through the Voluntary Product Accessibility Template (VPAT), which documents our product's compliance with accessibility standards. + +Policy and commitment +--------------------- + +At Mattermost, we strive to create a fair environment for everyone. We work continuously to ensure our digital products are accessible for all and are committed to following the W3C Web Content Accessibility 2.1 Guidelines and other applicable web accessibility laws including `WCAG 2.1 `_ Level AA (W3C) and Section 508 of the Rehabilitation Act (United States) for federal accessibility requirements. + +We leverage expert accessibility partners, such as `Level Access `_, to achieve and sustain conformance to accessibility standards. Their digital accessibility platform is used to evaluate our digital properties in accordance with best practices and is supported by a diverse team of accessibility professionals, including users with disabilities. + +To provide feedback about Mattermost’s accessibility, contact us at `accessibility@mattermost.com `_. + +Scope +----- + +This policy applies to all products offered by Mattermost, including web applications, software, digital content, and related services that may be used by individuals with disabilities. The policy applies to both internal and external stakeholders, including potential customers, partners, and government agencies seeking accessibility information. + +VPAT creation process +--------------------- + +1. **Initial Assessment**: Each product is reviewed for accessibility compliance based on the relevant standards. This assessment is conducted by trained accessibility personnel or certified third-party auditors. + +2. **VPAT Documentation**: A VPAT is created based on the findings from the initial assessment. This document details each accessibility criterion and the level of conformance achieved, along with explanations for any known gaps or alternative solutions. + +3. **Review and Approval**: VPATs are reviewed by our accessibility compliance team to ensure accuracy, completeness, and consistency. Any areas not in full compliance are documented with explanations and, where possible, a roadmap for future improvements. + +4. **Publishing and Distribution**: Once approved, VPATs are made available upon request for customers, partners, and other stakeholders. + +Accessibility standards and regulations evolve, and our products and services continue to improve. VPATs will be reviewed and updated on a regular basis, at minimum annually, to reflect the current state of our accessibility compliance. + +Roles and responsibilities +-------------------------- + +* **Product Accessibility Team**: Conducts assessments, documents accessibility features, and prepares VPATs. +* **Legal and Compliance Team**: Reviews VPATs to ensure legal requirements are met and accessibility claims are accurate. +* **Customer Support Team**: Handles requests for VPATs and assists customers with accessibility questions. + +Customer and partner requests +----------------------------- + +Customers and partners may request access to specific VPATs or additional accessibility information. The organization is committed to providing accurate and timely responses and will work to accommodate requests. + +To request a VPAT document, contact us at `legal@mattermost.com `_. \ No newline at end of file diff --git a/source/about/certifications-and-compliance.rst b/source/about/certifications-and-compliance.rst index 9d8a110b025..721d3ff9103 100644 --- a/source/about/certifications-and-compliance.rst +++ b/source/about/certifications-and-compliance.rst @@ -67,9 +67,11 @@ Data portability Accessibility compliance ------------------------- +See the :doc:`accessibility compliance policy ` documentation for details. + Adherence with accessibility standards is assisted in the following ways: -- **508 Compliance:** For U.S. public sector organizations seeking to confirm 508 compliance, Mattermost publicly shares its :doc:`Voluntary Product Accessibility Template (VPAT) online `. +- **508 Compliance:** VPATs are made available upon request for customers, partners, and other stakeholder seeking to confirm 508 compliance. - **WCAG 2.0L:** For meeting Web Contact Accessibility Guidelines 2.0 (WCAG), Mattermost has received a third-party "A" rating and is working towards an "AA" rating. - **ADA:** Mattermost compliance with the Americans with Disabilities Act (ADA) is achieved by offering the accessibility support detailed in the VPAT and WCAG 2.0 guidelines with Mattermost's online experience as the interface to accessibility tools. - **Remediation:** Any technical issue in a current or future product release that would prevent compliance with accessibility ratings stated in product documentation would be considered a product defect and Mattermost would welcome the `public filing of an issue report against the defect `_ so that it may be resolved. @@ -234,6 +236,4 @@ We plan to add IPv6 compliance for :doc:`Audio & Screen Sharing `, and `how Mattermost approaches accessibility in product development `_. \ No newline at end of file +Yes, the Mattermost platform is compliant with 508. See the :doc:`accessibility compliance policy ` documentation for details. \ No newline at end of file diff --git a/source/about/faq-general.rst b/source/about/faq-general.rst index e3405a6cd58..0a15cca93ea 100644 --- a/source/about/faq-general.rst +++ b/source/about/faq-general.rst @@ -14,7 +14,7 @@ The :ref:`commercial version of Mattermost ` form for details. Mattermost Enterprise Edition has been purchased by multiple US public sector organizations, including US federal agencies and the Department of Defense. +Yes. See the :doc:`accessibility compliance policy ` documentation for details. Mattermost Enterprise Edition has been purchased by multiple US public sector organizations, including US federal agencies and the Department of Defense. What's the largest Mattermost deployment you have? -------------------------------------------------- diff --git a/source/about/vpat.rst b/source/about/vpat.rst deleted file mode 100644 index 8647c68d5e0..00000000000 --- a/source/about/vpat.rst +++ /dev/null @@ -1,530 +0,0 @@ -:orphan: - -Voluntary Product Accessibility Template (VPAT) -=============================================== - -.. This page is intentionally not accessible via the LHS navigation pane. - -The following Voluntary Product Accessibility Template for 508 Compliance is completed per `online guidelines from the United States Department of State `__. - -- **Product Name**: Mattermost Enterprise Edition (including E10, E20, and all variants) -- **Product Version Number**: Assessment applies to release 3.7 and later -- **Vendor Company Name**: Mattermost, Inc. -- **Vendor Contact Name**: Mattermost VPAT/508 Review Team -- **Vendor Contact Email**: compliance[at]mattermost.com -- **Vendor Contact Telephone**: Please `contact Mattermost, Inc. `__ for telephone access. - -Summary -------- - -A summary of Mattermost's support of 508 compliance standards is as follows: - -Section 1194.21 Software Applications and Operating Systems - -- **Level of Support and Supporting Features**: SUPPORTS for 10 criteria, NOT APPLICABLE for one criteria, SUPPORTS THROUGH EQUIVALENT FACILITATION for one criteria. - -- **Remarks and Explanations**: NOT APPLICABLE criteria references requirements for animations, which are not used in the product. SUPPORTS THROUGH EQUIVALENT FACILITATION references the use of a user's contrast and color settings at as an equivalent Mattermost can reproduce contrast and color settings in its web interface, though--like any web application--it does not draw them from a user's PC settings. - -Section 1194.22 Web-based Intranet and Internet information and Applications - -- **Level of Support and Supporting Features**: SUPPORTS for five criteria, NOT APPLICABLE for nine criteria, SUPPORTS WITH EXCEPTION for one criteria, DOES NOT SUPPORT for one criteria. - -- **Remarks and Explanations**: SUPPORTS WITH EXCEPTION refers to having 80-90% coverage of text equivalents for every non-text element, with plans to increase coverage in 2018 release. DOES NOT SUPPORT refers to readability without associated style sheet with plan to address this issue in 2018 release. - -Section 1194.23 Telecommunications Products - -- **Level of Support and Supporting Features**: NOT APPLICABLE for 14 criteria. - -- **Remarks and Explanations**: Mattermost is not a telecommunications product. - -Section 1194.24 Video and Multi-media Products - -- **Level of Support and Supporting Features**: NOT APPLICABLE for five criteria. - -- **Remarks and Explanations**: Mattermost is not a video or multi-media product. - -Section 1194.25 Self-Contained, Closed Products - -- **Level of Support and Supporting Features**: NOT APPLICABLE for 14 criteria. - -- **Remarks and Explanations**: Mattermost is not a closed product. - -Section 1194.26 Desktop and Portable Computers - -- **Level of Support and Supporting Features**: NOT APPLICABLE for four criteria. - -- **Remarks and Explanations**: Mattermost is not a desktop or portable computer. - -Section 1194.31 Functional Performance Criteria - -- **Level of Support and Supporting Features**: SUPPORTS for four criteria, NOT APPLICABLE for two criteria. - -- **Remarks and Explanations**: NOT APPLICABLE due to no audio-entry for Mattermost. - -Section 1194.41 Information, Documentation and Support - -- **Level of Support and Supporting Features**: SUPPORTS for three criteria. - -- **Remarks and Explanations**: No additional comments. - -Section 1194.21 Software Applications and Operating Systems - Detail --------------------------------------------------------------------- - -(a) When software is designed to run on a system that has a keyboard, product functions shall be executable from a keyboard where the function itself or the result of performing a function can be discerned textually. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Web-based application has extensive keyboard shortcut controls along with support for tabbed interface allowing operating using keyboard only. :doc:`Definitions of keyboard shortcuts are available in product documentation `. Keyboard functionality is under continuous review for opportunities for improvement. - -(b) Applications shall not disrupt or disable activated features of other products that are identified as accessibility features, where those features are developed and documented according to industry standards. Applications also shall not disrupt or disable activated features of any operating system that are identified as accessibility features where the application programming interface for those accessibility features has been documented by the manufacturer of the operating system and is available to the product developer. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Nothing to add. - -(c) A well-defined on-screen indication of the current focus shall be provided that moves among interactive interface elements as the input focus changes. The focus shall be programmatically exposed so that Assistive Technology can track focus and focus changes. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Nothing to add. - -(d) Sufficient information about a user interface element including the identity, operation and state of the element shall be available to Assistive Technology. When an image represents a program element, the information conveyed by the image must also be available in text. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Nothing to add. - -(e) When bitmap images are used to identify controls, status indicators, or other programmatic elements, the meaning assigned to those images shall be consistent throughout an application's performance. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Nothing to add. - -(f) Textual information shall be provided through operating system functions for displaying text. The minimum information that shall be made available is text content, text input caret location, and text attributes. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Nothing to add. - -(g) Applications shall not override user selected contrast and color selections and other individual display attributes. - -- **Level of Support and Supporting Features**: SUPPORTS THROUGH EQUIVALENT FACILITATION - -- **Remarks and Explanations**: Mattermost web application can be used in high contrast mode with support for use selected colors and contrast options. - -(h) When animation is displayed, the information shall be displayable in at least one non-animated presentation mode at the option of the user. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: No core functionality in the product relies on animations. While some loading indicators are animated, failure to load is documented in text with error messages. - -(i) Color coding shall not be used as the only means of conveying information, indicating an action, prompting a response, or distinguishing a visual element. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: No indicators rely on color alone. - -(j) When a product permits a user to adjust color and contrast settings, a variety of color selections capable of producing a range of contrast levels shall be provided. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: See :doc:`full documentation `. - -(k) Software shall not use flashing or blinking text, objects, or other elements having a flash or blink frequency greater than 2 Hz and lower than 55 Hz. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Nothing to add. - -(l) When electronic forms are used, the form shall allow people using Assistive Technology to access the information, field elements, and functionality required for completion and submission of the form, including all directions and cues. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Nothing to add. - -Section 1194.22 Web-based Intranet and Internet information and Applications - Detail -------------------------------------------------------------------------------------- - -(a) A text equivalent for every non-text element shall be provided (e.g., via "alt", "longdesc", or in element content). - -- **Level of Support and Supporting Features**: SUPPORTS WITH EXCEPTION - -- **Remarks and Explanations**: 80-90% supported, full supported expected in 2018 release. - -(b) Equivalent alternatives for any multimedia presentation shall be synchronized with the presentation. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(c) Web pages shall be designed so that all information conveyed with color is also available without color, for example from context or markup. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Nothing to add. - -(d) Documents shall be organized so they are readable without requiring an associated style sheet. - -- **Level of Support and Supporting Features**: DOES NOT SUPPORT - -- **Remarks and Explanations**: This functionality is planned for 2018 release. - -(e) Redundant text links shall be provided for each active region of a server-side image map. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(f) Client-side image maps shall be provided instead of server-side image maps except where the regions cannot be defined with an available geometric shape. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(g) Row and column headers shall be identified for data tables. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(h) Markup shall be used to associate data cells and header cells for data tables that have two or more logical levels of row or column headers. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(i) Frames shall be titled with text that facilitates frame identification and navigation - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(j) Pages shall be designed to avoid causing the screen to flicker with a frequency greater than 2 Hz and lower than 55 Hz. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Nothing to add. - -(k) A text-only page, with equivalent information or functionality, shall be provided to make a web site comply with the provisions of this part, when compliance cannot be accomplished in any other way. The content of the text-only page shall be updated whenever the primary page changes. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Compliance criteria is supported, therefore text-only page is not provided. - -(l) When pages utilize scripting languages to display content, or to create interface elements, the information provided by the script shall be identified with functional text that can be read by Assistive Technology. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Nothing to add. - -(m) When a web page requires that an applet, plug-in, or other application be present on the client system to interpret page content, the page must provide a link to a plug-in or applet that complies with 1194.21(a) through (l). - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(n) When electronic forms are designed to be completed on-line, the form shall allow people using Assistive Technology to access the information, field elements, and functionality required for completion and submission of the form, including all directions and cues. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Nothing to add. - -(o) A method shall be provided that permits users to skip repetitive navigation links. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Keyboard shortcuts can skip repetitive navigation links. - -(p) When a timed response is required, the user shall be alerted and given sufficient time to indicate more time is required. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. There are no timed responses used in the system. - -Section 1194.23 Telecommunications Products - Detail ----------------------------------------------------- - -(a) Telecommunications products or systems which provide a function allowing voice communication and which do not themselves provide a TTY functionality shall provide a standard non-acoustic connection point for TTYs. Microphones shall be capable of being turned on and off to allow the user to intermix speech with TTY use. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(b) Telecommunications products which include voice communication functionality shall support all commonly used cross-manufacturer non-proprietary standard TTY signal protocols. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(c) Voice mail, auto-attendant, and interactive voice response telecommunications systems shall be usable by TTY users with their TTYs. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(d) Voice mail, messaging, auto-attendant, and interactive voice response telecommunications systems that require a response from a user within a time interval, shall give an alert when the time interval is about to run out, and shall provide sufficient time for the user to indicate more time is required. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(e) Where provided, caller identification and similar telecommunications functions shall also be available for users of TTYs, and for users who cannot see displays. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(f) For transmitted voice signals, telecommunications products shall provide a gain adjustable up to a minimum of 20 dB. For incremental volume control, at least one intermediate step of 12 dB of gain shall be provided. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(g) If the telecommunications product allows a user to adjust the receive volume, a function shall be provided to automatically reset the volume to the default level after every use. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(h) Where a telecommunications product delivers output by an audio transducer which is normally held up to the ear, a means for effective magnetic wireless coupling to hearing technologies shall be provided. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(i) Interference to hearing technologies (including hearing aids, cochlear implants, and assistive listening devices) shall be reduced to the lowest possible level that allows a user of hearing technologies to utilize the telecommunications product. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(j) Products that transmit or conduct information or communication, shall pass through cross-manufacturer, non-proprietary, industry-standard codes, translation protocols, formats, or other information necessary to provide the information or communication in a usable format. Technologies which use encoding, signal compression, format transformation, or similar techniques shall not remove information needed for access or shall restore it upon delivery. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(k)(1) Products which have mechanically operated controls or keys shall comply with the following: Controls and Keys shall be tactilely discernible without activating the controls or keys. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(k)(2) Products which have mechanically operated controls or keys shall comply with the following: Controls and Keys shall be operable with one hand and shall not require tight grasping, pinching, twisting of the wrist. The force required to activate controls and keys shall be five lbs. (22.2N) maximum. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(k)(3) Products which have mechanically operated controls or keys shall comply with the following: If key repeat is supported, the delay before repeat shall be adjustable to at least two seconds. Key repeat rate shall be adjustable to two seconds per character. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(k)(4) Products which have mechanically operated controls or keys shall comply with the following: The status of all locking or toggle controls or keys shall be visually discernible, and discernible either through touch or sound. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -Section 1194.24 Video and Multi-media Products - Detail -------------------------------------------------------- - -a) All analog television displays 13 inches and larger, and computer equipment that includes analog television receiver or display circuitry, shall be equipped with caption decoder circuitry which appropriately receives, decodes, and displays closed captions from broadcast, cable, videotape, and DVD signals. As soon as practicable, but not later than July 1, 2002, widescreen digital television (DTV) displays measuring at least 7.8 inches vertically, DTV sets with conventional displays measuring at least 13 inches vertically, and stand-alone DTV tuners, whether or not they are marketed with display screens, and computer equipment that includes DTV receiver or display circuitry, shall be equipped with caption decoder circuitry which appropriately receives, decodes, and displays closed captions from broadcast, cable, videotape, and DVD signals. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(b) Television tuners, including tuner cards for use in computers, shall be equipped with secondary audio program playback circuitry. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(c) All training and informational video and multimedia productions which support the agency's mission, regardless of format, that contain speech or other audio information necessary for the comprehension of the content, shall be open or closed captioned. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(d) All training and informational video and multimedia productions which support the agency's mission, regardless of format, that contain visual information necessary for the comprehension of the content, shall be audio described. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(e) Display or presentation of alternate text presentation or audio descriptions shall be user-selectable unless permanent. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -Section 1194.25 Self-Contained, Closed Products - Detail --------------------------------------------------------- - -(a) Self-contained products shall be usable by people with disabilities without requiring an end-user to attach Assistive Technology to the product. Personal headsets for private listening are not Assistive Technology. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(b) When a timed response is required, the user shall be alerted and given sufficient time to indicate more time is required. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(c) Where a product utilizes touchscreens or contact-sensitive controls, an input method shall be provided that complies with 1194.23 - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(d) When biometric forms of user identification or control are used, an alternative form of identification or activation, which does not require the user to possess particular biological characteristics, shall also be provided. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(e) When products provide auditory output, the audio signal shall be provided at a standard signal level through an industry standard connector that will allow for private listening. The product must provide the ability to interrupt, pause, and restart the audio at any time. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(f) When products deliver voice output in a public area, incremental volume control shall be provided with output amplification up to a level of at least 65 dB. Where the ambient noise level of the environment is above 45 dB, a volume gain of at least 20 dB above the ambient level shall be user selectable. A function shall be provided to automatically reset the volume to the default level after every use. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(g) Color coding shall not be used as the only means of conveying information, indicating an action, prompting a response, or distinguishing a visual element. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(h) When a product permits a user to adjust color and contrast settings, a range of color selections capable of producing a variety of contrast levels shall be provided. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(i) Products shall be designed to avoid causing the screen to flicker with a frequency greater than 2 Hz and lower than 55 Hz. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(j) (1) Products which are freestanding, non-portable, and intended to be used in one location and which have operable controls shall comply with the following: The position of any operable control shall be determined with respect to a vertical plane, which is 48 inches in length, centered on the operable control, and at the maximum protrusion of the product within the 48 inch length on products which are freestanding, non-portable, and intended to be used in one location and which have operable controls. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(j)(2) Products which are freestanding, non-portable, and intended to be used in one location and which have operable controls shall comply with the following: Where any operable control is 10 inches or less behind the reference plane, the height shall be 54 inches maximum and 15 inches minimum above the floor. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(j)(3) Products which are freestanding, non-portable, and intended to be used in one location and which have operable controls shall comply with the following: Where any operable control is more than 10 inches and not more than 24 inches behind the reference plane, the height shall be 46 inches maximum and 15 inches minimum above the floor. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(j)(4) Products which are freestanding, non-portable, and intended to be used in one location and which have operable controls shall comply with the following: Operable controls shall not be more than 24 inches behind the reference plane. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -Section 1194.26 Desktop and Portable Computers - Detail -------------------------------------------------------- - -(a) All mechanically operated controls and keys shall comply with 1194.23 (k) (1) through (4). - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(b) If a product utilizes touchscreens or touch-operated controls, an input method shall be provided that complies with 1194.23 (k) (1) through (4). - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(c) When biometric forms of user identification or control are used, an alternative form of identification or activation, which does not require the user to possess particular biological characteristics, shall also be provided. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -(d) Where provided, at least one of each type of expansion slots, ports and connectors shall comply with publicly available industry standards - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: Functionality described in this requirement is not included in the product. - -Section 1194.31 Functional Performance Criteria – Detail --------------------------------------------------------- - -(a) At least one mode of operation and information retrieval that does not require user vision shall be provided, or support for Assistive Technology used by people who are blind or visually impaired shall be provided. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Made available via browser. - -(b) At least one mode of operation and information retrieval that does not require visual acuity greater than 20/70 shall be provided in audio and enlarged print output working together or independently, or support for Assistive Technology used by people who are visually impaired shall be provided. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Increasing Zoom level in Mattermost web app can be used to fulfill this requirement. - -(c) At least one mode of operation and information retrieval that does not require user hearing shall be provided, or support for Assistive Technology used by people who are deaf or hard of hearing shall be provided - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: There is no functionality relying on audio only. - -(d) Where audio information is important for the use of a product, at least one mode of operation and information retrieval shall be provided in an enhanced auditory fashion, or support for assistive hearing devices shall be provided. - -- **Level of Support and Supporting Features**: NOT APPLICABLE - -- **Remarks and Explanations**: There is no functionality relying on audio only. - -(e) At least one mode of operation and information retrieval that does not require user speech shall be provided, or support for Assistive Technology used by people with disabilities shall be provided. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: No speech-only interfaces in Mattermost. - -(f) At least one mode of operation and information retrieval that does not require fine motor control or simultaneous actions and that is operable with limited reach and strength shall be provided. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: System can be operated with computer keyboard only, which can meet stated requirements when in accessibility mode. - -Section 1194.41 Information, Documentation and Support – Detail ---------------------------------------------------------------- - -(a) Product support documentation provided to end-users shall be made available in alternate formats upon request, at no additional charge - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Full documentation publicly available at https://docs.mattermost.com - -(b) End-users shall have access to a description of the accessibility and compatibility features of products in alternate formats or alternate methods upon request, at no additional charge. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: This documentation include links to all relevant accessibility and compatibility options, including theme colors and keyboard shortcuts. - -(c) Support services for products shall accommodate the communication needs of end-users with disabilities. - -- **Level of Support and Supporting Features**: SUPPORTS - -- **Remarks and Explanations**: Mattermost Enterprise Edition support available via email. diff --git a/source/guides/about-mattermost.rst b/source/guides/about-mattermost.rst index c4989d3982e..34bdc0f057e 100644 --- a/source/guides/about-mattermost.rst +++ b/source/guides/about-mattermost.rst @@ -1,11 +1,11 @@ :orphan: :nosearch: +.. This is NOT the page to update. Go to /overview/index.rst + About Mattermost ================ -.. This page is intentionally not accessible via the LHS navigation pane. - Mattermost is an open source platform for secure communication, collaboration, and orchestration of work across tools and teams. Mattermost’s mission is to make the world safer and more productive by developing and delivering secure, open source collaboration software that is trusted, flexible, and offers fast time-to-value. Find an overview below of our products, features, security, integrations, licensing and subscriptions, authentication, and compliance support. @@ -25,6 +25,7 @@ Mattermost’s mission is to make the world safer and more productive by develop /about/cloud-subscriptions.rst /about/corporate-directory-integration.rst /about/certifications-and-compliance.rst + /about/accessibility-compliance-policy.rst /about/frequently-asked-questions.rst This section provides an overview of Mattermost products, features, security, integrations, licensing, subscriptions, releases, authentication, and compliance support. @@ -39,4 +40,5 @@ This section provides an overview of Mattermost products, features, security, in * :doc:`Cloud subscriptions ` - Learn about Mattermost Cloud subscriptions. * :doc:`Corporate directory integrations ` - Mattermost integrates with all major account providers via Active Directory, SAML, and OAuth. * :doc:`Certifications and compliance ` - Mattermost can meet all major security and compliance requirements. +* :doc:`Accessibility compliance policy ` - Learn about Mattermost's commitment to accessibility. * :doc:`Frequently asked questions ` - Get answers to common questions about Mattermost. \ No newline at end of file diff --git a/source/overview/index.rst b/source/overview/index.rst index f27776f164a..8ab4ec77fac 100644 --- a/source/overview/index.rst +++ b/source/overview/index.rst @@ -16,6 +16,7 @@ Mattermost’s purpose is to accelerate the world’s mission critical work by d /about/releases-lifecycle.rst /about/corporate-directory-integration.rst /about/certifications-and-compliance.rst + /about/accessibility-compliance-policy.rst /about/frequently-asked-questions.rst With Mattermost you can: @@ -34,4 +35,5 @@ This section provides an overview of Mattermost products, features, security, in * :doc:`Mattermost releases and life cycle ` - Learn about Mattermost releases, our recommended practices around deployment updates and ESRs, and what's changed across server, desktop, and mobile releases. * :doc:`Corporate directory integrations ` - Mattermost integrates with all major account providers via Active Directory, SAML, and OAuth. * :doc:`Certifications and compliance ` - Mattermost can meet all major security and compliance requirements. +* :doc:`Accessibility compliance policy ` - Learn about Mattermost's policy and commitment to accessibility. * :doc:`Frequently asked questions ` - Get answers to common questions about Mattermost. From 4a97db59fd0cb587086796ab3f2a16e8ebbf6119 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:38:58 -0500 Subject: [PATCH 03/23] Update accessibility-compliance-policy.rst (#7699) --- source/about/accessibility-compliance-policy.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/about/accessibility-compliance-policy.rst b/source/about/accessibility-compliance-policy.rst index 1a12b76a08d..53ba1f9def9 100644 --- a/source/about/accessibility-compliance-policy.rst +++ b/source/about/accessibility-compliance-policy.rst @@ -44,4 +44,4 @@ Customer and partner requests Customers and partners may request access to specific VPATs or additional accessibility information. The organization is committed to providing accurate and timely responses and will work to accommodate requests. -To request a VPAT document, contact us at `legal@mattermost.com `_. \ No newline at end of file +To request a VPAT document, contact us at `accessibility@mattermost.com `_. From e0a7ab8bbaf8216fc581659347486f57502728e8 Mon Sep 17 00:00:00 2001 From: Amy Blais <29708087+amyblais@users.noreply.github.com> Date: Wed, 15 Jan 2025 12:18:18 +0200 Subject: [PATCH 04/23] Dot release docs (#7677) * Update mattermost-server-releases.md * Update download-latest-tarball.rst * Update mattermost-v9-changelog.md * Update mattermost-v10-changelog.md * Update version-archive.rst * Update mattermost-v9-changelog.md * Update mattermost-v9-changelog.md * Update mattermost-v10-changelog.md * Update version-archive.rst * Update mattermost-v10-changelog.md * Update mattermost-v9-changelog.md * Update version-archive.rst * Update version-archive.rst * Update version-archive.rst --- source/about/mattermost-server-releases.md | 8 +-- source/about/mattermost-v10-changelog.md | 13 +++++ source/about/mattermost-v9-changelog.md | 8 +++ source/about/version-archive.rst | 64 +++++++++++----------- source/install/download-latest-tarball.rst | 4 +- 5 files changed, 59 insertions(+), 38 deletions(-) diff --git a/source/about/mattermost-server-releases.md b/source/about/mattermost-server-releases.md index 01e18e36857..6512a0fe57b 100644 --- a/source/about/mattermost-server-releases.md +++ b/source/about/mattermost-server-releases.md @@ -19,11 +19,11 @@ Mattermost releases a new server version on the 16th of each month in [binary fo | **Release** | **Released on** | **Support ends** | |:---|:---|:---| -| v10.3 [Download](https://releases.mattermost.com/10.3.1/mattermost-10.3.1-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-12-16 | 2025-03-15 | -| v10.2 [Download](https://releases.mattermost.com/10.2.1/mattermost-10.2.1-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-11-15 | 2025-02-15 | -| v10.1 [Download](https://releases.mattermost.com/10.1.6/mattermost-10.1.6-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-10-16 | 2025-01-15 | +| v10.3 [Download](https://releases.mattermost.com/10.3.2/mattermost-10.3.2-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-12-16 | 2025-03-15 | +| v10.2 [Download](https://releases.mattermost.com/10.2.2/mattermost-10.2.2-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-11-15 | 2025-02-15 | +| v10.1 [Download](https://releases.mattermost.com/10.1.7/mattermost-10.1.7-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-10-16 | 2025-01-15 | | v10.0 [Download](https://releases.mattermost.com/10.0.4/mattermost-10.0.4-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-09-16 | 2024-12-15 | -| v9.11 [Download](https://releases.mattermost.com/9.11.6/mattermost-9.11.6-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-08-16 | 2025-05-15 {ref}`EXTENDED ` | +| v9.11 [Download](https://releases.mattermost.com/9.11.7/mattermost-9.11.7-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-08-16 | 2025-05-15 {ref}`EXTENDED ` | | v9.10 [Download](https://releases.mattermost.com/9.10.3/mattermost-9.10.3-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-07-16 | 2024-10-15 | | v9.9 [Download](https://releases.mattermost.com/9.9.3/mattermost-9.9.3-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-06-14 | 2024-09-15 | | v9.8 [Download](https://releases.mattermost.com/9.8.3/mattermost-9.8.3-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-05-16 | 2024-08-15 | diff --git a/source/about/mattermost-v10-changelog.md b/source/about/mattermost-v10-changelog.md index 81720bec550..53f0ba35465 100644 --- a/source/about/mattermost-v10-changelog.md +++ b/source/about/mattermost-v10-changelog.md @@ -10,6 +10,11 @@ Support for Mattermost Server v9.5 [Extended Support Release](https://docs.matte (release-v10.3-feature-release)= ## Release v10.3 - [Feature Release](https://docs.mattermost.com/about/release-policy.html#release-types) +- **10.3.2, released 2025-01-15** + - Mattermost v10.3.2 contains low to medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/). + - Pre-packaged Boards plugin [v9.0.2](https://github.com/mattermost/mattermost-plugin-boards/releases/tag/v9.0.2). + - Fixed an issue with the webhook attachment button style [MM-62400](https://mattermost.atlassian.net/browse/MM-62400). + - Mattermost v10.3.2 contains no database or functional changes. - **10.3.1, released 2024-12-16** - Fixed an issue where user statuses weren't synced properly between servers [MM-61438](https://mattermost.atlassian.net/browse/MM-61438). - Fixed an accessibility problem in the new search input [MM-61234](https://mattermost.atlassian.net/browse/MM-61234). @@ -93,6 +98,10 @@ New setting options were added to ``config.json``. Below is a list of the additi (release-v10.2-feature-release)= ## Release v10.2 - [Feature Release](https://docs.mattermost.com/about/release-policy.html#release-types) +- **10.2.2, released 2025-01-15** + - Mattermost v10.2.2 contains low to medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/). + - Pre-packaged Boards plugin [v9.0.2](https://github.com/mattermost/mattermost-plugin-boards/releases/tag/v9.0.2). + - Mattermost v10.2.2 contains no database or functional changes. - **10.2.1, released 2024-12-10** - Mattermost v10.2.1 contains low to medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/). - Fixed an issue where plugin settings got wiped if the plugin declared some of its fields as secrets [MM-61441](https://mattermost.atlassian.net/browse/MM-61441). @@ -180,6 +189,10 @@ New setting options were added to ``config.json``. Below is a list of the additi (release-v10.1-feature-release)= ## Release v10.1 - [Feature Release](https://docs.mattermost.com/about/release-policy.html#release-types) +- **10.1.7, released 2025-01-15** + - Mattermost v10.1.7 contains low to medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/). + - Pre-packaged Boards plugin [v9.0.2](https://github.com/mattermost/mattermost-plugin-boards/releases/tag/v9.0.2). + - Mattermost v10.1.7 contains no database or functional changes. - **10.1.6, released 2024-12-20** - Fixed an issue by restoring System Administrator access to Direct and Group Messages without being a member. - Mattermost v10.1.6 contains no database or functional changes. diff --git a/source/about/mattermost-v9-changelog.md b/source/about/mattermost-v9-changelog.md index 5219a93ff91..42f6aa01130 100644 --- a/source/about/mattermost-v9-changelog.md +++ b/source/about/mattermost-v9-changelog.md @@ -10,6 +10,14 @@ Support for Mattermost Server v9.5 [Extended Support Release](https://docs.matte (release-v9-11-extended-support-release)= ## Release v9.11 - [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#release-types) +- **9.11.7, released 2025-01-15** + - Mattermost v9.11.7 contains low to medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/). + - Fixed an issue with the web app status not being updated correctly for the current user [MM-59952](https://mattermost.atlassian.net/browse/MM-59952). + - Pre-packaged Boards plugin [v9.0.2](https://github.com/mattermost/mattermost-plugin-boards/releases/tag/v9.0.2). + - Fixed an issue with insertion errors to ``LinkMetadata`` table. + - Fixed an issue where the scroll position reset when custom emojis were requested [MM-62102](https://mattermost.atlassian.net/browse/MM-62102). + - Mattermost v9.11.7 contains the following database changes: + - Fixed an issue where Direct and Group Messages with a ``DeleteAt`` flag in the database could cause issues with some APIs. - **9.11.6, released 2024-12-10** - Mattermost v9.11.6 contains low to medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/). - A 200 response is now returned for HEAD requests to a sub-path rather than responding with a 302. This fixes mobile devices trying to connect to a server hosted on a sub-path [MM-58042](https://mattermost.atlassian.net/browse/MM-58042). diff --git a/source/about/version-archive.rst b/source/about/version-archive.rst index 5e9307f6bf8..546d80250fb 100644 --- a/source/about/version-archive.rst +++ b/source/about/version-archive.rst @@ -11,26 +11,26 @@ Version archive .. tab:: Mattermost Enterprise - Mattermost Enterprise Edition v10.3.1 - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/10.3.1/mattermost-10.3.1-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``6882e019e149e84fb0c21170106dc00eba7fe561756160ed0e3d949bb7887381`` - - GPG Signature: https://releases.mattermost.com/10.3.1/mattermost-10.3.1-linux-amd64.tar.gz.sig - Mattermost Enterprise Edition v10.2.1 - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/10.2.1/mattermost-10.2.1-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``c1b1c3268283d4c5ea946864d6ea8ea48eb722a16d1d94c2f3b48d45d0fb7ce8`` - - GPG Signature: https://releases.mattermost.com/10.2.1/mattermost-10.2.1-linux-amd64.tar.gz.sig - Mattermost Enterprise Edition v10.1.6 - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/10.1.6/mattermost-10.1.6-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``775820409a4ca9542bc99661daeeb9be870a6bb05ee5a84cb652cccec4fa2c5b`` - - GPG Signature: https://releases.mattermost.com/10.1.6/mattermost-10.1.6-linux-amd64.tar.gz.sig + Mattermost Enterprise Edition v10.3.2 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.3.2/mattermost-10.3.2-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``32a58e88d39e8a639160ee6027b5260d224ae0a9034696c1975017560e2b10e5`` + - GPG Signature: https://releases.mattermost.com/10.3.2/mattermost-10.3.2-linux-amd64.tar.gz.sig + Mattermost Enterprise Edition v10.2.2 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.2.2/mattermost-10.2.2-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``6a1bc407242a14d8b1266e09078461a408488305a26fdf74e76d76e5d0be16ce`` + - GPG Signature: https://releases.mattermost.com/10.2.2/mattermost-10.2.2-linux-amd64.tar.gz.sig + Mattermost Enterprise Edition v10.1.7 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.1.7/mattermost-10.1.7-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``6a7bfe7370f319d4f3a1a5aa27463af5e9b7851eca5ce7d285a3125a8b91c28d`` + - GPG Signature: https://releases.mattermost.com/10.1.7/mattermost-10.1.7-linux-amd64.tar.gz.sig Mattermost Enterprise Edition v10.0.4 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/10.0.4/mattermost-10.0.4-linux-amd64.tar.gz`` - SHA-256 Checksum: ``25c3753707404294070177495062aaef7d5e0100cc01343c27732225e4bbb8f6`` - GPG Signature: https://releases.mattermost.com/10.0.4/mattermost-10.0.4-linux-amd64.tar.gz.sig - Mattermost Enterprise Edition v9.11.6 *Extended Support Release (ESR)* - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/9.11.6/mattermost-9.11.6-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``c86e460deb821eff797be6f6c62fd4622086915f88ddaaa3d77421fd86f23964`` - - GPG Signature: https://releases.mattermost.com/9.11.6/mattermost-9.11.6-linux-amd64.tar.gz.sig + Mattermost Enterprise Edition v9.11.7 *Extended Support Release (ESR)* - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/9.11.7/mattermost-9.11.7-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``17051f0127a8e5f55519de38ef9d4a195a3c46ee52f121ced1ad6c9fadad536d`` + - GPG Signature: https://releases.mattermost.com/9.11.7/mattermost-9.11.7-linux-amd64.tar.gz.sig Mattermost Enterprise Edition v9.10.3 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/9.10.3/mattermost-9.10.3-linux-amd64.tar.gz`` - SHA-256 Checksum: ``638433634efbffe3c1d373b3f344406d37fcc3ab86292d4381890e3eeb86fb9d`` @@ -395,26 +395,26 @@ Version archive We generally recommend installing Enterprise Edition, even if you don't currently need a license. This provides the flexibility to seamlessly unlock Enterprise features should you need them. However, if you only want to install software with a fully open source code base, then Team Edition is the best choice for you. - Mattermost Team Edition v10.3.1 - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/10.3.1/mattermost-team-10.3.1-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``df3ecf16cf09fe711367bde13769f77b00f2e87f2f9285a5d0175224f15a3fc1`` - - GPG Signature: https://releases.mattermost.com/10.3.1/mattermost-team-10.3.1-linux-amd64.tar.gz.sig - Mattermost Team Edition v10.2.1 - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/10.2.1/mattermost-team-10.2.1-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``b4b77423ca9afff5042381c0af198742ae3ea9683273c78da0e2b1efa796b4d1`` - - GPG Signature: https://releases.mattermost.com/10.2.1/mattermost-team-10.2.1-linux-amd64.tar.gz.sig - Mattermost Team Edition v10.1.6 - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/10.1.6/mattermost-team-10.1.6-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``ffd8e250b2cd9adf50a3d129a4e50539de4bf9208a2dfb05ee34018edd8a7669`` - - GPG Signature: https://releases.mattermost.com/10.1.6/mattermost-team-10.1.6-linux-amd64.tar.gz.sig + Mattermost Team Edition v10.3.2 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.3.2/mattermost-team-10.3.2-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``a62f3c8d4b1f1a29f06539430e2c3231088b9f388fc3b098bd23b18e0263249c`` + - GPG Signature: https://releases.mattermost.com/10.3.2/mattermost-team-10.3.2-linux-amd64.tar.gz.sig + Mattermost Team Edition v10.2.2 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.2.2/mattermost-team-10.2.2-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``d6134e0080c77a8992321553a1f9fdce6dab206660bc6abe99c2d5fcf6f15b51`` + - GPG Signature: https://releases.mattermost.com/10.2.2/mattermost-team-10.2.2-linux-amd64.tar.gz.sig + Mattermost Team Edition v10.1.7 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.1.7/mattermost-team-10.1.7-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``baf2f1ec86448938d1ed2879cb19e5034259090cd8282d5bebdb6d495de33a06`` + - GPG Signature: https://releases.mattermost.com/10.1.7/mattermost-team-10.1.7-linux-amd64.tar.gz.sig Mattermost Team Edition v10.0.4 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/10.0.4/mattermost-team-10.0.4-linux-amd64.tar.gz`` - SHA-256 Checksum: ``ad7ace64160e17b352b6f0801c928eca8200f7bc71305d2e65ca296a535cee60`` - GPG Signature: https://releases.mattermost.com/10.0.4/mattermost-team-10.0.4-linux-amd64.tar.gz.sig - Mattermost Team Edition v9.11.6 *Extended Support Release (ESR)* - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/9.11.6/mattermost-team-9.11.6-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``12fcf826d39f91bffc9cb06c5cca395e64e399bf559904caf3fd4bed14377b6b`` - - GPG Signature: https://releases.mattermost.com/9.11.6/mattermost-team-9.11.6-linux-amd64.tar.gz.sig + Mattermost Team Edition v9.11.7 *Extended Support Release (ESR)* - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/9.11.7/mattermost-team-9.11.7-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``94fc00ef59e594a90a883763b5b92c3e857eb23e5104a9752472a4333aaf0756`` + - GPG Signature: https://releases.mattermost.com/9.11.7/mattermost-team-9.11.7-linux-amd64.tar.gz.sig Mattermost Team Edition v9.10.3 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/9.10.3/mattermost-team-9.10.3-linux-amd64.tar.gz`` - SHA-256 Checksum: ``d50e2d3352129f3eaa5271cb3031b0210f9283954e727f7dca959b4c277ea6fc`` diff --git a/source/install/download-latest-tarball.rst b/source/install/download-latest-tarball.rst index 45411d542db..d1aeb96df0a 100644 --- a/source/install/download-latest-tarball.rst +++ b/source/install/download-latest-tarball.rst @@ -9,13 +9,13 @@ Using ``wget``, download the Mattermost Server release you want to install. .. code-block:: sh - wget https://releases.mattermost.com/10.3.1/mattermost-10.3.1-linux-amd64.tar.gz + wget https://releases.mattermost.com/10.3.2/mattermost-10.3.2-linux-amd64.tar.gz .. tab:: Current ESR .. code-block:: sh - wget https://releases.mattermost.com/9.11.6/mattermost-9.11.6-linux-amd64.tar.gz + wget https://releases.mattermost.com/9.11.7/mattermost-9.11.7-linux-amd64.tar.gz .. tab:: Older releases From fa88106bc3fa09e35ae6ebd64882085f12be458e Mon Sep 17 00:00:00 2001 From: Amy Blais <29708087+amyblais@users.noreply.github.com> Date: Thu, 16 Jan 2025 08:08:05 +0200 Subject: [PATCH 05/23] v10.4 Docs (#7667) * Update conf.py (#7666) * Fixed typo (#7679) * Clarified team admin capabilities (#7681) * Added diagnostics file to Support Packet (#7682) * Added Enterprise-only About > Hostname (#7683) * Added Enterprise-only About > Hostname * Update source/scale/high-availability-cluster-based-deployment.rst * Updated web & desktop notification prompt details (#7685) * Clarified min server version requirements (#7688) * Added Amazon S3 storage class config settings (#7691) * Added WIP Locales config setting (#7690) * Added WIP Locales config setting * Update source/configure/site-configuration-settings.rst * Update source/configure/site-configuration-settings.rst * Removed Slack theme import functionality (#7684) * Removed Slack theme import functionality * Reordered content on page & removed remaining Slack references * Added Redis config settings (#7689) * Added Redis config settings * Clarified config setting input types * Incorporated reviewer feedback * Docs listening: Added clarity on how to access config settings in the System Console (#7692) * Added clarity on how to access config settings in the System Console * Added standard content to experimental settings * Incorporated https://github.com/mattermost/docs/pull/7467 * Broken link fixes * Added emoji prefix recommendation for channels & channel categories (#7695) * Added scheduled maintenance comms guidance (#7696) * Incorporated reviewer feedback * v10.4 Changelog (#7664) * Update mattermost-server-releases.md * Update open-source-components.rst * Update download-latest-tarball.rst * Update mattermost-v10-changelog.md * Update mattermost-v10-changelog.md * Update mattermost-v10-changelog.md * Apply suggestions from code review Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update mattermost-v10-changelog.md * Update mattermost-v10-changelog.md * Update mattermost-v10-changelog.md * Update mattermost-server-releases.md * Update download-latest-tarball.rst * Update mattermost-v10-changelog.md --------- Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> --------- Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> --- source/_templates/custom-index.html | 2 +- .../about/certifications-and-compliance.rst | 4 +- source/about/deprecated-features.rst | 5 + source/about/mattermost-server-releases.md | 1 + source/about/mattermost-v10-changelog.md | 78 +++++++ source/about/unsupported-legacy-releases.md | 2 +- .../channel-naming-conventions.rst | 8 + source/collaborate/learn-about-roles.rst | 2 +- source/conf.py | 4 +- .../authentication-configuration-settings.rst | 11 +- .../cloud-billing-account-settings.rst | 2 +- .../compliance-configuration-settings.rst | 9 +- source/configure/configuration-settings.rst | 7 +- source/configure/enable-copilot.rst | 2 +- .../environment-configuration-settings.rst | 214 ++++++++++++++++-- .../experimental-configuration-settings.rst | 19 +- .../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 | 66 ++++-- ...user-management-configuration-settings.rst | 2 +- source/guides/administration.rst | 6 +- .../get-started-with-administration.rst | 4 + source/guides/upgrade-mattermost.rst | 2 + source/install/download-latest-tarball.rst | 2 +- source/manage/cloud-ip-filtering.rst | 4 +- source/manage/code-signing-custom-builds.rst | 2 +- source/manage/generating-support-packet.rst | 8 +- source/onboard/connected-workspaces.rst | 12 +- source/onboard/sso-entraid.rst | 2 +- .../customize-your-channel-sidebar.rst | 53 +++-- source/preferences/customize-your-theme.rst | 196 ++++++++-------- .../manage-your-desktop-notifications.rst | 5 +- .../manage-your-web-notifications.rst | 3 +- ...-availability-cluster-based-deployment.rst | 9 +- source/scale/scale-to-100000-users.rst | 3 +- .../communicate-scheduled-maintenance.rst | 195 ++++++++++++++++ source/upgrade/open-source-components.rst | 2 + 40 files changed, 775 insertions(+), 210 deletions(-) create mode 100644 source/upgrade/communicate-scheduled-maintenance.rst diff --git a/source/_templates/custom-index.html b/source/_templates/custom-index.html index feba33896f6..84b325a9455 100644 --- a/source/_templates/custom-index.html +++ b/source/_templates/custom-index.html @@ -255,7 +255,7 @@

Connect and collaborate

Build repeatable processes

-

Most faster and make fewer mistakes with checklist-based automation that +

Move faster and make fewer mistakes with checklist-based automation that powers your team workflows.

Get started »

diff --git a/source/about/certifications-and-compliance.rst b/source/about/certifications-and-compliance.rst index 721d3ff9103..b87365fc9e1 100644 --- a/source/about/certifications-and-compliance.rst +++ b/source/about/certifications-and-compliance.rst @@ -134,7 +134,7 @@ of assets, the denial of export privileges, and suspension or debarment from Gov For these reasons, please take the time to familiarize yourself with applicable export (and import) controls in the jurisdictions in which you operate. Although Mattermost cannot provide advice on export matters, this web page provides the information needed in order to export Mattermost products. -This overview is specific to the `U.S. Export Administration Regulations `_ (EAR), however, business operations may subject you to other regulations such as the `International Traffic in Arms Regulations `_. +This overview is specific to the U.S. Export Administration Regulations (EAR); however, business operations may subject you to other regulations such as the `International Traffic in Arms Regulations `_. General information ~~~~~~~~~~~~~~~~~~~~ @@ -158,7 +158,7 @@ Mattermost Enterprise Edition (includes Mattermost Professional & Enterprise) is The other key areas to be aware of for an export of Mattermost software or technology are: **Sanctions**: There are comprehensive sanctions to Cuba, Iran, North Korea, Syria, and other countries/territories with specific prohibitions, such as Crimea, Donetsk, and Luhansk regions of Ukraine, Belarus, Russia, Venezuela, Myanmar/Burma, and Cambodia. Details can be -located at `BIS `_ and `OFAC `_. The countries and their sanctions are subject to change. +located at `BIS `_. The countries and their sanctions are subject to change. **WMD (Weapons of Mass Destruction)**: Mattermost, its customers and its business partners may not export to parties involved in `proliferation `_ of weapons of mass destruction, along with other prohibited end-uses under the U.S. Export Administration Regulations (“EAR”). diff --git a/source/about/deprecated-features.rst b/source/about/deprecated-features.rst index e93cfc31a95..aed46ddaec0 100644 --- a/source/about/deprecated-features.rst +++ b/source/about/deprecated-features.rst @@ -20,6 +20,11 @@ Mattermost Server v10.5.0 Removed features by Mattermost version ---------------------------------------- +Mattermost Server v10.4.0 +~~~~~~~~~~~~~~~~~~~~~~~~~ + +- The ability to import Slack themes as Mattermost themes is no longer supported. + Mattermost Server v10.3.0 ~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/about/mattermost-server-releases.md b/source/about/mattermost-server-releases.md index 6512a0fe57b..1db952de699 100644 --- a/source/about/mattermost-server-releases.md +++ b/source/about/mattermost-server-releases.md @@ -19,6 +19,7 @@ Mattermost releases a new server version on the 16th of each month in [binary fo | **Release** | **Released on** | **Support ends** | |:---|:---|:---| +| v10.4 [Download](https://releases.mattermost.com/10.4.1/mattermost-10.4.1-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2025-01-16 | 2025-04-15 | | v10.3 [Download](https://releases.mattermost.com/10.3.2/mattermost-10.3.2-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-12-16 | 2025-03-15 | | v10.2 [Download](https://releases.mattermost.com/10.2.2/mattermost-10.2.2-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-11-15 | 2025-02-15 | | v10.1 [Download](https://releases.mattermost.com/10.1.7/mattermost-10.1.7-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-10-16 | 2025-01-15 | diff --git a/source/about/mattermost-v10-changelog.md b/source/about/mattermost-v10-changelog.md index 53f0ba35465..16ffc24cfbd 100644 --- a/source/about/mattermost-v10-changelog.md +++ b/source/about/mattermost-v10-changelog.md @@ -7,6 +7,84 @@ Support for Mattermost Server v9.5 [Extended Support Release](https://docs.matte - See the [changelog in progress](https://bit.ly/2nK3cVf) for details about the upcoming release. ``` +(release-v10.4-feature-release)= +## Release v10.4 - [Feature Release](https://docs.mattermost.com/about/release-policy.html#release-types) + +- **10.4.1, released 2025-01-16** + - Fixed errors logged by performance telemetry due to certain browser extensions [MM-62371](https://mattermost.atlassian.net/browse/MM-62371). + - Fixed an issue with insertion errors to ``LinkMetadata`` table. + - Mattermost v10.4.1 contains no database or functional changes. +- **10.4.0, released 2025-01-16** + - Original 10.4.0 release. + +```{Important} +If you upgrade from a release earlier than v10.3, please read the other [Important Upgrade Notes](https://docs.mattermost.com/upgrade/important-upgrade-notes.html). +``` + +### Improvements + +#### User Interface (UI) + - Pre-packaged Calls plugin [v1.4.0](https://github.com/mattermost/mattermost-plugin-calls/releases/tag/v1.4.0). + - Pre-packaged Boards plugin [v9.0.2](https://github.com/mattermost/mattermost-plugin-boards/releases/tag/v9.0.2). + - Improved the handling of Thai script in search terms. + - Added tooltips to the buttons shown in the channel info in the right pane. + - Downgraded Spanish language to Alpha. + - Removed the feature to import themes from Slack. + +#### Administration + - Redis is now available as an alternative cache backend for all Enterprise customers. It can be leveraged to run Mattermost at a very high scale. + - Plugins are now allowed to add Support Packet data without user interface elements. + - Improved the detection of the mobile app operating system as stored in the **Sessions** table. + +### Bug Fixes + - Fixed an issue where imported replies were missing their reactions. + - Fixed an issue with how links in Markdown headings are displayed in the Threads list. + - Fixed an issue where marking a channel as read wouldn't persist through a refresh. + - Fixed a warning in the Support Packet about an unreadable LDAP server even if LDAP was disabled. + - Fixed an issue where multiple timezones were highlighted when selecting certain timezones. + - Fixed an issue where unread messages on other teams would not appear after the application reconnected to the server. + - Fixed an issue where the scrollbar was not clickable when there was a toaster. + - Fixed an issue when pressing **Page Up** or **Page Down** on a long message (scrollable) with the right sidebar open. + - Fixed an issue with incorrect reporting in the **Server Updates** section in **System Console > Workspace Optimizations**. + - Fixed an issue where EXIF rotated image previews did not have the correct size. + - Fixed an issue where the search input field in the emoji picker did not accept uppercase letters. + - Fixed an issue where imported replies were missing their reactions. + - Fixed an issue where System Administrators could not pull posts from Direct Message channels that they were not in. + - Fixed an issue by restoring System Administrator access to Direct and Group Messages without being a member. + +### config.json +New setting options were added to ``config.json``. Below is a list of the additions and their default values on install. The settings can be modified in ``config.json``, or the System Console when available. + +#### Changes to all plans: +- Under ``LocalizationSettings`` in ``config.json``: + - Added a new ``EnableExperimentalLocales`` configuration setting that controls whether to allow the selection of experimental (e.g., in progress) languages. + +#### Changes to Enterprise plans: + - Under ``CacheSettings`` in ``config.json``: + - Added ``CacheType``: This can be either ``lru`` or ``redis``. ``lru`` is the default choice which will use the in-memory cache store that we use currently. + - Added ``RedisAddress``: The hostname of the Redis host. + - Added ``RedisPassword``: The password of the Redis host (can be left blank if there is no password). + - Added ``RedisDB``: The database of the Redis host. Typically ``0``. + - Added ``DisableClientCache``: This can be set to ``true`` if you decide to disable the client-side cache of Redis. Typically there is no need to do this in production, and this is mainly used as a test option. + - Under ``FileSettings`` in ``config.json``: + - Added new ``AmazonS3StorageClass`` and ``ExportAmazonS3StorageClass``, both default to ``""`` to preserve the current behavior. Administrators may configure this storage class to the storage class required by their S3 solution. + +### API Changes + - Added a new query string to exclude threads that are not part of the team ``GET api/v4/users/{user_id:[A-Za-z0-9]+}/teams/{team_id:[A-Za-z0-9]+}/threads``. + +### Websocket Event Changes + - Added a new ``server_hostname`` field to the websocket ``HELLO`` event. + +### Go Version + - v10.4 is built with Go ``v1.22.6``. + +### Known Issues + - Searching stop words in quotation marks with Elasticsearch enabled returns more than just the searched terms. + - Slack import through the CLI fails if email notifications are enabled. + +### Contributors + - [agarciamontoro](https://github.com/agarciamontoro), [agnivade](https://github.com/agnivade), [akbarkz](https://translate.mattermost.com/user/akbarkz), [amyblais](https://github.com/amyblais), [and-ri](https://github.com/and-ri), [andreabia](https://translate.mattermost.com/user/andreabia), [andrleite](https://github.com/andrleite), [angeloskyratzakos](https://github.com/angeloskyratzakos), [Aryakoste](https://github.com/Aryakoste), [AulakhHarsh](https://github.com/AulakhHarsh), [ayush-chauhan233](https://github.com/ayush-chauhan233), [BenCookie95](https://github.com/BenCookie95), [calebroseland](https://github.com/calebroseland), [callmeott](https://github.com/callmeott), [catalintomai](https://github.com/catalintomai), [creeper-0910](https://github.com/creeper-0910), [crspeller](https://github.com/crspeller), [ctlaltdieliet](https://github.com/ctlaltdieliet), [cwarnermm](https://github.com/cwarnermm), [davidkrauser](https://github.com/davidkrauser), [Destrosvet](https://translate.mattermost.com/user/Destrosvet), [devinbinnie](https://github.com/devinbinnie), [DHaussermann](https://github.com/DHaussermann), [Eleferen](https://translate.mattermost.com/user/Eleferen), [enahum](https://github.com/enahum), [enzowritescode](https://github.com/enzowritescode), [esarafianou](https://github.com/esarafianou), [esethna](https://github.com/esethna), [ewwollesen](https://github.com/ewwollesen), [fmartingr](https://github.com/fmartingr), [frankps](https://translate.mattermost.com/user/frankps), [fsilye](https://github.com/fsilye), [fume4mattermost](https://github.com/fume4mattermost), [fxnm](https://github.com/fxnm), [gabrielctn](https://github.com/gabrielctn), [gabrieljackson](https://github.com/gabrieljackson), [gabsfrancis](https://translate.mattermost.com/user/gabsfrancis), [Gesare5](https://github.com/Gesare5), [Haliax](https://translate.mattermost.com/user/Haliax), [hanzei](https://github.com/hanzei), [harshilsharma63](https://github.com/harshilsharma63), [henrique](https://translate.mattermost.com/user/henrique), [hmhealey](https://github.com/hmhealey), [Honsei901](https://github.com/Honsei901), [hpflatorre](https://github.com/hpflatorre), [ifoukarakis](https://github.com/ifoukarakis), [isacikgoz](https://github.com/isacikgoz), [jespino](https://github.com/jespino), [jessiekahn](https://github.com/jessiekahn), [joakim.rivera](https://translate.mattermost.com/user/joakim.rivera), [johnsonbrothers](https://github.com/johnsonbrothers), [jprusch](https://translate.mattermost.com/user/jprusch), [jwilander](https://github.com/jwilander), [kaakaa](https://github.com/kaakaa), [kayazeren](https://github.com/kayazeren), [Kshitij-Katiyar](https://github.com/Kshitij-Katiyar), [Kuruyia](https://github.com/Kuruyia), [kyrillosisaac2](https://github.com/kyrillosisaac2), [lani009](https://translate.mattermost.com/user/lani009), [larkox](https://github.com/larkox), [lieut-data](https://github.com/lieut-data), [lorumic](https://github.com/lorumic), [lynn915](https://github.com/lynn915), [M-ZubairAhmed](https://github.com/M-ZubairAhmed), [majo](https://translate.mattermost.com/user/majo), [marianunez](https://github.com/marianunez), [massimo](https://translate.mattermost.com/user/massimo), [master7](https://translate.mattermost.com/user/master7), [matt-w99](https://github.com/matt-w99), [matthew-w](https://translate.mattermost.com/user/matthew-w), [mh4ckt3mh4ckt1c4s](https://translate.mattermost.com/user/mh4ckt3mh4ckt1c4s), [minchae.lee](https://translate.mattermost.com/user/minchae.lee), [morgancz](https://translate.mattermost.com/user/morgancz), [Morgansvk](https://github.com/Morgansvk), [muratbayan](https://translate.mattermost.com/user/muratbayan), [mvitale1989](https://github.com/mvitale1989), [nbruneau71250](https://translate.mattermost.com/user/nbruneau71250), [nickmisasi](https://github.com/nickmisasi), [nikolaiz](https://translate.mattermost.com/user/nikolaiz), [Nityanand13](https://github.com/Nityanand13), [pmokeev](https://github.com/pmokeev), [potatogim](https://github.com/potatogim), [pvev](https://github.com/pvev), [raghavaggarwal2308](https://github.com/raghavaggarwal2308), [rahimrahman](https://github.com/rahimrahman), [Rajat-Dabade](https://github.com/Rajat-Dabade), [Reinkard](https://github.com/Reinkard), [renaudk](https://github.com/renaudk), [ricardogalvao](https://translate.mattermost.com/user/ricardogalvao), [RS-labhub](https://github.com/RS-labhub), [Rutam21](https://github.com/Rutam21), [saturninoabril](https://github.com/saturninoabril), [sbishel](https://github.com/sbishel), [Sharuru](https://github.com/Sharuru), [stafot](https://github.com/stafot), [streamer45](https://github.com/streamer45), [sypianski](https://translate.mattermost.com/user/sypianski), [TenGentoppa](https://translate.mattermost.com/user/TenGentoppa), [TheInvincibleRalph](https://github.com/TheInvincibleRalph), [ThrRip](https://github.com/ThrRip), [tnir](https://github.com/tnir), [tokipulan](https://translate.mattermost.com/user/tokipulan), [tomdereub](https://translate.mattermost.com/user/tomdereub), [toninis](https://github.com/toninis), [wetneb](https://github.com/wetneb), [wiggin77](https://github.com/wiggin77), [YahyaHaq](https://github.com/YahyaHaq), [yasserfaraazkhan](https://github.com/yasserfaraazkhan), [yesbhautik](https://github.com/yesbhautik), [zenocode-org](https://translate.mattermost.com/user/zenocode-org) + (release-v10.3-feature-release)= ## Release v10.3 - [Feature Release](https://docs.mattermost.com/about/release-policy.html#release-types) diff --git a/source/about/unsupported-legacy-releases.md b/source/about/unsupported-legacy-releases.md index 2b038f1819d..c1db29214fe 100644 --- a/source/about/unsupported-legacy-releases.md +++ b/source/about/unsupported-legacy-releases.md @@ -13148,7 +13148,7 @@ Expected Release date: 2016-01-16 #### Mobile Experience -- iOS reference app [now available from iTunes](https://apps.apple.com/us/app/mattermost-classic/id984966508?amp%3Bmt=8&ls=1), compiled from [open source repo](https://github.com/mattermost/ios) +- iOS reference app now available from iTunes - Date headers now show when scrolling on mobile, so you can quickly see when messages were sent - Added "rapid scroll" support for jumping quickily to bottom of channels on mobile diff --git a/source/collaborate/channel-naming-conventions.rst b/source/collaborate/channel-naming-conventions.rst index c14c4df05db..8bef4b62fcb 100644 --- a/source/collaborate/channel-naming-conventions.rst +++ b/source/collaborate/channel-naming-conventions.rst @@ -14,6 +14,14 @@ Basic structure - Channel names have a 64-character limit to ensure readability on both desktop and mobile devices. - An additional 1024 characters are available for describing the channel's focus in the channel header and channel information pane. - An additional 128 characters are available for a **Channel Purpose** that's visible in the channel header and the channel information pane. +- Channel names can include emojis. Specify the emoji by its name in the format ``:smile:``. We recommend prefixing channel names with emojis for the following reasons: + + - Emojis can make it easier for users to quickly identify and manage channels, particularly in large workspaces with many channels. + - Sharing the same emoji across channels related to a specific category or function helps maintain organization and consistency across the workspace. + - Making channels more visually distinct with emojis helps users find the channels they need more quickly and easily at a glance, reducing the time spent searching for the right channel. + - New users can quickly understand the purpose of various channels based on their emoji prefixes without needing extensive explanations. + - As users grasp channel structure through emojis, the time and effort needed to train new members on navigating the workspace is reduced. + - A well-organized and visually appealing workspace can encourage users to participate more actively, which can lead to more effective communication and collaboration. Scope channel names ------------------- diff --git a/source/collaborate/learn-about-roles.rst b/source/collaborate/learn-about-roles.rst index fb626371928..dc0f7257c95 100644 --- a/source/collaborate/learn-about-roles.rst +++ b/source/collaborate/learn-about-roles.rst @@ -44,7 +44,7 @@ When a team is first created, the person who set it up is made a team admin. It - Access to the **Team Settings** menu. - Ability to change the team name and import data from Slack export files. - Access to the **Manage Members** menu, where they can control whether team members are a **Member** or a **Team Admin**. -- Ability to manage all aspects of a team, such as managing private channels they're not a member of. +- Ability to manage all aspects of a team, such as joining and managing private channels they're not a member of. Channel admin ------------- diff --git a/source/conf.py b/source/conf.py index edda03b2624..6a7a383b3a7 100644 --- a/source/conf.py +++ b/source/conf.py @@ -3759,9 +3759,9 @@ def setup(_: Sphinx): # built documents. # # The short X.Y version. -# version = '10.3' +# version = '10.4' # The full version, including alpha/beta/rc tags. -# release = '10.3' +# release = '10.4' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. 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/enable-copilot.rst b/source/configure/enable-copilot.rst index d49e0bdaaf1..a406753822a 100644 --- a/source/configure/enable-copilot.rst +++ b/source/configure/enable-copilot.rst @@ -65,7 +65,7 @@ With extensive customization and extensibility options, you can tailor Copilot t Configure an LLM for your Copilot integration by going to **System Console > Plugins > Copilot** and selecting **Add an AI Bot**. Mattermost supports the following LLMs: -- `OpenAI `_ +- `OpenAI `_ - `Anthropic (Claude) `_ - `Azure OpenAI `_ - `OpenAI-compatible (e.g., LocalAI) `_ diff --git a/source/configure/environment-configuration-settings.rst b/source/configure/environment-configuration-settings.rst index 4e5101e11b3..7ba1d6f8a08 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 ---------- @@ -2561,7 +2576,7 @@ Enable Amazon S3 debugging +---------------------------------------------------------------+--------------------------------------------------------------------------+ | Enable or disable Amazon S3 debugging to capture additional | - System Config path: **Environment > File Storage** | -| debugging information in system logs | - ``config.json`` setting: ``".FileSettings.AmazonS3Trace: false",`` | +| debugging information in system logs. | - ``config.json`` setting: ``".FileSettings.AmazonS3Trace: false",`` | | | - Environment variable: ``MM_FILESETTINGS_AMAZONS3TRACE`` | | - **true**: Log additional debugging information is logged | | | to the system logs. | | @@ -2572,6 +2587,51 @@ Enable Amazon S3 debugging | Select the **Test Connection** button in the System Console to validate the settings and ensure the user can access the server. | +---------------------------------------------------------------+--------------------------------------------------------------------------+ +.. config:setting:: file-amazons3storageclass + :displayname: Amazon S3 storage class (File Storage) + :systemconsole: Environment > File Storage + :configjson: .FileSettings.AmazonS3StorageClass + :environment: MM_FILESETTINGS_AMAZONS3STORAGECLASS + :description: The storage class to use for uploads to S3-compatible storage solutions. Default is an empty string ``""``. + +Amazon S3 storage class +~~~~~~~~~~~~~~~~~~~~~~~ + +Some Amazon S3-compatible storage solutions require the storage class parameter to be present in upload requests, otherwise they will be rejected. Configure this storage class as the storage class required by your S3-compatible solution. + ++---------------------------------------------------------------+--------------------------------------------------------------------------+ +| The storage class to use for uploads to S3-compatible | - System Config path: **Environment > File Storage** | +| storage solutions. | - ``config.json`` setting: ``.FileSettings.AmazonS3StorageClass: ""``, | +| | - Environment variable: ``MM_FILESETTINGS_AMAZONS3STORAGECLASS`` | +| String input. Default is an empty string ``""``. | | +| Select **Test Connection** to test the configured connection. | | ++---------------------------------------------------------------+--------------------------------------------------------------------------+ + +.. note:: + + Most Amazon S3-compatible storage solutions assign a default storage class of ``STANDARD`` when no storage class is provided. See the `Amazon S3 storage class `_ documentation for details about supported storage classes. + +.. config:setting:: file-exportamazons3storageclass + :displayname: Export Amazon S3 storage class (File Storage) + :systemconsole: N/a + :configjson: .FileSettings.ExportAmazonS3StorageClass + :environment: MM_FILESETTINGS_EXPORTAMAZONS3STORAGECLASS + :description: The storage class to use for exports to S3-compatible storage solutions. Default value is an empty string ``""``. + +Export Amazon S3 storage class +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ +| The storage class to use for exports to S3-compatible | - System Config path: N/A | +| storage solutions. | - ``config.json`` setting: ``.FileSettings.ExportAmazonS3StorageClass: "",`` | +| | - Environment variable: ``MM_FILESETTINGS_EXPORTAMAZONS3STORAGECLASS`` | +| String input. Default is an empty string ``""``. | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------+ + +.. note:: + + Most Amazon S3-compatible storage solutions assign a default storage class of ``STANDARD`` when no storage class is provided. See the `Amazon S3 storage class `_ documentation for details about supported storage classes. + .. config:setting:: file-amazons3requesttimeoutmilliseconds :displayname: Amazon S3 request timeout (File Storage) :systemconsole: N/A @@ -2628,6 +2688,23 @@ Amazon S3 exported upload part size | **Note**: A smaller part size can result in more requests and an increase in latency, while a larger part size can result in more memory being allocated. | +---------------------------------------------------------------+--------------------------------------------------------------------------------------------+ +.. config:setting:: file-amazons3requesttimeoutmilliseconds + :displayname: Amazon S3 request timeout (File Storage) + :systemconsole: N/A + :configjson: .FileSettings.AmazonS3RequestTimeoutMilliseconds + :environment: MM_FILESETTINGS_AMAZONS3REQUESTTIMEOUTMILLISECONDS + :description: Amount of time, in milliseconds, before requests to Amazon S3 time out. Default value is 30000 (30 seconds). + +Amazon S3 request timeout +~~~~~~~~~~~~~~~~~~~~~~~~~ + ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------+ +| The amount of time, in milliseconds, before requests to | - System Config path: N/A | +| Amazon S3 storage time out. | - ``config.json`` setting: ``".FileSettings.AmazonS3RequestTimeoutMilliseconds: 30000`` | +| | - Environment variable: ``MM_FILESETTINGS_AMAZONS3REQUESTTIMEOUTMILLISECONDS`` | +| Default is 30000 (30 seconds). | | ++---------------------------------------------------------------+-----------------------------------------------------------------------------------------+ + .. config:setting:: file-initialfont :displayname: Initial font (File Storage) :systemconsole: N/A @@ -2650,23 +2727,6 @@ Initial font | **nunito-bold.ttf**. | | +---------------------------------------------------------------+--------------------------------------------------------------------------------+ -.. config:setting:: file-amazons3requesttimeoutmilliseconds - :displayname: Amazon S3 request timeout (File Storage) - :systemconsole: N/A - :configjson: .FileSettings.AmazonS3RequestTimeoutMilliseconds - :environment: MM_FILESETTINGS_AMAZONS3REQUESTTIMEOUTMILLISECONDS - :description: Amount of time, in milliseconds, before requests to Amazon S3 time out. Default value is 30000 (30 seconds). - -Amazon S3 request timeout -~~~~~~~~~~~~~~~~~~~~~~~~~ - -+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| The amount of time, in milliseconds, before requests to | - System Config path: N/A | -| Amazon S3 storage time out. | - ``config.json`` setting: ``".FileSettings.AmazonS3RequestTimeoutMilliseconds: 30000`` | -| | - Environment variable: ``MM_FILESETTINGS_AMAZONS3REQUESTTIMEOUTMILLISECONDS`` | -| Default is 30000 (30 seconds). | | -+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+ - ---- Image proxy @@ -4190,3 +4250,109 @@ This setting isn't available in the System Console and can only be enabled in `` * **Disable Context Menu**: Turns off the context menu attached to the BrowserViews. This option is good as a library santity check. * **Force Legacy Messaging API**: Forces the app to revert back to the old messaging API instead of the newer contextBridge API. This option is a good santity check to confirm whether the new API is responsible for holding onto memory. * **Force New Messaging API**: Forces the app to use the contextBridge API and completely disables the legacy one. This option forces off listeners for the legacy API. + +Redis cache backend +~~~~~~~~~~~~~~~~~~~ + +.. include:: ../_static/badges/ent-selfhosted.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. + +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. + +Configure a Redis cache 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:: redis-cache-type + :displayname: Define cache type (CacheSettings) + :systemconsole: N/A + :configjson: CacheType + :environment: MM_CACHESETTINGS_CACHETYPE + + - **lru**: **(Default)** Mattermost uses the in-memory cache store. + - **redis**: Mattermost uses the configured Redis cache store. + +Cache type +^^^^^^^^^^ + ++-----------------------------------------------+---------------------------------------------------------------------------+ +| Define the cache type. | - System Config path: **N/A** | +| | - ``config.json setting``: ``CacheSettings`` > ``CacheType,`` > ``lru`` | +| - **lru**: **(Default)** Mattermost uses the | - Environment variable: ``MM_CACHESETTINGS_CACHETYPE`` | +| in-memory cache store. | | +| - **redis**: Mattermost uses the configured | | +| Redis cache store. | | ++-----------------------------------------------+---------------------------------------------------------------------------+ + +.. config:setting:: redis-cache-address + :displayname: Hostname of the Redis host (CacheSettings) + :systemconsole: N/A + :configjson: RedisAddress + :environment: MM_CACHESETTINGS_REDISADDRESS + :description: Specify the hostname of the Redis host. + +Redis address +^^^^^^^^^^^^^^ + ++-----------------------------------------------+---------------------------------------------------------------------------+ +| The hostname of the Redis host. | - System Config path: **N/A** | +| | - ``config.json setting``: ``CacheSettings`` > ``RedisAddress,`` | +| String input. | - Environment variable: ``MM_CACHESETTINGS_REDISADDRESS`` | ++-----------------------------------------------+---------------------------------------------------------------------------+ + +.. config:setting:: redis-cache-password + :displayname: Password of the Redis host (CacheSettings) + :systemconsole: N/A + :configjson: RedisPassword + :environment: MM_CACHESETTINGS_REDISPASSWORD + :description: Specify the password of the Redis host. + +Redis password +^^^^^^^^^^^^^^ + ++-----------------------------------------------+---------------------------------------------------------------------------+ +| The password of the Redis host. | - System Config path: **N/A** | +| | - ``config.json setting``: ``CacheSettings`` > ``RedisPassword,`` | +| String input. Leave blank if there is no | - Environment variable: ``MM_CACHESETTINGS_REDISPASSWORD`` | +| password. | | ++-----------------------------------------------+---------------------------------------------------------------------------+ + +.. config:setting:: redis-cache-database + :displayname: Database of the Redis host (CacheSettings) + :systemconsole: N/A + :configjson: RedisDB + :environment: MM_CACHESETTINGS_REDISDB + :description: Specify the databse of the Redis host. Zero-indexed number up to 15. Typically set to 0. Redis allows a maximum of 16 databases. + +Redis database +^^^^^^^^^^^^^^ + ++-----------------------------------------------+---------------------------------------------------------------------------+ +| The database of the Redis host. | - System Config path: **N/A** | +| | - ``config.json setting``: ``CacheSettings`` > ``RedisDB,`` | +| Zero-indexed number up to 15. Typically set | - Environment variable: ``MM_CACHESETTINGS_REDISDB`` | +| to ``0``. Redis allows a maximum of 16 | | +| databases. | | ++-----------------------------------------------+---------------------------------------------------------------------------+ + +.. config:setting:: redis-cache-type + :displayname: Define the cache type (CacheSettings) + :systemconsole: N/A + :configjson: CacheType + :environment: MM_CACHESETTINGS_CACHETYPE + + - **true**: Client-side cache of Redis is disabled. Typically used as a test option, and not in production environments. + - **false**: **(Default)** Client-side cache of Redis is enabled. + +Disable client cache +^^^^^^^^^^^^^^^^^^^^ + ++-----------------------------------------------+--------------------------------------------------------------------------------------+ +| Disables the client-side cache of Redis. | - System Config path: **N/A** | +| | - ``config.json setting``: ``CacheSettings`` > ``DisableClientCache,`` > ``false`` | +| - **true**: Client-side cache of Redis is | - Environment variable: ``MM_CACHESETTINGS_REDISDB`` | +| disabled. Typically used as a test option, | | +| and not in production environments. | | +| - **false**: **(Default)** Client-side cache | | +| of Redis is enabled. | | ++-----------------------------------------------+--------------------------------------------------------------------------------------+ diff --git a/source/configure/experimental-configuration-settings.rst b/source/configure/experimental-configuration-settings.rst index d939100c6d6..6b023d7b005 100644 --- a/source/configure/experimental-configuration-settings.rst +++ b/source/configure/experimental-configuration-settings.rst @@ -1,7 +1,10 @@ Experimental configuration settings ===================================== -Both self-hosted and Cloud admins can access the following configuration settings in the System Console. Self-hosted admins can also edit the ``config.json`` file as described in the following tables. +.. include:: ../_static/badges/allplans-cloud-selfhosted.rst + :start-after: :nosearch: + +Review and manage the following experimental configuration options in the System Console by selecting the **Product** |product-list| menu, selecting **System Console**, and then selecting **Experimental > Features**: - `Experimental System Console configuration settings <#experimental-system-console-configuration-settings>`__ - `Experimental Bleve configuration settings <#experimental-bleve-configuration-settings>`__ @@ -9,16 +12,18 @@ Both self-hosted and Cloud admins can access the following configuration setting - `Experimental job configuration settings <#experimental-job-configuration-settings>`__ - `Experimental configuration settings for self-hosted deployments only <#experimental-configuration-settings-for-self-hosted-deployments-only>`__ +.. 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, one ``LoginButtonColor`` value is under ``LdapSettings``. + + - If using a tool such as `jq `__, you'd enter: ``cat config/config.json | jq '.LdapSettings.LoginButtonColor'`` + - When working with the ``config.json`` file manually, look for an object such as ``LdapSettings``, then within that object, find the key ``LoginButtonColor``. + ---- Experimental System Console configuration settings -------------------------------------------------- -.. include:: ../_static/badges/allplans-cloud-selfhosted.rst - :start-after: :nosearch: - -Access the following experimental configuration settings in the System Console by going to **Experimental > Features**. - .. config:setting:: exp-ldaploginbuttoncolor :displayname: AD/LDAP login button color (Experimental) :systemconsole: Experimental > Features @@ -988,7 +993,7 @@ Output log and audit records to any combination of console, local file, syslog, Experimental configuration settings for self-hosted deployments only -------------------------------------------------------------------- -.. include:: ../_static/badges/allplans-selfhosted.rst +.. 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. 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..e6b41a30dbd 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>`__ @@ -16,7 +16,14 @@ Both self-hosted and Cloud admins can access the following configuration setting - `File Sharing and Downloads <#file-sharing-and-downloads>`__ - `Public Links <#public-links>`__ - `Notices <#notices>`__ -- `Connected Workspaces <#connected-workspaces>`__ +- `Connected Workspaces (Beta) <#connected-workspaces-beta>`__ + +.. 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``. ---- @@ -331,13 +338,6 @@ iOS app download link | String input. Default is ``https://about.mattermost.com/mattermost-ios-app/``. | | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ -.. config:setting:: exp-appcustomurlschemes - :displayname: App custom URL schemes (Customization) - :systemconsole: N/A - :configjson: .NativeAppSettings.AppCustomURLSchemes - :environment: MM_NativeAppSettings_AppCustomURLSchemes = mmauth:// mmauthbeta:// - :description: Define valid custom URL schemes for redirect links provided by custom-built mobile Mattermost apps. - .. config:setting:: custom-enabledesktoplandingpage :displayname: Enable desktop app landing page (Customization) :systemconsole: Site Configuration > Customization @@ -357,6 +357,13 @@ Enable desktop app landing page | | - Environment variable: ``MM_SERVICESETTINGS_ENABLEDESKTOPLANDINGPAGE`` | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------+ +.. config:setting:: exp-appcustomurlschemes + :displayname: App custom URL schemes (Customization) + :systemconsole: N/A + :configjson: .NativeAppSettings.AppCustomURLSchemes + :environment: MM_NativeAppSettings_AppCustomURLSchemes = mmauth:// mmauthbeta:// + :description: Define valid custom URL schemes for redirect links provided by custom-built mobile Mattermost apps. + App custom URL schemes ~~~~~~~~~~~~~~~~~~~~~~ @@ -412,7 +419,7 @@ Access the following configuration settings in the System Console by going to ** :environment: MM_LOCALIZATIONSETTINGS_DEFAULTSERVERLOCALE :description: The default language for system messages and logs. Default value is **en**. - +Default server language ~~~~~~~~~~~~~~~~~~~~~~~ +--------------------------------------------------------------------------------+--------------------------------------------------------------------------------+ @@ -480,6 +487,36 @@ Available languages | Default is ``"en"``. | | +--------------------------------------------------------------------------------+---------------------------------------------------------------------------+ +.. config:setting:: localization-enable-wip-locales + :displayname: Enable experimental locales (Localization) + :systemconsole: Site Configuration > Localization + :configjson: EnableExperimentalLocales + :environment: MM_LOCALIZATIONETTINGS_ENABLEEXPERIMENTALLOCALES + :description: nable work in progress languages in Mattermost to review translations and identify translation gaps. + + - **true**: Work in progress languages are available in Mattermost in addition to officially supported languages. + - **false**: **(Default)** Only officially supported languages are available in Mattermost. + +Enable experimental locales +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Enable work in progress languages in Mattermost to review translations and identify translation gaps. + ++--------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| - **true**: Work in progress languages are available | - System Config path: **Site Configuration > Localization** | +| in Mattermost in addition to officially supported | - ``config.json`` setting: ``LocalizationSettings`` > ``EnableExperimentalLocales`` > ``false`` | +| languages. | - Environment variable: ``MM_LOCALIZATIONETTINGS_ENABLEEXPERIMENTALLOCALES`` | +| - **false**: **(Default)** Only officially supported | | +| languages are available in Mattermost. | | ++--------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + +.. note:: + + - Cloud system admins can request this configuration setting to be enabled for their instance by contacting their Mattermost Account Manager. + - Work in progress languages may be incomplete. Strings missing translations display in US English. + - Currently, only web and desktop app product strings are impacted by this configuration setting. Server and mobile product strings aren't impacted by this setting. + - See the :ref:`language ` documentation for details on selecting a language preference in Mattermost. + ---- Users and teams @@ -633,7 +670,6 @@ Lock teammate name display for all users | | - ``config.json`` setting: ``TeamSettings`` > ``LockTeammateNameDisplay`` > ``false`` | | - **true**: Users **cannot** change the Teammate Name Display. | - Environment variable: ``MM_TEAMSETTINGS_LOCKTEAMMATENAMEDISPLAY`` | | - **false**: **(Default)** Users can change the Teammate Name Display setting. | | -| | | +---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+ .. config:setting:: users-viewarchivedchannels @@ -1802,6 +1838,7 @@ Connected workspaces (Beta) :start-after: :nosearch: The following settings aren't available in the System Console and can only be set in ``config.json``. + When connected workspaces are enabled, system admins can :doc:`create and manage connected workspaces ` in the System Console by going to **Site Configuration > Connected Workspaces (Beta)**. .. config:setting:: enable-connected-workspaces @@ -1814,8 +1851,11 @@ When connected workspaces are enabled, system admins can :doc:`create and manage Enable connected workspaces (Beta) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Enable the ability to establish secure connections between Mattermost instances, and invite secured connections to shared channels where users can participate as they would in any public and private channel. -Both configuration settings are disabled by default and must be enabled in order to share channels with secure connections. Enabling connected workspace functionality requires a server restart. +Enable the ability to establish secure connections between Mattermost instances, and invite secured connections to shared channels where users can participate as they would in any public and private channel. + +Connected workspaces requires Mattermost Enterprise servers running v10.2 or later. + +By default, both configuration settings are disabled and must be enabled in order to share channels with secure connections. Enabling connected workspace functionality requires a server restart. This feature's two ``config.json`` settings include: 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/guides/upgrade-mattermost.rst b/source/guides/upgrade-mattermost.rst index 9bb388cb10a..c70c67a5c49 100644 --- a/source/guides/upgrade-mattermost.rst +++ b/source/guides/upgrade-mattermost.rst @@ -11,6 +11,7 @@ Upgrade Mattermost Important upgrade notes Prepare to upgrade Mattermost + Communicate scheduled maintenance Upgrade Mattermost Server Enterprise install and upgrade Install a license key @@ -19,6 +20,7 @@ Upgrade Mattermost Stay up to date with the latest features and improvements. * :doc:`Prepare to upgrade Mattermost ` - Learn how to prepare for a Mattermost upgrade. +* :doc:`Communicate scheduled mainenance ` - Learn best practices for communicating scheduled server mainenance in advance of a service maintenance window. * :doc:`Upgrade Mattermost Server ` - Learn the basics of upgrading your Mattermost server to the latest version. * :doc:`Enterprise install and upgrade ` - Learn how to upgrade your Mattermost server to premium versions. * :doc:`Install a license key ` - Learn how to add or change a Mattermost license key. diff --git a/source/install/download-latest-tarball.rst b/source/install/download-latest-tarball.rst index d1aeb96df0a..85f3b0f2e37 100644 --- a/source/install/download-latest-tarball.rst +++ b/source/install/download-latest-tarball.rst @@ -9,7 +9,7 @@ Using ``wget``, download the Mattermost Server release you want to install. .. code-block:: sh - wget https://releases.mattermost.com/10.3.2/mattermost-10.3.2-linux-amd64.tar.gz + wget https://releases.mattermost.com/10.4.1/mattermost-10.4.1-linux-amd64.tar.gz .. tab:: Current ESR 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 diff --git a/source/manage/code-signing-custom-builds.rst b/source/manage/code-signing-custom-builds.rst index afc7d0653bb..e6bb3828aa5 100644 --- a/source/manage/code-signing-custom-builds.rst +++ b/source/manage/code-signing-custom-builds.rst @@ -25,7 +25,7 @@ Prerequisites .. tab:: Mac - 1. **Developer ID Application Certificate**: Obtain from Apple. It requires an `Apple Developer account `_. + 1. **Developer ID Application Certificate**: Obtain from Apple. It requires an Apple Developer account. 2. **Xcode**: Ensure `Xcode `_ is installed. Process diff --git a/source/manage/generating-support-packet.rst b/source/manage/generating-support-packet.rst index c1807dc8491..bc152a12820 100644 --- a/source/manage/generating-support-packet.rst +++ b/source/manage/generating-support-packet.rst @@ -20,6 +20,7 @@ A Mattermost Support Packet can contain the following files: - ``plugins.json`` - ``sanitized_config.json`` - ``support_packet.yaml`` +- ``diagnostics.yaml`` (core plugin diagnostics data) - `Go performance metrics <#go-performance-metrics>`__, including: ``cpu.prof``, ``heap.prof``, and ``goroutines`` - ``warning.txt`` (present when issues are encountered during packet generation) @@ -28,6 +29,7 @@ A Mattermost Support Packet can contain the following files: - Each node in the cluster of a :doc:`high availability ` deployment has its own ``mattermost.log`` file. - LDAP groups are not included during Support Packet generation. Only ``LDAP Version`` and ``LDAP Vendor`` are included when present. These values are included in the ``support_packet.yaml`` file. - From Mattermost v9.11, ``LDAP Vendor`` errors are included in the Support Packet. If fetching the LDAP Vendor name fails, the Support Packet generation includes the error in ``warning.txt``. If no LDAP Vendor name is found, the Support Packet lists them as ``unknown``. + - From Mattermost v10.4, a new ``diagnostics.yaml`` file includes Mattermost Calls diagostics data, including plugin version, calls and active session counts, as well as average duration and participant counts. Generate --------- @@ -61,9 +63,11 @@ Generate Santitize confidential data --------------------------- -When present, the following information is santized during packet generation: ``LdapSettings.BindPassword``, ``FileSettings.PublicLinkSalt``, ``FileSettings.AmazonS3SecretAccessKey``, ``EmailSettings.SMTPPassword``, ``GitLabSettings.Secret``, ``GoogleSettings.Secret``, ``Office365Settings.Secret``, ``OpenIdSettings.Secret``, ``SqlSettings.DataSource``, ``SqlSettings.AtRestEncryptKey``, ``ElasticsearchSettings.Password``, ``All SqlSettings.DataSourceReplicas``, ``All SqlSettings.DataSourceSearchReplicas``, ``MessageExportSettings.GlobalRelaySettings.SmtpPassword``, and ``ServiceSettings.SplitKey``. Plugins are not sanitized during packet generation. +When present, the following information is santized during packet generation: ``LdapSettings.BindPassword``, ``FileSettings.PublicLinkSalt``, ``FileSettings.AmazonS3SecretAccessKey``, ``EmailSettings.SMTPPassword``, ``GitLabSettings.Secret``, ``GoogleSettings.Secret``, ``Office365Settings.Secret``, ``OpenIdSettings.Secret``, ``SqlSettings.DataSource``, ``SqlSettings.AtRestEncryptKey``, ``ElasticsearchSettings.Password``, ``All SqlSettings.DataSourceReplicas``, ``All SqlSettings.DataSourceSearchReplicas``, ``MessageExportSettings.GlobalRelaySettings.SmtpPassword``, and ``ServiceSettings.SplitKey``. -Ensure you sanitize any additional confidential details in the ``plugin.json`` file before sharing it with Mattermost. Replace details with example strings that contain the same special characters if possible, as special characters are common causes of configuration errors. +.. important:: + + Plugins are not sanitized during packet generation. Ensure you sanitize any additional confidential details in the ``plugin.json`` file before sharing it with Mattermost. Replace details with example strings that contain the same special characters if possible, as special characters are common causes of configuration errors. Share the packet with Mattermost -------------------------------- diff --git a/source/onboard/connected-workspaces.rst b/source/onboard/connected-workspaces.rst index 4f763aa508e..ac1923e88cb 100644 --- a/source/onboard/connected-workspaces.rst +++ b/source/onboard/connected-workspaces.rst @@ -13,15 +13,17 @@ A channel’s permissions and access continues to be governed by each server sep Set up connected workspaces --------------------------- -The process of connecting Mattermost workspaces involves the following 4 steps: +The process of connecting Mattermost workspaces involves the following 5 steps: -1. Each system admin of a Mattermost instance who wants to connect to another Mattermost workspaces must `enable the connected workflows functionality <#enable-connected-workflows>`__. +1. Ensure that all Mattermost Enterprise servers are running v10.2 or later. -2. Using the System Console or slash commands, system admins `create a secure and trusted connection <#create-a-secure-connection>`__ with other Mattermost Enterprise instances. This process involves creating a password-protected, encrypted invitation, creating a strong decryption password, then sending the invitation and password to the system admin of a remote Mattermost instance. +2. `Enable the connected workflows functionality <#enable-connected-workflows>`__ for each Mattermost Enterprise instance you want to connect. -3. Using the System Console or slash commands, a remote system admin receives the invitation and `accepts the invitation <#accept-a-secure-connection-invitation>`__. +3. System admins must `create a secure and trusted connection <#create-a-secure-connection>`__ with other Mattermost Enterprise instances using the System Console or slash commands. This process involves creating a password-protected, encrypted invitation, creating a strong decryption password, then sending the invitation and password to the system admin of a remote Mattermost instance. -4. Once a trusted relationship is established between 2 Mattermost servers, system admins can `share specific public or private channels <#share-channels-with-secure-connections>`__ with secure connections. +4. When a remote system admin receives the invitation, they must `accept the invitation <#accept-a-secure-connection-invitation>`__ using the System Console or slash commands. + +5. Once a trusted relationship is established between 2 Mattermost servers, system admins can `share specific public or private channels <#share-channels-with-secure-connections>`__ with secure connections. .. note:: diff --git a/source/onboard/sso-entraid.rst b/source/onboard/sso-entraid.rst index 8d24297c83c..57ef3476381 100644 --- a/source/onboard/sso-entraid.rst +++ b/source/onboard/sso-entraid.rst @@ -72,7 +72,7 @@ Step 3: Configure Mattermost for Entra ID SSO Note about Microsoft Active Directory Tenants ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -A Microsoft Active Directory (AD) tenant is a dedicated instance of Azure Active Directory (Azure AD) that you own and would have received when signing up for a Microsoft cloud service, such as Azure or Entra ID. Tenants are commonly used by organizations who want to store information about their users, such as passwords, user profile data, and permissions. You can learn more about `getting an Azure AD tenant here `_. +A Microsoft Active Directory (AD) tenant is a dedicated instance of Azure Active Directory (Azure AD) that you own and would have received when signing up for a Microsoft cloud service, such as Azure or Entra ID. Tenants are commonly used by organizations who want to store information about their users, such as passwords, user profile data, and permissions. See the Microsoft Entra ID `_ documentation to learn more about getting an Azure AD tenant. To allow your Azure AD users to log in to Mattermost using Entra ID SSO, you must register Mattermost in the Microsoft Azure AD tenant that contains the users' information. The registration can be done from the `Microsoft Azure portal `__. The steps to register the Mattermost account in the tenant should be similar to those provided above, and you can find more information about `integrating apps with Azure AD here `_. diff --git a/source/preferences/customize-your-channel-sidebar.rst b/source/preferences/customize-your-channel-sidebar.rst index 9d2ca81fed7..c1a29f847d2 100644 --- a/source/preferences/customize-your-channel-sidebar.rst +++ b/source/preferences/customize-your-channel-sidebar.rst @@ -23,6 +23,7 @@ Using Mattermost in a web browser or the desktop app, you can customize your sid - `Sort channels in each category <#sort-channels-in-categories>`__ manually, alphabetically, or by recent activity - `Filter your sidebar to view unread channels only <#group-unread-channels-separately>`__, or choose to group unread messages into an **Unreads** category - `Manage your direct messages <#manage-direct-messages>`__ by sorting them alphabetically or by recent activity, and by setting how many to display in your sidebar +- `Make channel categories work for you <#make-categories-work-for-you>`__ by prefixing category names with emojis, by collapsing and expanding categories, by reordering categories, and by adding direct message conversations to categories. .. image:: ../images/channel_sidebar_updates.gif :alt: Organize your channel sidebar with channel categories. @@ -38,30 +39,14 @@ Next, type a category name, select **Create**, then drag any channels or direct Your custom categories can't be shared with other Mattermost users. -Make categories work for you ----------------------------- - -**Categories are collapsible** - -- When collapsed, only unread channels display to reduce unnecessary scrolling. -- When expanded, all channels in the category display, including channels with unread messages. - -**You can reorder categories** - -- Drag to reorder entire categories to prioritize important conversations. - -**Categories can contain direct message conversations** - -- Select and drag direct messages into any category. You can also multi-select direct messages to drag them together as a group. - Rename categories -~~~~~~~~~~~~~~~~~ +------------------ 1. Select the **Category options** icon in the sidebar, then select **Rename Category**. 2. Type a new category name, then select **Rename**. Delete categories -~~~~~~~~~~~~~~~~~ +------------------ 1. Select the **Category options** icon in the sidebar, then select **Delete Category**. 2. Select **Delete** to confirm or select **X** to cancel. @@ -71,7 +56,7 @@ All channels and direct message conversations in the deleted category move back Organize channels in categories ------------------------------- -Once you've created categories, you can move channels around to organize your sidebar. +Once you've created categories, you can move channels around to organize your sidebar by dragging and dropping, or by moving. Drag and drop selections ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -175,3 +160,33 @@ Choose to show **10**, **15**, **20**, or **40** messages. Once you exceed the n .. note:: Direct message conversations that you add to custom categories don't count against the maximum number of conversations shown in the **Direct Messages** category. + +Make categories work for you +---------------------------- + +Prefix channel category names with emojis +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Channel category names can include emojis. Specify the emoji by its name in the format ``:smile:``. We recommend prefixing channel category names with emojis for the following reasons: + +- Emojis can make it easier for users to quickly identify and manage channels and channel categories, particularly in large workspaces with many channels. +- Sharing the same emoji across channels and categories related to a specific category or function helps maintain organization and consistency across the workspace. +- Making channel categories more visually distinct with emojis helps users find what they need more quickly and easily at a glance, reducing the time spent searching for the right place to take action. +- New users can quickly understand the purpose of various channels and channel categories based on their emoji prefixes without needing extensive explanations. +- As users grasp channel structure through emojis, the time and effort needed to train new members on navigating the workspace is reduced. +- A well-organized and visually appealing workspace can encourage users to participate more actively, which can lead to more effective communication and collaboration. + +Categories are collapsible +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When you collapse a channel category, only unread channels display to reduce unnecessary scrolling. When you expand a channel category, all channels in the category display, including channels with unread messages. + +Reorder categories +~~~~~~~~~~~~~~~~~~ + +Drag to reorder entire categories to prioritize important conversations. + +Categories can contain direct message conversations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Select and drag direct messages into any category. You can also multi-select direct messages to drag them together as a group. \ No newline at end of file diff --git a/source/preferences/customize-your-theme.rst b/source/preferences/customize-your-theme.rst index 3a945ef12b4..49de83315c6 100644 --- a/source/preferences/customize-your-theme.rst +++ b/source/preferences/customize-your-theme.rst @@ -6,13 +6,7 @@ Customize your Mattermost theme .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -The colors of the Mattermost user interface are customizable. You can choose from `five standard themes <#standard-themes>`__ designed by the Mattermost team, design your own theme based on a standard theme, or `import your theme colors from a Slack instance <#import-theme-from-slack>`__. Your theme changes apply to all teams you're a member of, and are visible across all Mattermost clients. - -.. tip:: - - Mattermost Enterprise customers can configure a different theme for every team they're a member of. - -To customize your Mattermost theme: +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. .. tab:: Web/desktop @@ -28,13 +22,6 @@ To customize your Mattermost theme: You can define a custom theme using Mattermost in a web browser or the desktop app. -Import a Slack theme --------------------- - -Using Mattermost in a web browser or the desktop app, you can select **Import theme colors from Slack** to import a Slack theme. - -In Slack, go to **Preferences > Sidebar Theme** and open the custom theme option. From there, copy the theme color vector and then paste it into the **Input Slack Theme** input box in Mattermost. Any theme settings that are not customizable in Slack will default to the “Sapphire” standard theme settings. - Custom themes ------------- @@ -42,90 +29,13 @@ Select **Custom Theme**, then expand the :ref:`Sidebar Styles Themes**, select **Create a custom theme**, then copy the theme color values. - -In Mattermost, select **Import theme colors from Slack**, then paste the color values into the input box and select **Submit**. Any theme settings that are not customizable in Slack will default to the “Mattermost” standard theme settings. Select **Save** to confirm your theme changes. - Custom theme examples ----------------------- +~~~~~~~~~~~~~~~~~~~~~ Customize your theme colors and share them with others by copying and pasting theme values into the input box. Below are some example themes with their corresponding theme values. Mattermost -~~~~~~~~~~ +^^^^^^^^^^^ .. image:: ../images/Mattermost.png :alt: Mattermost Theme @@ -137,7 +47,7 @@ Want this theme? Copy and paste the following code into Mattermost: {"sidebarBg":"#145dbf","sidebarText":"#ffffff","sidebarUnreadText":"#ffffff","sidebarTextHoverBg":"#4578bf","sidebarTextActiveBorder":"#579eff","sidebarTextActiveColor":"#ffffff","sidebarHeaderBg":"#1153ab","sidebarTeamBarBg":"#0b428c","sidebarHeaderTextColor":"#ffffff","onlineIndicator":"#06d6a0","awayIndicator":"#ffbc42","dndIndicator":"#f74343","mentionBg":"#ffffff","mentionBj":"#ffffff","mentionColor":"#145dbf","centerChannelBg":"#ffffff","centerChannelColor":"#3d3c40","newMessageSeparator":"#ff8800","linkColor":"#2389d7","buttonBg":"#166de0","buttonColor":"#ffffff","errorTextColor":"#fd5960","mentionHighlightBg":"#ffe577","mentionHighlightLink":"#166de0","codeTheme":"github"} Organization -~~~~~~~~~~~~ +^^^^^^^^^^^^^ .. image:: ../images/Organization.png :alt: Organization Theme @@ -149,7 +59,7 @@ Want this theme? Copy and paste the following code into Mattermost: {"sidebarBg":"#2071a7","sidebarText":"#ffffff","sidebarUnreadText":"#ffffff","sidebarTextHoverBg":"#136197","sidebarTextActiveBorder":"#7ab0d6","sidebarTextActiveColor":"#ffffff","sidebarHeaderBg":"#2f81b7","sidebarTeamBarBg":"#256996","sidebarHeaderTextColor":"#ffffff","onlineIndicator":"#7dbe00","awayIndicator":"#dcbd4e","dndIndicator":"#ff6a6a","mentionBg":"#fbfbfb","mentionColor":"#2071f7","centerChannelBg":"#f2f4f8","centerChannelColor":"#333333","newMessageSeparator":"#ff8800","linkColor":"#2f81b7","buttonBg":"#1dacfc","buttonColor":"#ffffff","errorTextColor":"#a94442","mentionHighlightBg":"#f3e197","mentionHighlightLink":"#2f81b7","codeTheme":"github"} Mattermost Dark -~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^ .. image:: ../images/MattermostDark.png :alt: Mattermost Dark Theme @@ -161,7 +71,7 @@ Want this theme? Copy and paste the following code into Mattermost: {"sidebarBg":"#1b2c3e","sidebarText":"#ffffff","sidebarUnreadText":"#ffffff","sidebarTextHoverBg":"#4a5664","sidebarTextActiveBorder":"#66b9a7","sidebarTextActiveColor":"#ffffff","sidebarHeaderBg":"#1b2c3e","sidebarTeamBarBg":"#152231","sidebarHeaderTextColor":"#ffffff","onlineIndicator":"#65dcc8","awayIndicator":"#c1b966","dndIndicator":"#e81023","mentionBg":"#b74a4a","mentionColor":"#ffffff","centerChannelBg":"#2f3e4e","centerChannelColor":"#dddddd","newMessageSeparator":"#5de5da","linkColor":"#a4ffeb","buttonBg":"#4cbba4","buttonColor":"#ffffff","errorTextColor":"#ff6461","mentionHighlightBg":"#984063","mentionHighlightLink":"#a4ffeb","codeTheme":"solarized-dark"} Windows Dark -~~~~~~~~~~~~ +^^^^^^^^^^^^^ .. image:: ../images/WindowsDark.png :alt: Windows Dark Theme @@ -173,7 +83,7 @@ Want this theme? Copy and paste the following code into Mattermost: {"sidebarBg":"#171717","sidebarText":"#ffffff","sidebarUnreadText":"#ffffff","sidebarTextHoverBg":"#302e30","sidebarTextActiveBorder":"#196caf","sidebarTextActiveColor":"#ffffff","sidebarHeaderBg":"#1f1f1f","sidebarTeamBarBg":"#181818","sidebarHeaderTextColor":"#ffffff","onlineIndicator":"#399fff","awayIndicator":"#c1b966","dndIndicator":"#e81023","mentionBg":"#0177e7","mentionColor":"#ffffff","centerChannelBg":"#1f1f1f","centerChannelColor":"#dddddd","newMessageSeparator":"#cc992d","linkColor":"#0d93ff","buttonBg":"#0177e7","buttonColor":"#ffffff","errorTextColor":"#ff6461","mentionHighlightBg":"#784098","mentionHighlightLink":"#a4ffeb","codeTheme":"monokai"} GitHub Theme -~~~~~~~~~~~~ +^^^^^^^^^^^^^ .. image:: ../images/GitHub.png :alt: GitHub Theme @@ -185,7 +95,7 @@ Want this theme? Copy and paste the following code into Mattermost: {"awayIndicator":"#D4B579","buttonBg":"#66CCCC","buttonColor":"#FFFFFF","centerChannelBg":"#FFFFFF","centerChannelColor":"#444444","codeTheme":"github","linkColor":"#3DADAD","mentionBg":"#66CCCC","mentionColor":"#FFFFFF","mentionHighlightBg":"#3DADAD","mentionHighlightLink":"#FFFFFF","newMessageSeparator":"#F2777A","onlineIndicator":"#52ADAD","sidebarBg":"#F2F0EC","sidebarHeaderBg":"#E8E6DF","sidebarHeaderTextColor":"#424242","sidebarText":"#2E2E2E","sidebarTextActiveBorder":"#66CCCC","sidebarTextActiveColor":"#594545","sidebarTextHoverBg":"#E0E0E0","sidebarUnreadText":"#515151"} Monokai Theme -~~~~~~~~~~~~~ +^^^^^^^^^^^^^^ .. image:: ../images/Monokai.png :alt: Monokai Theme @@ -197,7 +107,7 @@ Want this theme? Copy and paste the following code into Mattermost: {"awayIndicator":"#B8B884","buttonBg":"#90AD58","buttonColor":"#FFFFFF","centerChannelBg":"#FFFFFF","centerChannelColor":"#444444","codeTheme":"monokai","linkColor":"#90AD58","mentionBg":"#7E9949","mentionColor":"#FFFFFF","mentionHighlightBg":"#54850C","mentionHighlightLink":"#FFFFFF","newMessageSeparator":"#90AD58","onlineIndicator":"#99CB3F","sidebarBg":"#262626","sidebarHeaderBg":"#363636","sidebarHeaderTextColor":"#FFFFFF","sidebarText":"#FFFFFF","sidebarTextActiveBorder":"#7E9949","sidebarTextActiveColor":"#FFFFFF","sidebarTextHoverBg":"#525252","sidebarUnreadText":"#CCCCCC"} Solarized Dark Theme -~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^ .. image:: ../images/SolarizedDark.png :alt: Solarized Dark Theme @@ -209,7 +119,7 @@ Want this theme? Copy and paste the following code into Mattermost: {"awayIndicator":"#E0B333","buttonBg":"#859900","buttonColor":"#fdf6e3","centerChannelBg":"#073642","centerChannelColor":"#93a1a1","codeTheme":"solarized-dark","linkColor":"#268bd2","mentionBg":"#dc322f","mentionColor":"#ffffff","mentionHighlightBg":"#d33682","mentionHighlightLink":"#268bd2","newMessageSeparator":"#cb4b16","onlineIndicator":"#2AA198","sidebarBg":"#073642","sidebarHeaderBg":"#002B36","sidebarHeaderTextColor":"#FDF6E3","sidebarText":"#FDF6E3","sidebarTextActiveBorder":"#d33682","sidebarTextActiveColor":"#FDF6E3","sidebarTextHoverBg":"#CB4B16","sidebarUnreadText":"#FDF6E3","errorTextColor":"#dc322f"} Gruvbox Dark Theme -~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^ .. image:: ../images/GruvboxDark.png :alt: Gruvbox Dark Theme @@ -221,7 +131,7 @@ Want this theme? Copy and paste the following code into Mattermost: {"awayIndicator":"#fabd2f","buttonBg":"#689d6a","buttonColor":"#ebdbb2","centerChannelBg":"#3c3836","centerChannelColor":"#ebdbb2","codeTheme":"monokai","errorTextColor":"#fb4934","linkColor":"#83a598","mentionBg":"#b16286","mentionColor":"#fbf1c7","mentionHighlightBg":"#d65d0e","mentionHighlightLink":"#fbf1c7","newMessageSeparator":"#d65d0e","onlineIndicator":"#b8bb26","sidebarBg":"#282828","sidebarHeaderBg":"#1d2021","sidebarHeaderTextColor":"#ebdbb2","sidebarText":"#ebdbb2","sidebarTextActiveBorder":"#d65d0e","sidebarTextActiveColor":"#fbf1c7","sidebarTextHoverBg":"#d65d0e","sidebarUnreadText":"#fe8019"} One Dark Theme -~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^ .. image:: ../images/OneDark.png :alt: One Dark Theme @@ -235,7 +145,7 @@ Want this theme? Copy and paste the following code into Mattermost: {"sidebarBg":"#21252b","sidebarText":"#abb2bf","sidebarUnreadText":"#abb2bf","sidebarTextHoverBg":"#3a3f4b","sidebarTextActiveBorder":"#4d78cc","sidebarTextActiveColor":"#d7dae0","sidebarHeaderBg":"#282c34","sidebarHeaderTextColor":"#abb2bf","onlineIndicator":"#98c379","awayIndicator":"#d19a66","dndIndicator":"#be5046","mentionBg":"#98c379","mentionColor":"#ffffff","centerChannelBg":"#282c34","centerChannelColor":"#abb2bf","newMessageSeparator":"#c67add","linkColor":"#61afef","buttonBg":"#4d78cc","buttonColor":"#ffffff","errorTextColor":"#f44747","mentionHighlightBg":"#525a69","mentionHighlightLink":"#61afef","codeTheme":"monokai","mentionBg":"#98c379"} Discord Dark Theme -~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^ .. image:: ../images/DiscordDarkTheme.png :alt: Discord Dark Theme @@ -249,7 +159,7 @@ Want this theme? Copy and paste the following code into Mattermost: {"sidebarBg":"#2f3136","sidebarText":"#ffffff","sidebarUnreadText":"#ffffff","sidebarTextHoverBg":"#33363c","sidebarTextActiveBorder":"#66cfa0","sidebarTextActiveColor":"#ffffff","sidebarHeaderBg":"#27292c","sidebarHeaderTextColor":"#ffffff","onlineIndicator":"#43b581","awayIndicator":"#faa61a","dndIndicator":"#f04747","mentionBg":"#6e84d2","mentionBg":"#6e84d2","mentionColor":"#ffffff","centerChannelBg":"#36393f","centerChannelColor":"#dddddd","newMessageSeparator":"#6e84d2","linkColor":"#2095e8","buttonBg":"#43b581","buttonColor":"#ffffff","errorTextColor":"#ff6461","mentionHighlightBg":"#3d414f","mentionHighlightLink":"#6e84d2","codeTheme":"monokai"} Night Owl Dark Theme -~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^ .. image:: ../images/NightOwlDark.png :alt: Night Owl Dark Theme @@ -261,11 +171,85 @@ Want this theme? Copy and paste the following code into Mattermost: {"sidebarBg":"#011627","sidebarText":"#d6deeb","sidebarUnreadText":"#d6deeb","sidebarTextHoverBg":"#1d3b53","sidebarTextActiveBorder":"#ff2c83","sidebarTextActiveColor":"#82aaff","sidebarHeaderBg":"#1d3b53","sidebarHeaderTextColor":"#d6deeb","onlineIndicator":"#addb67","awayIndicator":"#ffbc42","dndIndicator":"#f74343","mentionBg":"#d6deeb","mentionBg":"#d6deeb","mentionColor":"#145dbf","centerChannelBg":"#011627","centerChannelColor":"#d6deeb","newMessageSeparator":"#ff8800","linkColor":"#2389d7","buttonBg":"#166de0","buttonColor":"#011627","errorTextColor":"#fd5960","mentionHighlightBg":"#0b2942","mentionHighlightLink":"#82aaff","codeTheme":"solarized-dark"} Dark Theme (desktop app only) ------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -On Windows and macOS, the system display preference that you set on your computer (e.g., Light Mode or Dark Mode) is also applied to the Mattermost desktop app. +On Windows and macOS, the system display preference that you set on your computer (e.g., Light Mode or Dark Mode) is also applied to the Mattermost desktop app. On Linux, manage this manually via the **View** menu. .. image:: ../images/dark-theme-via-os.gif :alt: The system preference you set for Light Mode or Dark Mode on your computer is automatically applied to the Mattermost Desktop App. -On Linux, you can manage this manually via the **View** menu. \ No newline at end of file +Export your custom theme +~~~~~~~~~~~~~~~~~~~~~~~~ + +Export a theme from Mattermost by copying the theme values from the Custom Theme menu. + +Import a custom theme +~~~~~~~~~~~~~~~~~~~~~~ + +Import a theme into Mattermost by pasting the theme values into the Custom Theme menu. Copy existing theme values, then paste the theme values into the **Copy and paste to share theme colors** field. Select **Save** to confirm your theme changes. + +Sidebar styles +~~~~~~~~~~~~~~ + +You can customize every aspect of your Mattermost theme, as described below: + +Sidebar BG + Background color of the Channels pane, and Account and Team settings navigation sidebars. +Sidebar Text + Text color of read channels in the Channels pane, and tabs in the Account and Team settings navigation sidebar. +Sidebar Header BG + Background color of the header above the Channels pane and all dialog window headers. +Team Sidebar BG + Background color of the Global Header. +Sidebar Header Text + Text color of the header above the Channels pane and all dialog window headers. +Sidebar Unread Text + Text color of unread channels in the Channels pane. +Sidebar Text Hover BG + Background color behind channel names and settings tabs as you hover over them. +Sidebar Text Active Border + Color of the rectangular marker on the left side of the Channels pane or Settings sidebar indicating the active channel or tab. +Sidebar Text Active Color + Text color of the active channel or tab in the Channels pane or Settings sidebar. +Online Indicator + Color of the online indicator appearing next to team members names in the direct messages list. +Away Indicator + Color of the away indicator appearing next to team members names in the direct messages list when they have had no browser activity for 5 minutes. +Do Not Disturb Indicator + Color of the do not disturb indicator appearing next to team members names in the direct messages list. +Mention Jewel BG + Background color of the jewel indicating unread mentions that appears to the right of the channel name. This is also the background color of the “Unread Posts Below/Above” indicator appearing at the top or bottom of the Channels pane on shorter browser windows. +Mention Jewel Text + Text color on the mention jewel indicating the number of unread mentions. This is also the text color on the “Unread Posts Below/Above” indicator. + +Center channel styles +~~~~~~~~~~~~~~~~~~~~~ + +You can customize every aspect of your Mattermost theme, as described below: + +Center Channel BG + Color of the center pane, right-hand sidebar and all dialog window backgrounds. +Center Channel Text + Color of all the text - with the exception of mentions, links, hashtags and code blocks - in the center pane, right-hand sidebar, and dialogs. +New Message Separator + The new message separator appears below the last read message when you navigate to a channel with unread messages. +Error Text Color + Color of all error text. +Mention Highlight BG + Highlight color behind your words that trigger mentions in the center pane and right-hand sidebar. +Mention Highlight Link + Text color of your words that trigger mentions in the center pane and right-hand sidebar. +Code Theme + Background and syntax colors for all code blocks. + +Link and button styles +~~~~~~~~~~~~~~~~~~~~~~ + +You can customize every aspect of your Mattermost theme, as described below: + +Link Color + Text color of all links, hashtags, teammate mentions, and low priority UI buttons. +Button BG + Color of the rectangular background behind all high priority UI buttons. +Button Text + Text color appearing on the rectangular background for all high priority UI buttons. diff --git a/source/preferences/manage-your-desktop-notifications.rst b/source/preferences/manage-your-desktop-notifications.rst index a944328b47f..96af94a6b93 100644 --- a/source/preferences/manage-your-desktop-notifications.rst +++ b/source/preferences/manage-your-desktop-notifications.rst @@ -22,11 +22,12 @@ From Mattermost v9.9 and desktop app v5.5, Mattermost prompts you to enable noti :scale: 50 - When you select **Allow**, you won't be asked again. You'll start receiving notifications in the desktop app for all Mattermost activity with `badges <#badge-based-notifications>`__, `banner alerts <#banner-alerts>`__ and `sounds <#notification-sounds>`__. See the section below on `customizing your notifications <#customize-your-notifications>`__ based on how you prefer to be notified about Mattermost activity in the desktop app. -- If you select **Deny** or **Deny Permanently**, you won't be asked again. You won't receive Mattermost notifications in the web browser. You can change this preference by :ref:`editing the server connection ` to :ref:`manage your notification permissions `. +- If you dismiss this prompt, you won't receive Mattermost notifications in the desktop app, and you'll be prompted again the next time you open Mattermost in the desktop app, or go to **Settings > Notifications > Desktop and mobile notifications**. +- If you select **Deny** or **Deny Permanently**, you won't be asked again. You won't receive Mattermost notifications in the desktop app. You can change this preference by :ref:`editing the server connection ` to :ref:`manage your notification permissions `. .. note:: - - You may also need to enable notifications in Windows, macOS, or Linux for Mattermost by changing your System Preferences. + You may also need to enable notifications in Windows, macOS, or Linux for Mattermost by changing your System Preferences. Badge-based notifications ------------------------- diff --git a/source/preferences/manage-your-web-notifications.rst b/source/preferences/manage-your-web-notifications.rst index a308841fb41..646aa32add5 100644 --- a/source/preferences/manage-your-web-notifications.rst +++ b/source/preferences/manage-your-web-notifications.rst @@ -19,7 +19,8 @@ From Mattermost v9.10, Mattermost prompts you to grant permission to your web br :alt: From Mattermost v9.10, you're prompted to enable notifications. - When you select **Enable notifications**, you won't be asked again. You'll start receiving notifications in your web browser for all Mattermost activity with `badges <#badge-based-notifications>`__ and `sounds <#notification-sounds>`__. See the section below on `customizing your notifications <#customize-your-notifications>`__ based on how you prefer to be notified about Mattermost activity in a web browser. -- If you dismiss this prompt, you won't receive Mattermost notifications in the web browser, and you'll prompted again the next time you open Mattermost in a web browser. +- If you dismiss this prompt, you won't receive Mattermost notifications in the web browser, and you'll be prompted again the next time you open Mattermost in a web browser, or go to **Settings > Notifications > Desktop and mobile notifications**. +- If you select **Deny** or **Deny Permanently**, you won't be asked again. You won't receive Mattermost notifications in the web browser. You can change this preference by granting notification permissions for Mattermost in the web browser. Badge-based notifications ------------------------- diff --git a/source/scale/high-availability-cluster-based-deployment.rst b/source/scale/high-availability-cluster-based-deployment.rst index 328b7b8c8e8..1f8351f44bd 100644 --- a/source/scale/high-availability-cluster-based-deployment.rst +++ b/source/scale/high-availability-cluster-based-deployment.rst @@ -8,7 +8,7 @@ High availability cluster-based deployment

Also available in legacy Mattermost Enterprise Edition E20

-A High availability cluster-based deployment enables a Mattermost system to maintain service during outages and hardware failures through the use of redundant infrastructure. +A high availability cluster-based deployment enables a Mattermost system to maintain service during outages and hardware failures through the use of redundant infrastructure. High availability in Mattermost consists of running redundant Mattermost application servers, redundant database servers, and redundant load balancers. The failure of any one of these components does not interrupt operation of the system. @@ -545,6 +545,11 @@ When deploying Mattermost in a high availability configuration, we recommend usi For example, if you're deploying Mattermost on AWS with Amazon Aurora we recommend utilizing multiple Availability Zones. If you're deploying Mattermost on your own cluster please consult with your IT team for a solution best suited for your existing architecture. +How to find the hostname of the connected websocket? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +From Mattermost v10.4, Enterprise customers running self-hosted deployments can go to the **Product** menu |product-list| and select **About Mattermost** to see the hostname of the node in the cluster running Mattermost. + Troubleshooting --------------- @@ -587,4 +592,4 @@ Modify configuration settings directly through ``config.json`` :ref:`following t Messages do not post until after reloading ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -When running in high availability mode, make sure all Mattermost application servers are running the same version of Mattermost. If they are running different versions, it can lead to a state where the lower version app server cannot handle a request and the request will not be sent until the frontend application is refreshed and sent to a server with a valid Mattermost version. Symptoms to look for include requests failing seemingly at random or a single application server having a drastic rise in goroutines and API errors. +When running in high availability mode, make sure all Mattermost application servers are running the same version of Mattermost. If they are running different versions, it can lead to a state where the lower version app server cannot handle a request and the request will not be sent until the frontend application is refreshed and sent to a server with a valid Mattermost version. Symptoms to look for include requests failing seemingly at random or a single application server having a drastic rise in goroutines and API errors. \ No newline at end of file diff --git a/source/scale/scale-to-100000-users.rst b/source/scale/scale-to-100000-users.rst index 8ab9d7c1568..2a968a00700 100644 --- a/source/scale/scale-to-100000-users.rst +++ b/source/scale/scale-to-100000-users.rst @@ -10,7 +10,8 @@ This page describes the Mattermost reference architecture designed for the load - **Database Configuration**: writer, multiple readers .. note:: - Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are. + - Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are. + - From Mattermost v10.4, Mattermost Enterprise customers can configure `Redis `_ (Remote Dictionary Server) as an alternative cache backend. Using Redis can help ensure that Mattermost remains performant and efficient, even under heavy usage. See the :ref:`Redis cache backend ` configuration settings documentation for details. Requirements ------------ diff --git a/source/upgrade/communicate-scheduled-maintenance.rst b/source/upgrade/communicate-scheduled-maintenance.rst new file mode 100644 index 00000000000..731324c731a --- /dev/null +++ b/source/upgrade/communicate-scheduled-maintenance.rst @@ -0,0 +1,195 @@ +Communicate scheduled maintenance +================================== + +.. include:: ../_static/badges/allplans-cloud-selfhosted.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. + +This guide provides best practices for notifying users via email and Mattermost channels, updating the load balancer’s error message, and configuring a dismissable banner to inform users of the upcoming maintenance. + +Communication strategy +---------------------- + +A well-defined communication strategy is essential for informing users before, during, and after maintenance. The key components of this strategy are: + +- Define a clear maintenance window in which the self-hosted Mattermost server will be unavailable. + + - Mattermost Cloud deployments have predefined service windows scheduled from 8:00-10:00 UTC on Saturdays only (when applicable) unless an exception has been made and communicated to impacted customers. +- `Email notifications <#email-templates>`__: Send structured and consistent emails to users at intervals of 7 days, 3 days, and 1 day before the scheduled maintenance window. +- `Channel-based reminders <#channel-reminder-templates>`__: :doc:`Send messages ` similar to the emails in relevant Mattermost channels at the same intervals as the email notifications. +- `Mattermost Banner notification <#banner-notification>`__: Set a :doc:`system-wide notification ` to display at the top of the Mattermost instance ahead of the maintenance window and outage. +- `Display a load balancer message <#display-load-balancer-message>`__: Update the load balancer to show a maintenance message during the scheduled maintenance window of downtime. + +Notification templates +---------------------- + +Email Templates +~~~~~~~~~~~~~~~ + +7-Day notice email +^^^^^^^^^^^^^^^^^^ + +**Email subject**: Scheduled Maintenance Notification: [Date and Time] + +.. code-block:: none + + Dear Mattermost Users, + + This is a notification that our Mattermost server will undergo scheduled + maintenance on [Date] from [Start Time] to [End Time] [Time Zone]. + During this time, the Mattermost instance will be unavailable. + + We apologize for any inconvenience this may cause and appreciate your + understanding as we work to improve our service. + + If you have any questions or concerns, please contact our + support team at [Support Email]. + + Thank you for your cooperation. + + Best regards, + [Your Name] + [Your Position] + +3-Day notice email +^^^^^^^^^^^^^^^^^^ + +**Email subject**: Reminder: Scheduled Maintenance on [Date and Time] + +.. code-block:: none + + Dear Mattermost Users, + + This is a reminder that our Mattermost server will undergo scheduled + maintenance on [Date] from [Start Time] to [End Time] [Time Zone]. + The Mattermost instance will be unavailable during this period. + + If you have any questions or concerns, please contact our + support team at [Support Email]. + + Thank you for your cooperation. + + Best regards, + [Your Name] + [Your Position] + +1-Day notice email +^^^^^^^^^^^^^^^^^^ + +**Email subject**: Final Reminder: Scheduled Maintenance Tomorrow on [Date and Time] + +.. code-block:: none + + Dear Mattermost Users, + + This is a final reminder that our Mattermost server will undergo scheduled + maintenance tomorrow, [Date], from [Start Time] to [End Time] [Time Zone]. + The Mattermost instance will be unavailable during this period. + + If you have any questions or concerns, please contact our + support team at [Support Email]. + + Thank you for your cooperation. + + Best regards, + [Your Name] + [Your Position] + +Channel reminder templates +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +7-Day channel reminder +^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + @all Please be advised that our Mattermost server will + undergo scheduled maintenance on [Date], + from [Start Time] to [End Time] [Time Zone]. + The instance will be unavailable during this time. We appreciate your understanding. + +3-Day channel reminder +^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + @all This is a reminder that our Mattermost server will + undergo scheduled maintenance on [Date], + from [Start Time] to [End Time] [Time Zone]. + Please plan accordingly. + +1-Day channel reminder +^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: none + + @all Final reminder: Our Mattermost server will + undergo scheduled maintenance tomorrow, [Date], + from [Start Time] to [End Time] [Time Zone]. + Thank you for your cooperation. + +Banner notification +~~~~~~~~~~~~~~~~~~~ + +Sample message: + +.. code-block:: text + + Heads up! Scheduled maintenance is planned for [Date], + between [Start Time] and [End Time] [Time Zone]. + The Mattermost instance will be unavailable during this time. + +Users can dismiss the banner until they log in again, or until you update the banner. + +Display load balancer message +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Configure the load balancer to display a notification message during the scheduled maintenance window of downtime. + +1. Identify the load balancer you are using (e.g., AWS, HAProxy). +2. Edit configuration. Adjust paths and configurations according to your specific environment. + + - For AWS, navigate to the Load Balancer configurations in the EC2 console. + - For HAProxy, edit the ``haproxy.cfg`` file. + +.. important:: + + We strongly recommend adding headers, where needed in your infrastructure, to avoid outdated information being communicated to your users during and following server maintenance. + +See the sample message HTML below to use as a starting point: + +.. code-block:: html + + HTML Template + + + + Maintenance in Progress + + + +
+

Maintenance in Progress

+

Our Mattermost server is currently undergoing scheduled maintenance.

+

Estimated downtime: [Start Time] to [End Time] [Time Zone]

+

We apologize for any inconvenience and thank you for your understanding.

+

If you have any questions, please contact our support team at [Support Email].

+
+ + \ No newline at end of file diff --git a/source/upgrade/open-source-components.rst b/source/upgrade/open-source-components.rst index 9d9d81a3a08..08c9dfafb62 100644 --- a/source/upgrade/open-source-components.rst +++ b/source/upgrade/open-source-components.rst @@ -33,6 +33,7 @@ Desktop Mobile ------- +- Mattermost Mobile v2.24.0 - `View Open Source Components `__. - Mattermost Mobile v2.23.0 - `View Open Source Components `__. - Mattermost Mobile v2.22.0 - `View Open Source Components `__. - Mattermost Mobile v2.21.0 - `View Open Source Components `__. @@ -117,6 +118,7 @@ Mobile Server ------------------------------ +- Mattermost Enterprise Edition v10.4.0 - `View Open Source Components `__. - Mattermost Enterprise Edition v10.3.0 - `View Open Source Components `__. - Mattermost Enterprise Edition v10.2.0 - `View Open Source Components `__. - Mattermost Enterprise Edition v10.1.0 - `View Open Source Components `__. From 40c9b84a0cd6a713f3ca9df80ff78ac5c8c332f8 Mon Sep 17 00:00:00 2001 From: Amy Blais <29708087+amyblais@users.noreply.github.com> Date: Thu, 16 Jan 2025 08:12:09 +0200 Subject: [PATCH 06/23] Update version-archive.rst (#7698) Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> --- source/about/version-archive.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/source/about/version-archive.rst b/source/about/version-archive.rst index 546d80250fb..3f55e6eb133 100644 --- a/source/about/version-archive.rst +++ b/source/about/version-archive.rst @@ -11,6 +11,10 @@ Version archive .. tab:: Mattermost Enterprise + Mattermost Enterprise Edition v10.4.1 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.4.1/mattermost-10.4.1-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``a6299d0e632e75b8d6e41f081577b1de912697e82e3c78fb5e54cb2b53db8a2a`` + - GPG Signature: https://releases.mattermost.com/10.4.1/mattermost-10.4.1-linux-amd64.tar.gz.sig Mattermost Enterprise Edition v10.3.2 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/10.3.2/mattermost-10.3.2-linux-amd64.tar.gz`` - SHA-256 Checksum: ``32a58e88d39e8a639160ee6027b5260d224ae0a9034696c1975017560e2b10e5`` @@ -395,6 +399,10 @@ Version archive We generally recommend installing Enterprise Edition, even if you don't currently need a license. This provides the flexibility to seamlessly unlock Enterprise features should you need them. However, if you only want to install software with a fully open source code base, then Team Edition is the best choice for you. + Mattermost Team Edition v10.4.1 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.4.1/mattermost-team-10.4.1-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``f27a2e7526f0a38ede1e444f495fc2e2fbb7a68e67cd9a71e26e1c65c2c39d9c`` + - GPG Signature: https://releases.mattermost.com/10.4.1/mattermost-team-10.4.1-linux-amd64.tar.gz.sig Mattermost Team Edition v10.3.2 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/10.3.2/mattermost-team-10.3.2-linux-amd64.tar.gz`` - SHA-256 Checksum: ``a62f3c8d4b1f1a29f06539430e2c3231088b9f388fc3b098bd23b18e0263249c`` From c8b75d4fe34b4e83a37894fa3546d5350c5a0e87 Mon Sep 17 00:00:00 2001 From: Amy Blais <29708087+amyblais@users.noreply.github.com> Date: Thu, 16 Jan 2025 08:15:34 +0200 Subject: [PATCH 07/23] Mobile v2.24 Changelog (#7663) * Update mattermost-mobile-releases.md * Update mobile-app-changelog.md * Update mobile-app-changelog.md * Update mobile-app-changelog.md --- source/about/mattermost-mobile-releases.md | 1 + source/about/mobile-app-changelog.md | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/source/about/mattermost-mobile-releases.md b/source/about/mattermost-mobile-releases.md index af9ba259590..df5ecd31b40 100644 --- a/source/about/mattermost-mobile-releases.md +++ b/source/about/mattermost-mobile-releases.md @@ -18,6 +18,7 @@ See the [Mobile app changelog](/about/mobile-app-changelog) for release details, | **Release** | **Released on** | **Support ends** | **Compatible with** | |:---|:---|:---|:---| +| v2.24 {ref}`FEATURE ` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.24.0) \| {ref}`Changelog ` | 2025-01-16 | 2025-02-15 | {ref}`v10.4 `, {ref}`v10.3 `, {ref}`v10.2 `, {ref}`v9.11 ` | | v2.23 {ref}`FEATURE ` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.23.1) \| {ref}`Changelog ` | 2024-12-16 | 2025-01-15 | {ref}`v10.3 `, {ref}`v10.2 `, {ref}`v10.1 `, {ref}`v9.11 ` | | v2.22 {ref}`FEATURE ` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.22.0) \| {ref}`Changelog ` | 2024-11-15 | 2024-12-15 | {ref}`v10.2 `, {ref}`v10.1 `, {ref}`v10.0 `, {ref}`v9.11 `, {ref}`v9.5 ` | | v2.21 {ref}`FEATURE ` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.21.0) \| {ref}`Changelog ` | 2024-10-16 | 2024-11-15 | {ref}`v10.1 `, {ref}`v10.0 `, {ref}`v9.11 `, {ref}`v9.10 `, {ref}`v9.5 ` | diff --git a/source/about/mobile-app-changelog.md b/source/about/mobile-app-changelog.md index c645feca961..3c7af8007c3 100644 --- a/source/about/mobile-app-changelog.md +++ b/source/about/mobile-app-changelog.md @@ -5,6 +5,26 @@ This changelog summarizes updates to Mattermost mobile apps releases for [Mattermost](https://mattermost.com). +(release-v2-24-0)= +## 2.24.0 Release + - Release Date: January 16, 2025 + - Server Versions Supported: Server v9.11.0+ is required. Self-Signed SSL Certificates are not supported unless the user installs the CA certificate on their device. + +### Compatibility + - **Upgrade to server version v9.11.0 or later is required.** Support for server [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) (ESR) v9.5.0 has ended and upgrading to server ESR v9.11.0 or later is required. As we innovate and offer newer versions of our mobile apps, we maintain backwards compatibility only with supported server versions. Users who upgrade to the newest mobile apps while being connected to an unsupported server version can be exposed to compatibility issues, which can cause crashes or severe bugs that break core functionality of the app. + - Android operating system 7+ [is required by Google](https://android-developers.googleblog.com/2017/12/improving-app-security-and-performance.html). + - iPhone 6s devices and later with iOS 13.4+ are required. + +### Improvements + - End users will no longer receive messages about being on unsupported servers. + +### Bug Fixes + - Fixed an issue with the user interface for editing custom statuses. + +### Known Issues + - Users are unable to adjust the font size via the OS font size setting. + - Some Google Pixel phones on Android 12+ might not continue past the login screen. This is a known issue with the OS, and the current workaround is to restart the device. + (release-v2-23-1)= ## 2.23.1 Release - Release Date: December 19, 2024 From 763ab03a50bf7f4938b6a7d57e3e2072765d08b7 Mon Sep 17 00:00:00 2001 From: Amy Blais <29708087+amyblais@users.noreply.github.com> Date: Thu, 16 Jan 2025 13:02:32 +0200 Subject: [PATCH 08/23] Add known issue (#7700) * Update mattermost-v10-changelog.md * Update mattermost-v10-changelog.md --- source/about/mattermost-v10-changelog.md | 1 + 1 file changed, 1 insertion(+) diff --git a/source/about/mattermost-v10-changelog.md b/source/about/mattermost-v10-changelog.md index 16ffc24cfbd..5b154f0897c 100644 --- a/source/about/mattermost-v10-changelog.md +++ b/source/about/mattermost-v10-changelog.md @@ -79,6 +79,7 @@ New setting options were added to ``config.json``. Below is a list of the additi - v10.4 is built with Go ``v1.22.6``. ### Known Issues + - Setting the license file location through an envvar still gives the option to upload a new license through the System Console, resulting in the license being overwritten by the one set through the envvar. See this [knowledge base article](https://support.mattermost.com/hc/en-us/articles/33911983851284-System-console-still-displays-old-license-after-uploading-a-new-one) on how to resolve this issue. - Searching stop words in quotation marks with Elasticsearch enabled returns more than just the searched terms. - Slack import through the CLI fails if email notifications are enabled. From d6e715647632a7291f2bdf197dc7457de2528f09 Mon Sep 17 00:00:00 2001 From: Amy Blais <29708087+amyblais@users.noreply.github.com> Date: Fri, 17 Jan 2025 11:19:50 +0200 Subject: [PATCH 09/23] v2.24.1 dot release docs (#7705) * Update mattermost-mobile-releases.md * Update mobile-app-changelog.md --- source/about/mattermost-mobile-releases.md | 2 +- source/about/mobile-app-changelog.md | 13 +++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/source/about/mattermost-mobile-releases.md b/source/about/mattermost-mobile-releases.md index df5ecd31b40..242455b2dac 100644 --- a/source/about/mattermost-mobile-releases.md +++ b/source/about/mattermost-mobile-releases.md @@ -18,7 +18,7 @@ See the [Mobile app changelog](/about/mobile-app-changelog) for release details, | **Release** | **Released on** | **Support ends** | **Compatible with** | |:---|:---|:---|:---| -| v2.24 {ref}`FEATURE ` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.24.0) \| {ref}`Changelog ` | 2025-01-16 | 2025-02-15 | {ref}`v10.4 `, {ref}`v10.3 `, {ref}`v10.2 `, {ref}`v9.11 ` | +| v2.24 {ref}`FEATURE ` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.24.1) \| {ref}`Changelog ` | 2025-01-16 | 2025-02-15 | {ref}`v10.4 `, {ref}`v10.3 `, {ref}`v10.2 `, {ref}`v9.11 ` | | v2.23 {ref}`FEATURE ` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.23.1) \| {ref}`Changelog ` | 2024-12-16 | 2025-01-15 | {ref}`v10.3 `, {ref}`v10.2 `, {ref}`v10.1 `, {ref}`v9.11 ` | | v2.22 {ref}`FEATURE ` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.22.0) \| {ref}`Changelog ` | 2024-11-15 | 2024-12-15 | {ref}`v10.2 `, {ref}`v10.1 `, {ref}`v10.0 `, {ref}`v9.11 `, {ref}`v9.5 ` | | v2.21 {ref}`FEATURE ` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.21.0) \| {ref}`Changelog ` | 2024-10-16 | 2024-11-15 | {ref}`v10.1 `, {ref}`v10.0 `, {ref}`v9.11 `, {ref}`v9.10 `, {ref}`v9.5 ` | diff --git a/source/about/mobile-app-changelog.md b/source/about/mobile-app-changelog.md index 3c7af8007c3..35da4968dea 100644 --- a/source/about/mobile-app-changelog.md +++ b/source/about/mobile-app-changelog.md @@ -5,6 +5,19 @@ This changelog summarizes updates to Mattermost mobile apps releases for [Mattermost](https://mattermost.com). +(release-v2-24-1)= +## 2.24.1 Release + - Release Date: January 17, 2025 + - Server Versions Supported: Server v9.11.0+ is required. Self-Signed SSL Certificates are not supported unless the user installs the CA certificate on their device. + +### Compatibility + - **Upgrade to server version v9.11.0 or later is required.** Support for server [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#extended-support-releases) (ESR) v9.5.0 has ended and upgrading to server ESR v9.11.0 or later is required. As we innovate and offer newer versions of our mobile apps, we maintain backwards compatibility only with supported server versions. Users who upgrade to the newest mobile apps while being connected to an unsupported server version can be exposed to compatibility issues, which can cause crashes or severe bugs that break core functionality of the app. + - Android operating system 7+ [is required by Google](https://android-developers.googleblog.com/2017/12/improving-app-security-and-performance.html). + - iPhone 6s devices and later with iOS 13.4+ are required. + +### Bug Fixes + - Fixed a crash when using certain timezones. + (release-v2-24-0)= ## 2.24.0 Release - Release Date: January 16, 2025 From 633d2147ec1394f8d3599756933c1538db4be8f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sven=20H=C3=BCster?= Date: Mon, 20 Jan 2025 17:59:53 +0100 Subject: [PATCH 10/23] Add Warning About HA Deployment Across Multiple Datacenters (#7707) * Add Warning About HA Deployment Across Multiple Datacenters * Update source/scale/high-availability-cluster-based-deployment.rst --------- Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> --- source/scale/high-availability-cluster-based-deployment.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/source/scale/high-availability-cluster-based-deployment.rst b/source/scale/high-availability-cluster-based-deployment.rst index 1f8351f44bd..361a37f6b24 100644 --- a/source/scale/high-availability-cluster-based-deployment.rst +++ b/source/scale/high-availability-cluster-based-deployment.rst @@ -25,6 +25,10 @@ Update sequence for continuous operation **Exception:** Changes to configuration settings that require a server restart, and server version upgrades that involve a change to the database schema, require a short period of downtime. Downtime for a server restart is around five seconds. For a database schema update, downtime can be up to 30 seconds. +.. important:: + + Mattermost does not support high availability deployments spanning multiple datacenters. All nodes in a high availability cluster must reside within the same datacenter to ensure proper functionality and performance. + Deployment guide ---------------- @@ -592,4 +596,4 @@ Modify configuration settings directly through ``config.json`` :ref:`following t Messages do not post until after reloading ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -When running in high availability mode, make sure all Mattermost application servers are running the same version of Mattermost. If they are running different versions, it can lead to a state where the lower version app server cannot handle a request and the request will not be sent until the frontend application is refreshed and sent to a server with a valid Mattermost version. Symptoms to look for include requests failing seemingly at random or a single application server having a drastic rise in goroutines and API errors. \ No newline at end of file +When running in high availability mode, make sure all Mattermost application servers are running the same version of Mattermost. If they are running different versions, it can lead to a state where the lower version app server cannot handle a request and the request will not be sent until the frontend application is refreshed and sent to a server with a valid Mattermost version. Symptoms to look for include requests failing seemingly at random or a single application server having a drastic rise in goroutines and API errors. From 1eae0273fd21804e4c08e0d5ec253545087badf2 Mon Sep 17 00:00:00 2001 From: Amy Blais <29708087+amyblais@users.noreply.github.com> Date: Thu, 23 Jan 2025 08:51:06 +0200 Subject: [PATCH 11/23] Dot release docs (#7708) * Update mattermost-server-releases.md * Update download-latest-tarball.rst * Update version-archive.rst * Update mattermost-v9-changelog.md * Update mattermost-v10-changelog.md * Update mattermost-v9-changelog.md * Update source/about/mattermost-v10-changelog.md * Update source/about/mattermost-v10-changelog.md * Update source/about/mattermost-v10-changelog.md * Update source/about/mattermost-v9-changelog.md * Update version-archive.rst * Update mattermost-v9-changelog.md * Update mattermost-v10-changelog.md --------- Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> --- source/about/mattermost-server-releases.md | 8 +-- source/about/mattermost-v10-changelog.md | 21 +++++++ source/about/mattermost-v9-changelog.md | 9 +++ source/about/version-archive.rst | 64 +++++++++++----------- source/install/download-latest-tarball.rst | 4 +- 5 files changed, 68 insertions(+), 38 deletions(-) diff --git a/source/about/mattermost-server-releases.md b/source/about/mattermost-server-releases.md index 1db952de699..0dfd86d4205 100644 --- a/source/about/mattermost-server-releases.md +++ b/source/about/mattermost-server-releases.md @@ -19,12 +19,12 @@ Mattermost releases a new server version on the 16th of each month in [binary fo | **Release** | **Released on** | **Support ends** | |:---|:---|:---| -| v10.4 [Download](https://releases.mattermost.com/10.4.1/mattermost-10.4.1-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2025-01-16 | 2025-04-15 | -| v10.3 [Download](https://releases.mattermost.com/10.3.2/mattermost-10.3.2-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-12-16 | 2025-03-15 | -| v10.2 [Download](https://releases.mattermost.com/10.2.2/mattermost-10.2.2-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-11-15 | 2025-02-15 | +| v10.4 [Download](https://releases.mattermost.com/10.4.2/mattermost-10.4.2-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2025-01-16 | 2025-04-15 | +| v10.3 [Download](https://releases.mattermost.com/10.3.3/mattermost-10.3.3-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-12-16 | 2025-03-15 | +| v10.2 [Download](https://releases.mattermost.com/10.2.3/mattermost-10.2.3-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-11-15 | 2025-02-15 | | v10.1 [Download](https://releases.mattermost.com/10.1.7/mattermost-10.1.7-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-10-16 | 2025-01-15 | | v10.0 [Download](https://releases.mattermost.com/10.0.4/mattermost-10.0.4-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-09-16 | 2024-12-15 | -| v9.11 [Download](https://releases.mattermost.com/9.11.7/mattermost-9.11.7-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-08-16 | 2025-05-15 {ref}`EXTENDED ` | +| v9.11 [Download](https://releases.mattermost.com/9.11.8/mattermost-9.11.8-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-08-16 | 2025-05-15 {ref}`EXTENDED ` | | v9.10 [Download](https://releases.mattermost.com/9.10.3/mattermost-9.10.3-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-07-16 | 2024-10-15 | | v9.9 [Download](https://releases.mattermost.com/9.9.3/mattermost-9.9.3-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-06-14 | 2024-09-15 | | v9.8 [Download](https://releases.mattermost.com/9.8.3/mattermost-9.8.3-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-05-16 | 2024-08-15 | diff --git a/source/about/mattermost-v10-changelog.md b/source/about/mattermost-v10-changelog.md index 5b154f0897c..27d0b393d40 100644 --- a/source/about/mattermost-v10-changelog.md +++ b/source/about/mattermost-v10-changelog.md @@ -10,6 +10,13 @@ Support for Mattermost Server v9.5 [Extended Support Release](https://docs.matte (release-v10.4-feature-release)= ## Release v10.4 - [Feature Release](https://docs.mattermost.com/about/release-policy.html#release-types) +- **10.4.2, released 2025-01-22** + - Mattermost v10.4.2 contains critical severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/). + - Pre-packaged Boards plugin [v9.0.5](https://github.com/mattermost/mattermost-plugin-boards/releases/tag/v9.0.5). + - Pre-packaged Channel Export plugin [v1.2.1](https://github.com/mattermost/mattermost-plugin-channel-export/releases/tag/v1.2.1). + - Fixed a panic during LDAP synchronization [MM-61239](https://mattermost.atlassian.net/browse/MM-61239). + - Fixed an issue with webhook attachment button styles [MM-62400](https://mattermost.atlassian.net/browse/MM-62400). + - Mattermost v10.4.2 contains no database or functional changes. - **10.4.1, released 2025-01-16** - Fixed errors logged by performance telemetry due to certain browser extensions [MM-62371](https://mattermost.atlassian.net/browse/MM-62371). - Fixed an issue with insertion errors to ``LinkMetadata`` table. @@ -89,6 +96,13 @@ New setting options were added to ``config.json``. Below is a list of the additi (release-v10.3-feature-release)= ## Release v10.3 - [Feature Release](https://docs.mattermost.com/about/release-policy.html#release-types) +- **10.3.3, released 2025-01-22** + - Mattermost v10.3.3 contains critical severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/). + - Pre-packaged Boards plugin [v9.0.5](https://github.com/mattermost/mattermost-plugin-boards/releases/tag/v9.0.5). + - Pre-packaged Channel Export plugin [v1.2.1](https://github.com/mattermost/mattermost-plugin-channel-export/releases/tag/v1.2.1). + - Fixed a panic during LDAP synchronization [MM-61239](https://mattermost.atlassian.net/browse/MM-61239). + - Fixed an issue where the bulk export retention job would accidentally delete non-bulk export files and directories [MM-60888](https://mattermost.atlassian.net/browse/MM-60888). + - Mattermost v10.3.3 contains no database or functional changes. - **10.3.2, released 2025-01-15** - Mattermost v10.3.2 contains low to medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/). - Pre-packaged Boards plugin [v9.0.2](https://github.com/mattermost/mattermost-plugin-boards/releases/tag/v9.0.2). @@ -177,6 +191,13 @@ New setting options were added to ``config.json``. Below is a list of the additi (release-v10.2-feature-release)= ## Release v10.2 - [Feature Release](https://docs.mattermost.com/about/release-policy.html#release-types) +- **10.2.3, released 2025-01-22** + - Mattermost v10.2.3 contains critical severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/). + - Pre-packaged Boards plugin [v9.0.5](https://github.com/mattermost/mattermost-plugin-boards/releases/tag/v9.0.5). + - Pre-packaged Channel Export plugin [v1.2.1](https://github.com/mattermost/mattermost-plugin-channel-export/releases/tag/v1.2.1). + - Fixed a panic during LDAP synchronization [MM-61239](https://mattermost.atlassian.net/browse/MM-61239). + - Fixed an issue where the bulk export retention job would accidentally delete non-bulk export files and directories [MM-60888](https://mattermost.atlassian.net/browse/MM-60888). + - Mattermost v10.2.3 contains no database or functional changes. - **10.2.2, released 2025-01-15** - Mattermost v10.2.2 contains low to medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/). - Pre-packaged Boards plugin [v9.0.2](https://github.com/mattermost/mattermost-plugin-boards/releases/tag/v9.0.2). diff --git a/source/about/mattermost-v9-changelog.md b/source/about/mattermost-v9-changelog.md index 42f6aa01130..bd81858b597 100644 --- a/source/about/mattermost-v9-changelog.md +++ b/source/about/mattermost-v9-changelog.md @@ -10,6 +10,15 @@ Support for Mattermost Server v9.5 [Extended Support Release](https://docs.matte (release-v9-11-extended-support-release)= ## Release v9.11 - [Extended Support Release](https://docs.mattermost.com/about/release-policy.html#release-types) +- **9.11.8, released 2025-01-22** + - Mattermost v9.11.8 contains critical severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/). + - Pre-packaged Boards plugin [v9.0.5](https://github.com/mattermost/mattermost-plugin-boards/releases/tag/v9.0.5). + - Pre-packaged Channel Export plugin [v1.2.1](https://github.com/mattermost/mattermost-plugin-channel-export/releases/tag/v1.2.1). + - Pre-packaged Calls plugin [v0.29.7](https://github.com/mattermost/mattermost-plugin-calls/releases/tag/v0.29.7). + - Fixed a panic during LDAP synchronization [MM-61239](https://mattermost.atlassian.net/browse/MM-61239). + - Fixed an issue where the bulk export retention job would accidentally delete non-bulk export files and directories [MM-60888](https://mattermost.atlassian.net/browse/MM-60888). + - Fixed an issue where new messages from new channels wouldn't appear in the sidebar after reconnecting the websocket [MM-61361](https://mattermost.atlassian.net/browse/MM-61361). + - Mattermost v9.11.8 contains no database or functional changes. - **9.11.7, released 2025-01-15** - Mattermost v9.11.7 contains low to medium severity level security fixes. [Upgrading](https://docs.mattermost.com/upgrade/upgrading-mattermost-server.html) to this release is recommended. Details will be posted on our [security updates page](https://mattermost.com/security-updates/) 30 days after release as per the [Mattermost Responsible Disclosure Policy](https://mattermost.com/security-vulnerability-report/). - Fixed an issue with the web app status not being updated correctly for the current user [MM-59952](https://mattermost.atlassian.net/browse/MM-59952). diff --git a/source/about/version-archive.rst b/source/about/version-archive.rst index 3f55e6eb133..d3c985a2c26 100644 --- a/source/about/version-archive.rst +++ b/source/about/version-archive.rst @@ -11,18 +11,18 @@ Version archive .. tab:: Mattermost Enterprise - Mattermost Enterprise Edition v10.4.1 - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/10.4.1/mattermost-10.4.1-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``a6299d0e632e75b8d6e41f081577b1de912697e82e3c78fb5e54cb2b53db8a2a`` - - GPG Signature: https://releases.mattermost.com/10.4.1/mattermost-10.4.1-linux-amd64.tar.gz.sig - Mattermost Enterprise Edition v10.3.2 - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/10.3.2/mattermost-10.3.2-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``32a58e88d39e8a639160ee6027b5260d224ae0a9034696c1975017560e2b10e5`` - - GPG Signature: https://releases.mattermost.com/10.3.2/mattermost-10.3.2-linux-amd64.tar.gz.sig - Mattermost Enterprise Edition v10.2.2 - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/10.2.2/mattermost-10.2.2-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``6a1bc407242a14d8b1266e09078461a408488305a26fdf74e76d76e5d0be16ce`` - - GPG Signature: https://releases.mattermost.com/10.2.2/mattermost-10.2.2-linux-amd64.tar.gz.sig + Mattermost Enterprise Edition v10.4.2 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.4.2/mattermost-10.4.2-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``7dc8400f27958f7be545088c343deecda40c754c4f4e13e97205fa75b2ddc1e7`` + - GPG Signature: https://releases.mattermost.com/10.4.2/mattermost-10.4.2-linux-amd64.tar.gz.sig + Mattermost Enterprise Edition v10.3.3 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.3.3/mattermost-10.3.3-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``269f42672b02151af87eee4135b665c93bc4375c767c28bd36b66a7655e7a977`` + - GPG Signature: https://releases.mattermost.com/10.3.3/mattermost-10.3.3-linux-amd64.tar.gz.sig + Mattermost Enterprise Edition v10.2.3 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.2.3/mattermost-10.2.3-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``f7c92924dded7a661face5b9b3857969908b6b63f6f42e3078ab2393d23c6ac8`` + - GPG Signature: https://releases.mattermost.com/10.2.3/mattermost-10.2.3-linux-amd64.tar.gz.sig Mattermost Enterprise Edition v10.1.7 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/10.1.7/mattermost-10.1.7-linux-amd64.tar.gz`` - SHA-256 Checksum: ``6a7bfe7370f319d4f3a1a5aa27463af5e9b7851eca5ce7d285a3125a8b91c28d`` @@ -31,10 +31,10 @@ Version archive - ``https://releases.mattermost.com/10.0.4/mattermost-10.0.4-linux-amd64.tar.gz`` - SHA-256 Checksum: ``25c3753707404294070177495062aaef7d5e0100cc01343c27732225e4bbb8f6`` - GPG Signature: https://releases.mattermost.com/10.0.4/mattermost-10.0.4-linux-amd64.tar.gz.sig - Mattermost Enterprise Edition v9.11.7 *Extended Support Release (ESR)* - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/9.11.7/mattermost-9.11.7-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``17051f0127a8e5f55519de38ef9d4a195a3c46ee52f121ced1ad6c9fadad536d`` - - GPG Signature: https://releases.mattermost.com/9.11.7/mattermost-9.11.7-linux-amd64.tar.gz.sig + Mattermost Enterprise Edition v9.11.8 *Extended Support Release (ESR)* - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/9.11.8/mattermost-9.11.8-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``a5e4955cbfc82a329e5daf42255edc11bf833faacf349941a2a7aa6e09e2dff2`` + - GPG Signature: https://releases.mattermost.com/9.11.8/mattermost-9.11.8-linux-amd64.tar.gz.sig Mattermost Enterprise Edition v9.10.3 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/9.10.3/mattermost-9.10.3-linux-amd64.tar.gz`` - SHA-256 Checksum: ``638433634efbffe3c1d373b3f344406d37fcc3ab86292d4381890e3eeb86fb9d`` @@ -399,18 +399,18 @@ Version archive We generally recommend installing Enterprise Edition, even if you don't currently need a license. This provides the flexibility to seamlessly unlock Enterprise features should you need them. However, if you only want to install software with a fully open source code base, then Team Edition is the best choice for you. - Mattermost Team Edition v10.4.1 - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/10.4.1/mattermost-team-10.4.1-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``f27a2e7526f0a38ede1e444f495fc2e2fbb7a68e67cd9a71e26e1c65c2c39d9c`` - - GPG Signature: https://releases.mattermost.com/10.4.1/mattermost-team-10.4.1-linux-amd64.tar.gz.sig - Mattermost Team Edition v10.3.2 - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/10.3.2/mattermost-team-10.3.2-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``a62f3c8d4b1f1a29f06539430e2c3231088b9f388fc3b098bd23b18e0263249c`` - - GPG Signature: https://releases.mattermost.com/10.3.2/mattermost-team-10.3.2-linux-amd64.tar.gz.sig - Mattermost Team Edition v10.2.2 - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/10.2.2/mattermost-team-10.2.2-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``d6134e0080c77a8992321553a1f9fdce6dab206660bc6abe99c2d5fcf6f15b51`` - - GPG Signature: https://releases.mattermost.com/10.2.2/mattermost-team-10.2.2-linux-amd64.tar.gz.sig + Mattermost Team Edition v10.4.2 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.4.2/mattermost-team-10.4.2-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``25c4d26bac4065441a3f0a85349a390286ee4a77f5c207d6a10c2497e425b8cc`` + - GPG Signature: https://releases.mattermost.com/10.4.2/mattermost-team-10.4.2-linux-amd64.tar.gz.sig + Mattermost Team Edition v10.3.3 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.3.3/mattermost-team-10.3.3-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``ac7dc3a2352ad09cf6568ad10e80f52a7a88a9f00682b68d7dd01728594ff51f`` + - GPG Signature: https://releases.mattermost.com/10.3.3/mattermost-team-10.3.3-linux-amd64.tar.gz.sig + Mattermost Team Edition v10.2.3 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.2.3/mattermost-team-10.2.3-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``b18ad8db0ae03c863fa4cb7f611584794776e9a1df52cf19c4bb90ce86938eef`` + - GPG Signature: https://releases.mattermost.com/10.2.3/mattermost-team-10.2.3-linux-amd64.tar.gz.sig Mattermost Team Edition v10.1.7 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/10.1.7/mattermost-team-10.1.7-linux-amd64.tar.gz`` - SHA-256 Checksum: ``baf2f1ec86448938d1ed2879cb19e5034259090cd8282d5bebdb6d495de33a06`` @@ -419,10 +419,10 @@ Version archive - ``https://releases.mattermost.com/10.0.4/mattermost-team-10.0.4-linux-amd64.tar.gz`` - SHA-256 Checksum: ``ad7ace64160e17b352b6f0801c928eca8200f7bc71305d2e65ca296a535cee60`` - GPG Signature: https://releases.mattermost.com/10.0.4/mattermost-team-10.0.4-linux-amd64.tar.gz.sig - Mattermost Team Edition v9.11.7 *Extended Support Release (ESR)* - `View Changelog `__ - `Download `__ - - ``https://releases.mattermost.com/9.11.7/mattermost-team-9.11.7-linux-amd64.tar.gz`` - - SHA-256 Checksum: ``94fc00ef59e594a90a883763b5b92c3e857eb23e5104a9752472a4333aaf0756`` - - GPG Signature: https://releases.mattermost.com/9.11.7/mattermost-team-9.11.7-linux-amd64.tar.gz.sig + Mattermost Team Edition v9.11.8 *Extended Support Release (ESR)* - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/9.11.8/mattermost-team-9.11.8-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``f4cbbfd70a59a39e3ccb2c46a8ce5b4ee6b218ffa830474ce27a7c77d6dfda2e`` + - GPG Signature: https://releases.mattermost.com/9.11.8/mattermost-team-9.11.8-linux-amd64.tar.gz.sig Mattermost Team Edition v9.10.3 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/9.10.3/mattermost-team-9.10.3-linux-amd64.tar.gz`` - SHA-256 Checksum: ``d50e2d3352129f3eaa5271cb3031b0210f9283954e727f7dca959b4c277ea6fc`` diff --git a/source/install/download-latest-tarball.rst b/source/install/download-latest-tarball.rst index 85f3b0f2e37..5bce5154347 100644 --- a/source/install/download-latest-tarball.rst +++ b/source/install/download-latest-tarball.rst @@ -9,13 +9,13 @@ Using ``wget``, download the Mattermost Server release you want to install. .. code-block:: sh - wget https://releases.mattermost.com/10.4.1/mattermost-10.4.1-linux-amd64.tar.gz + wget https://releases.mattermost.com/10.4.2/mattermost-10.4.2-linux-amd64.tar.gz .. tab:: Current ESR .. code-block:: sh - wget https://releases.mattermost.com/9.11.7/mattermost-9.11.7-linux-amd64.tar.gz + wget https://releases.mattermost.com/9.11.8/mattermost-9.11.8-linux-amd64.tar.gz .. tab:: Older releases From daf5fd5ddbefb3e8b8041a80d99bff14dd18ff43 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Thu, 23 Jan 2025 15:34:29 -0500 Subject: [PATCH 12/23] Emojis must be Unicode, not specified as Markdown in channel headers (#7712) * Emojis must be Unicode, not specified as Markdown in channel headers * Update source/collaborate/channel-naming-conventions.rst * Clarified Unicode workflow --- source/collaborate/channel-naming-conventions.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/source/collaborate/channel-naming-conventions.rst b/source/collaborate/channel-naming-conventions.rst index 8bef4b62fcb..f0f54acfebb 100644 --- a/source/collaborate/channel-naming-conventions.rst +++ b/source/collaborate/channel-naming-conventions.rst @@ -14,7 +14,12 @@ Basic structure - Channel names have a 64-character limit to ensure readability on both desktop and mobile devices. - An additional 1024 characters are available for describing the channel's focus in the channel header and channel information pane. - An additional 128 characters are available for a **Channel Purpose** that's visible in the channel header and the channel information pane. -- Channel names can include emojis. Specify the emoji by its name in the format ``:smile:``. We recommend prefixing channel names with emojis for the following reasons: +- Channel names can include standard Unicode emojis that are universally supported emojis that look the same (or similar) across platforms. Specify a Unicode emoji by positioning your cursor in the channel **Display Name** field and accessing the Unicode emoji picker for your operating system, as follows: + + - On Windows press :kbd:`Windows` + :kbd:`.` or :kbd:`;` to open the Unicode emoji picker. + - On macOS, press :kbd:`Ctrl` + :kbd:`⌘` + :kbd:`Space` to open the Unicode emoji picker. + +We recommend prefixing channel names with emojis for the following reasons: - Emojis can make it easier for users to quickly identify and manage channels, particularly in large workspaces with many channels. - Sharing the same emoji across channels related to a specific category or function helps maintain organization and consistency across the workspace. From 14c4accae6726b96f64479e80d76df650c540fbe Mon Sep 17 00:00:00 2001 From: Amy Blais <29708087+amyblais@users.noreply.github.com> Date: Fri, 24 Jan 2025 09:54:19 +0200 Subject: [PATCH 13/23] Initial PR to document SBOM download link (#7706) * Update mattermost-server-releases.md * Add SBOM * Update mattermost-server-releases.md * Update source/about/mattermost-server-releases.md Co-authored-by: Eva Sarafianou * Update version-archive.rst * Update mattermost-server-releases.md --------- Co-authored-by: Eva Sarafianou --- source/about/mattermost-server-releases.md | 2 +- source/about/version-archive.rst | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/source/about/mattermost-server-releases.md b/source/about/mattermost-server-releases.md index 0dfd86d4205..158a3810964 100644 --- a/source/about/mattermost-server-releases.md +++ b/source/about/mattermost-server-releases.md @@ -19,7 +19,7 @@ Mattermost releases a new server version on the 16th of each month in [binary fo | **Release** | **Released on** | **Support ends** | |:---|:---|:---| -| v10.4 [Download](https://releases.mattermost.com/10.4.2/mattermost-10.4.2-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2025-01-16 | 2025-04-15 | +| v10.4 [Download](https://releases.mattermost.com/10.4.2/mattermost-10.4.2-linux-amd64.tar.gz) \| {ref}`Changelog ` \| [SBOM download](https://github.com/mattermost/mattermost/releases/download/v10.4.2/sbom-mattermost-v10.4.2.json) | 2025-01-16 | 2025-04-15 | | v10.3 [Download](https://releases.mattermost.com/10.3.3/mattermost-10.3.3-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-12-16 | 2025-03-15 | | v10.2 [Download](https://releases.mattermost.com/10.2.3/mattermost-10.2.3-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-11-15 | 2025-02-15 | | v10.1 [Download](https://releases.mattermost.com/10.1.7/mattermost-10.1.7-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-10-16 | 2025-01-15 | diff --git a/source/about/version-archive.rst b/source/about/version-archive.rst index d3c985a2c26..d337914580d 100644 --- a/source/about/version-archive.rst +++ b/source/about/version-archive.rst @@ -403,6 +403,7 @@ Version archive - ``https://releases.mattermost.com/10.4.2/mattermost-team-10.4.2-linux-amd64.tar.gz`` - SHA-256 Checksum: ``25c4d26bac4065441a3f0a85349a390286ee4a77f5c207d6a10c2497e425b8cc`` - GPG Signature: https://releases.mattermost.com/10.4.2/mattermost-team-10.4.2-linux-amd64.tar.gz.sig + - SBOM Download Link: https://github.com/mattermost/mattermost/releases/download/v10.4.2/sbom-mattermost-v10.4.2.json Mattermost Team Edition v10.3.3 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/10.3.3/mattermost-team-10.3.3-linux-amd64.tar.gz`` - SHA-256 Checksum: ``ac7dc3a2352ad09cf6568ad10e80f52a7a88a9f00682b68d7dd01728594ff51f`` From 4bef63c3df8171e4a341ea5db5e6f9a458007132 Mon Sep 17 00:00:00 2001 From: Eva Sarafianou Date: Fri, 24 Jan 2025 10:56:16 +0200 Subject: [PATCH 14/23] Add sbom for all v10 releases (#7714) --- source/about/mattermost-server-releases.md | 8 ++++---- source/about/version-archive.rst | 4 ++++ 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/source/about/mattermost-server-releases.md b/source/about/mattermost-server-releases.md index 158a3810964..1f80b0ea186 100644 --- a/source/about/mattermost-server-releases.md +++ b/source/about/mattermost-server-releases.md @@ -20,10 +20,10 @@ Mattermost releases a new server version on the 16th of each month in [binary fo | **Release** | **Released on** | **Support ends** | |:---|:---|:---| | v10.4 [Download](https://releases.mattermost.com/10.4.2/mattermost-10.4.2-linux-amd64.tar.gz) \| {ref}`Changelog ` \| [SBOM download](https://github.com/mattermost/mattermost/releases/download/v10.4.2/sbom-mattermost-v10.4.2.json) | 2025-01-16 | 2025-04-15 | -| v10.3 [Download](https://releases.mattermost.com/10.3.3/mattermost-10.3.3-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-12-16 | 2025-03-15 | -| v10.2 [Download](https://releases.mattermost.com/10.2.3/mattermost-10.2.3-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-11-15 | 2025-02-15 | -| v10.1 [Download](https://releases.mattermost.com/10.1.7/mattermost-10.1.7-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-10-16 | 2025-01-15 | -| v10.0 [Download](https://releases.mattermost.com/10.0.4/mattermost-10.0.4-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-09-16 | 2024-12-15 | +| v10.3 [Download](https://releases.mattermost.com/10.3.3/mattermost-10.3.3-linux-amd64.tar.gz) \| {ref}`Changelog ` \| [SBOM download](https://github.com/mattermost/mattermost/releases/download/v10.3.3/sbom-mattermost-v10.3.3.json) | 2024-12-16 | 2025-03-15 | +| v10.2 [Download](https://releases.mattermost.com/10.2.3/mattermost-10.2.3-linux-amd64.tar.gz) \| {ref}`Changelog ` \| [SBOM download](https://github.com/mattermost/mattermost/releases/download/v10.2.3/sbom-mattermost-v10.2.3.json) | 2024-11-15 | 2025-02-15 | +| v10.1 [Download](https://releases.mattermost.com/10.1.7/mattermost-10.1.7-linux-amd64.tar.gz) \| {ref}`Changelog ` \| [SBOM download](https://github.com/mattermost/mattermost/releases/download/v10.1.7/sbom-mattermost-v10.1.7.json) | 2024-10-16 | 2025-01-15 | +| v10.0 [Download](https://releases.mattermost.com/10.0.4/mattermost-10.0.4-linux-amd64.tar.gz) \| {ref}`Changelog ` \| [SBOM download](https://github.com/mattermost/mattermost/releases/download/v10.0.4/sbom.json) | 2024-09-16 | 2024-12-15 | | v9.11 [Download](https://releases.mattermost.com/9.11.8/mattermost-9.11.8-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-08-16 | 2025-05-15 {ref}`EXTENDED ` | | v9.10 [Download](https://releases.mattermost.com/9.10.3/mattermost-9.10.3-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-07-16 | 2024-10-15 | | v9.9 [Download](https://releases.mattermost.com/9.9.3/mattermost-9.9.3-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-06-14 | 2024-09-15 | diff --git a/source/about/version-archive.rst b/source/about/version-archive.rst index d337914580d..41848e51342 100644 --- a/source/about/version-archive.rst +++ b/source/about/version-archive.rst @@ -408,18 +408,22 @@ Version archive - ``https://releases.mattermost.com/10.3.3/mattermost-team-10.3.3-linux-amd64.tar.gz`` - SHA-256 Checksum: ``ac7dc3a2352ad09cf6568ad10e80f52a7a88a9f00682b68d7dd01728594ff51f`` - GPG Signature: https://releases.mattermost.com/10.3.3/mattermost-team-10.3.3-linux-amd64.tar.gz.sig + - SBOM Download Link: https://github.com/mattermost/mattermost/releases/download/v10.3.3/sbom-mattermost-v10.3.3.json Mattermost Team Edition v10.2.3 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/10.2.3/mattermost-team-10.2.3-linux-amd64.tar.gz`` - SHA-256 Checksum: ``b18ad8db0ae03c863fa4cb7f611584794776e9a1df52cf19c4bb90ce86938eef`` - GPG Signature: https://releases.mattermost.com/10.2.3/mattermost-team-10.2.3-linux-amd64.tar.gz.sig + - SBOM Download Link: https://github.com/mattermost/mattermost/releases/download/v10.2.3/sbom-mattermost-v10.2.3.json Mattermost Team Edition v10.1.7 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/10.1.7/mattermost-team-10.1.7-linux-amd64.tar.gz`` - SHA-256 Checksum: ``baf2f1ec86448938d1ed2879cb19e5034259090cd8282d5bebdb6d495de33a06`` - GPG Signature: https://releases.mattermost.com/10.1.7/mattermost-team-10.1.7-linux-amd64.tar.gz.sig + - SBOM Download Link: https://github.com/mattermost/mattermost/releases/download/v10.1.7/sbom-mattermost-v10.1.7.json Mattermost Team Edition v10.0.4 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/10.0.4/mattermost-team-10.0.4-linux-amd64.tar.gz`` - SHA-256 Checksum: ``ad7ace64160e17b352b6f0801c928eca8200f7bc71305d2e65ca296a535cee60`` - GPG Signature: https://releases.mattermost.com/10.0.4/mattermost-team-10.0.4-linux-amd64.tar.gz.sig + - SBOM Download Link: https://github.com/mattermost/mattermost/releases/download/v10.0.4/sbom.json Mattermost Team Edition v9.11.8 *Extended Support Release (ESR)* - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/9.11.8/mattermost-team-9.11.8-linux-amd64.tar.gz`` - SHA-256 Checksum: ``f4cbbfd70a59a39e3ccb2c46a8ce5b4ee6b218ffa830474ce27a7c77d6dfda2e`` From 2a7a7d535f26c518429d9eb9b1cb4c2457f1ba9a Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Mon, 27 Jan 2025 11:45:01 -0500 Subject: [PATCH 15/23] Added testing note (#7680) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update conf.py (#7666) * Added testing note * Incorporated reviewer feedback * Update source/scale/scaling-for-enterprise.rst Co-authored-by: Alejandro García Montoro * Incorporated reviewer corrections * Update source/scale/scale-to-100000-users.rst * Update source/scale/scale-to-30000-users.rst * Update source/scale/scale-to-50000-users.rst * Update source/scale/scale-to-80000-users.rst * Update source/scale/scale-to-90000-users.rst * Update source/scale/scale-to-80000-users.rst --------- Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> Co-authored-by: Alejandro García Montoro --- source/scale/scale-to-100000-users.rst | 29 +++++++++++----------- source/scale/scale-to-30000-users.rst | 32 +++++++++++++------------ source/scale/scale-to-50000-users.rst | 32 +++++++++++++------------ source/scale/scale-to-80000-users.rst | 32 +++++++++++++------------ source/scale/scale-to-90000-users.rst | 32 +++++++++++++------------ source/scale/scaling-for-enterprise.rst | 4 ++++ 6 files changed, 87 insertions(+), 74 deletions(-) diff --git a/source/scale/scale-to-100000-users.rst b/source/scale/scale-to-100000-users.rst index 2a968a00700..2d5a4f8fb22 100644 --- a/source/scale/scale-to-100000-users.rst +++ b/source/scale/scale-to-100000-users.rst @@ -12,24 +12,25 @@ This page describes the Mattermost reference architecture designed for the load .. note:: - Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are. - From Mattermost v10.4, Mattermost Enterprise customers can configure `Redis `_ (Remote Dictionary Server) as an alternative cache backend. Using Redis can help ensure that Mattermost remains performant and efficient, even under heavy usage. See the :ref:`Redis cache backend ` configuration settings documentation for details. + - While the following Elasticsearch specifications may be more than sufficient for some use cases, we have not extensively tested configurations with lower resource allocations for this user scale. If cost optimization is a priority, admins may choose to experiment with smaller configurations, but we recommend starting with the tested specifications to ensure system stability and performance. Keep in mind that under-provisioning can lead to degraded user experience and additional troubleshooting effort. Requirements ------------ -+------------------------+-----------+----------------+-------------------+ -| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** | -| | | Memory (GiB)** | | -+========================+===========+================+===================+ -| Mattermost Application | 6 | 16/32 | c7i.4xlarge | -+------------------------+-----------+----------------+-------------------+ -| RDS Writer | 1 | 16/128 | db.r7g.4xlarge | -+------------------------+-----------+----------------+-------------------+ -| RDS Reader | 5 | 16/128 | db.r7g.4xlarge | -+------------------------+-----------+----------------+-------------------+ -| Elasticsearch Node | 2 | 4/32 | r6g.xlarge.search | -+------------------------+-----------+----------------+-------------------+ -| Proxy | 1 | 16/64 | m7i.4xlarge | -+------------------------+-----------+----------------+-------------------+ ++------------------------+-----------+----------------+-----------------------+ +| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** | +| | | Memory (GiB)** | | ++========================+===========+================+=======================+ +| Mattermost Application | 6 | 16/32 | c7i.4xlarge | ++------------------------+-----------+----------------+-----------------------+ +| RDS Writer | 1 | 16/128 | db.r7g.4xlarge | ++------------------------+-----------+----------------+-----------------------+ +| RDS Reader | 5 | 16/128 | db.r7g.4xlarge | ++------------------------+-----------+----------------+-----------------------+ +| Elasticsearch cluster | 4 | 8/64 | r6g.2xlarge.search | ++------------------------+-----------+----------------+-----------------------+ +| Proxy | 1 | 16/64 | m7i.4xlarge | ++------------------------+-----------+----------------+-----------------------+ Lifetime storage ---------------- diff --git a/source/scale/scale-to-30000-users.rst b/source/scale/scale-to-30000-users.rst index 8332988c5e4..6ceb62711ed 100644 --- a/source/scale/scale-to-30000-users.rst +++ b/source/scale/scale-to-30000-users.rst @@ -10,25 +10,27 @@ This page describes the Mattermost reference architecture designed for the load - **Database Configuration**: writer, multiple readers .. note:: - Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are. + + - Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are. + - While the following Elasticsearch specifications may be more than sufficient for some use cases, we have not extensively tested configurations with lower resource allocations for this user scale. If cost optimization is a priority, admins may choose to experiment with smaller configurations, but we recommend starting with the tested specifications to ensure system stability and performance. Keep in mind that under-provisioning can lead to degraded user experience and additional troubleshooting effort. Requirements ------------ -+------------------------+-----------+----------------+-------------------+ -| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** | -| | | Memory (GiB)** | | -+========================+===========+================+===================+ -| Mattermost Application | 2 | 8/16 | c7i.2xlarge | -+------------------------+-----------+----------------+-------------------+ -| RDS Writer | 1 | 8/64 | db.r7g.2xlarge | -+------------------------+-----------+----------------+-------------------+ -| RDS Reader | 1 | 8/64 | db.r7g.2xlarge | -+------------------------+-----------+----------------+-------------------+ -| Elasticsearch Node | 2 | 4/32 | r6g.xlarge.search | -+------------------------+-----------+----------------+-------------------+ -| Proxy | 1 | 16/64 | m7i.4xlarge | -+------------------------+-----------+----------------+-------------------+ ++------------------------+-----------+----------------+-----------------------+ +| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** | +| | | Memory (GiB)** | | ++========================+===========+================+=======================+ +| Mattermost Application | 2 | 8/16 | c7i.2xlarge | ++------------------------+-----------+----------------+-----------------------+ +| RDS Writer | 1 | 8/64 | db.r7g.2xlarge | ++------------------------+-----------+----------------+-----------------------+ +| RDS Reader | 1 | 8/64 | db.r7g.2xlarge | ++------------------------+-----------+----------------+-----------------------+ +| Elasticsearch cluster | 4 | 8/64 | r6g.2xlarge.search | ++------------------------+-----------+----------------+-----------------------+ +| Proxy | 1 | 16/64 | m7i.4xlarge | ++------------------------+-----------+----------------+-----------------------+ Lifetime storage ---------------- diff --git a/source/scale/scale-to-50000-users.rst b/source/scale/scale-to-50000-users.rst index 3c9fc62fa64..dbae7d6bb2b 100644 --- a/source/scale/scale-to-50000-users.rst +++ b/source/scale/scale-to-50000-users.rst @@ -10,25 +10,27 @@ This page describes the Mattermost reference architecture designed for the load - **Database Configuration**: writer, multiple readers .. note:: - Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are. + + - Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are. + - While the following Elasticsearch specifications may be more than sufficient for some use cases, we have not extensively tested configurations with lower resource allocations for this user scale. If cost optimization is a priority, admins may choose to experiment with smaller configurations, but we recommend starting with the tested specifications to ensure system stability and performance. Keep in mind that under-provisioning can lead to degraded user experience and additional troubleshooting effort. Requirements ------------ -+------------------------+-----------+----------------+-------------------+ -| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** | -| | | Memory (GiB)** | | -+========================+===========+================+===================+ -| Mattermost Application | 5 | 8/16 | c7i.2xlarge | -+------------------------+-----------+----------------+-------------------+ -| RDS Writer | 1 | 8/64 | db.r7g.2xlarge | -+------------------------+-----------+----------------+-------------------+ -| RDS Reader | 4 | 8/64 | db.r7g.2xlarge | -+------------------------+-----------+----------------+-------------------+ -| Elasticsearch Node | 2 | 4/32 | r6g.xlarge.search | -+------------------------+-----------+----------------+-------------------+ -| Proxy | 1 | 16/64 | m7i.4xlarge | -+------------------------+-----------+----------------+-------------------+ ++------------------------+-----------+----------------+-----------------------+ +| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** | +| | | Memory (GiB)** | | ++========================+===========+================+=======================+ +| Mattermost Application | 5 | 8/16 | c7i.2xlarge | ++------------------------+-----------+----------------+-----------------------+ +| RDS Writer | 1 | 8/64 | db.r7g.2xlarge | ++------------------------+-----------+----------------+-----------------------+ +| RDS Reader | 4 | 8/64 | db.r7g.2xlarge | ++------------------------+-----------+----------------+-----------------------+ +| Elasticsearch cluster | 4 | 8/64 | r6g.2xlarge.search | ++------------------------+-----------+----------------+-----------------------+ +| Proxy | 1 | 16/64 | m7i.4xlarge | ++------------------------+-----------+----------------+-----------------------+ Lifetime storage ---------------- diff --git a/source/scale/scale-to-80000-users.rst b/source/scale/scale-to-80000-users.rst index 3420865ff71..1050b49a4ba 100644 --- a/source/scale/scale-to-80000-users.rst +++ b/source/scale/scale-to-80000-users.rst @@ -10,25 +10,27 @@ This page describes the Mattermost reference architecture designed for the load - **Database Configuration**: writer, multiple readers .. note:: - Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are. + + - Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are. + - While the following Elasticsearch specifications may be more than sufficient for some use cases, we have not extensively tested configurations with lower resource allocations for this user scale. If cost optimization is a priority, admins may choose to experiment with smaller configurations, but we recommend starting with the tested specifications to ensure system stability and performance. Keep in mind that under-provisioning can lead to degraded user experience and additional troubleshooting effort. Requirements ------------ -+------------------------+-----------+----------------+-------------------+ -| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** | -| | | Memory (GiB)** | | -+========================+===========+================+===================+ -| Mattermost Application | 4 | 16/32 | c7i.4xlarge | -+------------------------+-----------+----------------+-------------------+ -| RDS Writer | 1 | 16/128 | db.r7g.4xlarge | -+------------------------+-----------+----------------+-------------------+ -| RDS Reader | 3 | 16/128 | db.r7g.4xlarge | -+------------------------+-----------+----------------+-------------------+ -| Elasticsearch Node | 2 | 4/32 | r6g.xlarge.search | -+------------------------+-----------+----------------+-------------------+ -| Proxy | 1 | 16/64 | m7i.4xlarge | -+------------------------+-----------+----------------+-------------------+ ++------------------------+-----------+----------------+-----------------------+ +| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** | +| | | Memory (GiB)** | | ++========================+===========+================+=======================+ +| Mattermost Application | 4 | 16/32 | c7i.4xlarge | ++------------------------+-----------+----------------+-----------------------+ +| RDS Writer | 1 | 16/128 | db.r7g.4xlarge | ++------------------------+-----------+----------------+-----------------------+ +| RDS Reader | 3 | 16/128 | db.r7g.4xlarge | ++------------------------+-----------+----------------+-----------------------+ +| Elasticsearch cluster | 4 | 8/64 | r6g.2xlarge.search | ++------------------------+-----------+----------------+-----------------------+ +| Proxy | 1 | 16/64 | m7i.4xlarge | ++------------------------+-----------+----------------+-----------------------+ Lifetime storage ---------------- diff --git a/source/scale/scale-to-90000-users.rst b/source/scale/scale-to-90000-users.rst index a5c24f6ed54..2d8d783c1bf 100644 --- a/source/scale/scale-to-90000-users.rst +++ b/source/scale/scale-to-90000-users.rst @@ -10,25 +10,27 @@ This page describes the Mattermost reference architecture designed for the load - **Database Configuration**: writer, multiple readers .. note:: - Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are. + + - Usage of CPU, RAM, and storage space can vary significantly based on user behavior. These hardware recommendations are based on traditional deployments and may grow or shrink depending on how active your users are. + - While the following Elasticsearch specifications may be more than sufficient for some use cases, we have not extensively tested configurations with lower resource allocations for this user scale. If cost optimization is a priority, admins may choose to experiment with smaller configurations, but we recommend starting with the tested specifications to ensure system stability and performance. Keep in mind that under-provisioning can lead to degraded user experience and additional troubleshooting effort. Requirements ------------ -+------------------------+-----------+----------------+-------------------+ -| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** | -| | | Memory (GiB)** | | -+========================+===========+================+===================+ -| Mattermost Application | 5 | 16/32 | c7i.4xlarge | -+------------------------+-----------+----------------+-------------------+ -| RDS Writer | 1 | 16/128 | db.r7g.4xlarge | -+------------------------+-----------+----------------+-------------------+ -| RDS Reader | 4 | 16/128 | db.r7g.4xlarge | -+------------------------+-----------+----------------+-------------------+ -| Elasticsearch Node | 2 | 4/32 | r6g.xlarge.search | -+------------------------+-----------+----------------+-------------------+ -| Proxy | 1 | 16/64 | m7i.4xlarge | -+------------------------+-----------+----------------+-------------------+ ++------------------------+-----------+----------------+-----------------------+ +| **Resource Type** | **Nodes** | **vCPU/ | **AWS Instance** | +| | | Memory (GiB)** | | ++========================+===========+================+=======================+ +| Mattermost Application | 5 | 16/32 | c7i.4xlarge | ++------------------------+-----------+----------------+-----------------------+ +| RDS Writer | 1 | 16/128 | db.r7g.4xlarge | ++------------------------+-----------+----------------+-----------------------+ +| RDS Reader | 4 | 16/128 | db.r7g.4xlarge | ++------------------------+-----------+----------------+-----------------------+ +| Elasticsearch cluster | 4 | 8/64 | r6g.2xlarge.search | ++------------------------+-----------+----------------+-----------------------+ +| Proxy | 1 | 16/64 | m7i.4xlarge | ++------------------------+-----------+----------------+-----------------------+ Lifetime storage ---------------- diff --git a/source/scale/scaling-for-enterprise.rst b/source/scale/scaling-for-enterprise.rst index c84984ea8d9..bf5209a26b2 100644 --- a/source/scale/scaling-for-enterprise.rst +++ b/source/scale/scaling-for-enterprise.rst @@ -23,6 +23,10 @@ The following reference architectures are available as recommended starting poin * :doc:`Scale up to 90000 users ` - Learn how to scale Mattermost to up to 90000 users. * :doc:`Scale up to 100000 users ` - Learn how to scale Mattermost to up to 100000 users. +.. important:: + + Due to constraints in testing, the proxy instance specifications were fixed for all the tests from which we derived these reference architectures. This was done to avoid a combinatorial explosion of variables in tests, but it resulted in minor gaps in our understandings of certain aspects of the reference architectures. In particular, the proxy instance is overspecified for the smaller user counts. + Testing methodology and updates -------------------------------- From f50b5fce8f02bf264a4e1e7deb0ead7c571d9c4e Mon Sep 17 00:00:00 2001 From: Agniva De Sarker Date: Mon, 27 Jan 2025 22:17:52 +0530 Subject: [PATCH 16/23] Add policy to bump postgres minimum version (#7709) * Add policy to bump postgres minimum version * Wordsmithing, MD > RST, & breadcrumb links * Update source/install/prepare-mattermost-database.rst Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> * Update source/install/prepare-mattermost-database.rst Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> * Update source/install/prepare-mattermost-database.rst Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> * Update source/install/prepare-mattermost-database.rst * Update source/install/software-hardware-requirements.rst Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> * Incorporated reviewer feedback * Update source/install/prepare-mattermost-database.rst * Incorporated reviewer feedback * Update source/install/prepare-mattermost-database.rst * Update source/install/prepare-mattermost-database.rst * Update source/install/prepare-mattermost-database.rst * Update source/install/prepare-mattermost-database.rst * Update source/install/prepare-mattermost-database.rst --------- Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com> --- source/deploy/postgres-migration.rst | 2 +- .../install/prepare-mattermost-database.rst | 45 ++++++++++++++++++- .../software-hardware-requirements.rst | 8 ++-- source/install/trouble-postgres.rst | 2 +- 4 files changed, 51 insertions(+), 6 deletions(-) diff --git a/source/deploy/postgres-migration.rst b/source/deploy/postgres-migration.rst index cc2905bcf75..c6833336b17 100644 --- a/source/deploy/postgres-migration.rst +++ b/source/deploy/postgres-migration.rst @@ -4,7 +4,7 @@ Migration guidelines from MySQL to PostgreSQL .. include:: ../_static/badges/allplans-selfhosted.rst :start-after: :nosearch: -From Mattermost v8.0, 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. +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. .. toctree:: :maxdepth: 1 diff --git a/source/install/prepare-mattermost-database.rst b/source/install/prepare-mattermost-database.rst index 1795b49f502..10d66909d0e 100644 --- a/source/install/prepare-mattermost-database.rst +++ b/source/install/prepare-mattermost-database.rst @@ -4,12 +4,15 @@ Prepare your Mattermost database .. include:: ../_static/badges/allplans-selfhosted.rst :start-after: :nosearch: -You need a PostgreSQL database. See the :ref:`database software ` documentation for details on database version support, and see the :doc:`Migrate from MySQL to PostgreSQL ` documentation for details on migrating from MySQL to PostgreSQL. +You need a PostgreSQL database. See the :ref:`database software ` and the `minimum supported version policy <#minimum-supported-version-policy>`__ documentation for version support details, and see the :doc:`Migrate from MySQL to PostgreSQL ` documentation to learn more about migrating from MySQL to PostgreSQL. .. tip:: Looking for information on working with a MySQL database? See the :doc:`prepare your Mattermost MySQL database ` documentation for details. +Set up a PostgreSQL database +---------------------------- + To set up a PostgreSQL database for use by the Mattermost server: 1. Log in to the server that will host the database, and install PostgreSQL. See the `PostgreSQL `__ documentation for details. When the installation is complete, the PostgreSQL server is running, and a Linux user account called *postgres* has been created. @@ -204,3 +207,43 @@ When the PostgreSQL database is installed, and the initial setup is complete, yo .. important:: If you are upgrading a major version of Postgres, it is essential that ``ANALYZE VERBOSE`` is run on the database post upgrade. This is necessary to re-populate the ``pg_statistics`` table used to generate optimal query plans. The database performance might suffer if this step is not done. + + +Minimum supported version policy +--------------------------------- + +To make planning easier and ensure your Mattermost deployment remains fast and secure, we are introducing a policy for updating the minimum supported version of PostgreSQL. The oldest supported PostgreSQL version Mattermost supports will match the oldest version supported by the PostgreSQL community. This ensures you benefit from the latest features and security updates. + +This policy change takes effect from Mattermost v10.6, where the minimum PostgreSQL version required will be PostgreSQL 13. This aligns with the PostgreSQL community's support policy, which provides 5 years of support for each major version. + +.. note:: + + Mattermost v10.6 is not an :ref:`Extended Support Release (ESR) `. Going forward, this database version support policy will only apply to ESR releases. + +When a PostgreSQL version reaches its end of life (EOL), Mattermost will require a newer version starting with the next scheduled ESR release. This means the following future PostgreSQL minimum version increases as follows: + ++-----------------------------------------------------------+------------------+--------------------------------+ +| **Mattermost Version** | **Release Date** | **Minimum PostgreSQL Version** | ++===========================================================+==================+================================+ +| :ref:`v9.11 ESR ` | 2024-8-15 | 11.x | ++-----------------------------------------------------------+------------------+--------------------------------+ +| v10.5 ESR | 2025-2-15 | 11.x | ++-----------------------------------------------------------+------------------+--------------------------------+ +| v10.6 | 2025-3-15 | 13.x | ++-----------------------------------------------------------+------------------+--------------------------------+ +| v10.11 ESR | 2025-8-15 | 13.x | ++-----------------------------------------------------------+------------------+--------------------------------+ +| v11.5 ESR ``*`` | 2026-2-15 | 14.x (EOL 2026-11-12) | ++-----------------------------------------------------------+------------------+--------------------------------+ + +``*`` Forcasted release version and date. + +Customers will have 9 months to plan, test, and upgrade their PostgreSQL version before the new requirement takes effect. This policy aims to provide clarity and transparency so you can align database upgrades with the Mattermost release schedule. Contact a `Mattermost Expert `_. to discuss your options. + +Frequently asked questions +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +What about MySQL databases? +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Mattermost is :ref:`deprecating support for MySQL ` starting with v11. We aren't actively maintaining or working on MySQL support. \ No newline at end of file diff --git a/source/install/software-hardware-requirements.rst b/source/install/software-hardware-requirements.rst index 8713847511c..d371efa3ab6 100644 --- a/source/install/software-hardware-requirements.rst +++ b/source/install/software-hardware-requirements.rst @@ -101,9 +101,11 @@ Database software Amazon Aurora equivalents of both PostgreSQL and MySQL are also supported. -See the :doc:`Migrate from MySQL to PostgreSQL ` product documentation for details on migrating from MySQL to PostgreSQL. +See the :ref:`minimum supported version policy ` documentation for minimum PostgreSQL version support details, and see the :doc:`Migrate from MySQL to PostgreSQL ` product documentation to learn about migrating from MySQL to PostgreSQL. -MariaDB v10+ no longer functions as a MySQL drop-in replacement, and it's not supported for Mattermost due to the requirement of MySQL 5.7.12. Prior versions of MariaDB were not officially supported but may have functioned in older Mattermost releases. If you are running MariaDB now, migrating from MariaDB to the MySQL equivalent is recommended. +.. important:: + + MariaDB v10+ no longer functions as a MySQL drop-in replacement, and it's not supported for Mattermost due to the requirement of MySQL 5.7.12. Prior versions of MariaDB were not officially supported but may have functioned in older Mattermost releases. If you are running MariaDB now, migrating from MariaDB to the MySQL equivalent is recommended. Deployments requiring searching in Chinese, Japanese, and Korean languages require MySQL 5.7.6+ and the configuration of `ngram Full-Text parser `__. For searching two characters, you will also need to set ``ft_min_word_len`` and ``innodb_ft_min_token_size`` to ``2`` and restart MySQL. See `CJK discussion `__ for details. @@ -120,7 +122,7 @@ Search limitations on MySQL: - The migration system requires the MySQL database user to have additional `EXECUTE`, `CREATE ROUTINE`, `ALTER ROUTINE` and `REFERENCES` privileges to run schema migrations. MySQL 8 Support -^^^^^^^^^^^^^^^^ +:::::::::::::::: In MySQL 8.0.4, the default authentication plugin was changed from ``mysql_native_password`` to ``caching_sha2_password``. Therefore, you will need to enable ``mysql_native_password`` by adding the following entry in your MySQL configuration file: diff --git a/source/install/trouble-postgres.rst b/source/install/trouble-postgres.rst index 99514287292..a4ebf3319a4 100644 --- a/source/install/trouble-postgres.rst +++ b/source/install/trouble-postgres.rst @@ -1,7 +1,7 @@ PostgreSQL installation troubleshooting ======================================= -Mattermost supports PostgreSQL v12+. +From Mattermost v8.0, :ref:`PostgreSQL ` is our database of choice for Mattermost to enhance the platform’s performance and capabilities. PostgreSQL v15 introduces changes that may affect compatibility with previous releases. If you're deploying a fresh installation of PostgreSQL v15, run this command: ``GRANT CREATE ON SCHEMA public TO PUBLIC`` to ensure that you can use Mattermost. From 6cc931e7a0c64b4c53209184139c0e84d164f042 Mon Sep 17 00:00:00 2001 From: "Carrie Warner (Mattermost)" <74422101+cwarnermm@users.noreply.github.com> Date: Mon, 27 Jan 2025 15:50:44 -0500 Subject: [PATCH 17/23] Corrected assumptions that Off-Topic = default channel (#7715) --- source/collaborate/channel-types.rst | 2 +- source/collaborate/collaborate-within-channels.rst | 7 ++----- source/collaborate/join-leave-channels.rst | 2 +- source/configure/experimental-configuration-settings.rst | 4 ++-- source/getting-started/enterprise-roll-out-checklist.rst | 2 +- source/onboard/guest-accounts.rst | 2 +- source/onboard/user-provisioning-workflows.rst | 2 +- 7 files changed, 9 insertions(+), 12 deletions(-) diff --git a/source/collaborate/channel-types.rst b/source/collaborate/channel-types.rst index a7e986869b8..4d93727980f 100644 --- a/source/collaborate/channel-types.rst +++ b/source/collaborate/channel-types.rst @@ -21,7 +21,7 @@ There are 5 types of channels in Mattermost: Public channels --------------- -Public channels are open to everyone on a team and are identified with a **Globe** |globe| icon. New team members are automatically added to two public channels when they sign up: **Town Square** and **Off-Topic**. +Public channels are open to everyone on a team and are identified with a **Globe** |globe| icon. New team members are automatically added to the **Town Square** channel. See the :doc:`Join and leave channels ` documentation for details on discovering, joining, and leaving other channels. diff --git a/source/collaborate/collaborate-within-channels.rst b/source/collaborate/collaborate-within-channels.rst index f601bf3ecd3..01a7c65e623 100644 --- a/source/collaborate/collaborate-within-channels.rst +++ b/source/collaborate/collaborate-within-channels.rst @@ -9,13 +9,10 @@ Channels are where you connect, collaborate, and communicate with your team abou You're added to default channels automatically ---------------------------------------------- -Everyone who joins a Mattermost :doc:`workspace ` is automatically added to two default public channels: **Town Square** and **Off-Topic**. See our :doc:`Channel Types ` documentation for details. - -- **Town Square** is great for your team-wide communications, such as announcements. -- **Off-Topic** is great for fun, social, non-work-related conversations. +Everyone who joins a Mattermost :doc:`workspace ` is automatically added to the **Town Square** channel. See our :doc:`Channel Types ` documentation for details. .. note:: - Town Square can't be :ref:`archived ` or :doc:`converted to a private channel `, and users can't :ref:`leave ` this default channel. + The Town Square channel can't be :ref:`archived ` or :doc:`converted to a private channel `, and users can't :ref:`leave ` this default channel. Channel sidebar ---------------- diff --git a/source/collaborate/join-leave-channels.rst b/source/collaborate/join-leave-channels.rst index d620f6019d0..e3170ab744d 100644 --- a/source/collaborate/join-leave-channels.rst +++ b/source/collaborate/join-leave-channels.rst @@ -74,7 +74,7 @@ When you leave a private channel, you must be re-added by another channel member .. note:: - All users are added to the **Off-Topic** and **Town Square** channels automatically. Users can't :ref:`archive `, :ref:`unarchive `, or leave these channels. + All users are added to the **Town Square** channel automatically. This means that users can't :ref:`archive `, :ref:`unarchive `, or leave the **Town Square** channel. .. tab:: Web/Desktop diff --git a/source/configure/experimental-configuration-settings.rst b/source/configure/experimental-configuration-settings.rst index 6b023d7b005..69bcccde1d2 100644 --- a/source/configure/experimental-configuration-settings.rst +++ b/source/configure/experimental-configuration-settings.rst @@ -1945,11 +1945,11 @@ This setting isn't available in the System Console and can only be set in ``conf Default channels every user is added to automatically after joining a new team. Only applies to Public channels, but affects all teams on the server. -When not set, every user is added to the ``off-topic`` and ``town-square`` channels by default. +When not set, every user is added to the ``town-square`` channel by default. .. note:: - Even if ``town-square`` and ``off-topic`` aren't listed, every user is added to these channels automatically when joining a new team. + Even if ``town-square`` isn't listed, every user is added to that channels automatically when joining a new team. +----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | This feature's ``config.json`` setting is ``"ExperimentalDefaultChannels": []`` with string array input consisting of channel names, such as ``["announcement", "developers"]``. | diff --git a/source/getting-started/enterprise-roll-out-checklist.rst b/source/getting-started/enterprise-roll-out-checklist.rst index 1f5ed88cae9..ada0085623b 100644 --- a/source/getting-started/enterprise-roll-out-checklist.rst +++ b/source/getting-started/enterprise-roll-out-checklist.rst @@ -232,7 +232,7 @@ Now that you have an environment in place, we recommend working through the foll - Recommendation: Start with fewer teams in your early roll out - Resource: https://docs.mattermost.com/messaging/organizing-channels.html -- Determine and create key channels to support your users. Town Square and Off-Topic are automatically created channels available on every team +- Determine and create key channels to support your users. A default Town Square channel is created automatically and available on every team. - Recommendation: Add a “Support” channel for your users to escalate questions diff --git a/source/onboard/guest-accounts.rst b/source/onboard/guest-accounts.rst index f05444e2fef..e64503754a3 100644 --- a/source/onboard/guest-accounts.rst +++ b/source/onboard/guest-accounts.rst @@ -16,7 +16,7 @@ Guest accounts in Mattermost are a way to collaborate with individuals, such as - A system admin must :ref:`enable guest access ` before guests can be invited. - Mattermost Enterprise and Professional customers can :doc:`control who can invite guests ` in their organization. By default, only system admins can invite guests. - - Guest accounts count as a paid user in your Mattermost :doc:`workspace `. However, guests aren't automatically added to the default **Town-square** and **Off-topic** channels when they log in. You must :doc:`invite guests ` to individual teams and channels manually. Deactivating a guest account reduces your licensed seat count. + - Guest accounts count as a paid user in your Mattermost :doc:`workspace `. However, guests aren't automatically added to the default **Town-square** channel when they log in. You must :doc:`invite guests ` to individual teams and channels manually. Deactivating a guest account reduces your licensed seat count. - You'll identify guest users in Mattermost based on their **GUEST** badge next to their name and profile picture. Channels that contain guests also display the message ***This channel has guests** in the channel header. Guests account limits diff --git a/source/onboard/user-provisioning-workflows.rst b/source/onboard/user-provisioning-workflows.rst index 70da2a16e73..51f89152308 100644 --- a/source/onboard/user-provisioning-workflows.rst +++ b/source/onboard/user-provisioning-workflows.rst @@ -13,7 +13,7 @@ User Provisioning There are currently three recommended user provisioning workflows in Mattermost: -1. **On demand:** If user accounts are not pre-provisioned using one of the methods described below, then a new user account will be provisioned when the user first logs in. When the user logs in, they are asked to select a public team to join (all users must belong to at least one team) and then they are added automatically to Town Square and Off-Topic channels. Mattermost also has a :ref:`default channel setting ` that enables system admins to add everyone to additional channels specified by the organization. +1. **On demand:** If user accounts are not pre-provisioned using one of the methods described below, then a new user account will be provisioned when the user first logs in. When the user logs in, they are asked to select a public team to join (all users must belong to at least one team) and then they are added automatically to the Town Square channel. Mattermost also has a :ref:`default channel setting ` that enables system admins to add everyone to additional channels specified by the organization. 2. **Pre-provisioned via bulk import:** Mattermost features a :doc:`bulk data loading tool ` that can be used for pre-provisioning new users by adding them to teams and channels before their first login to Mattermost. This tool automates the creation of Teams, Channels, Users, and Posts (with file attachments). It can also be used to migrate users and content from an existing system. 3. **Mattermost API:** The Mattermost `RESTful API `__ can be used to pre-provision new user accounts as well as add and remove them from teams and channels. This model is commonly used by enterprises that have central account provisioning applications. From 3096be77570e42e50317f35eeb9a34e240a77ca9 Mon Sep 17 00:00:00 2001 From: Amy Blais <29708087+amyblais@users.noreply.github.com> Date: Thu, 30 Jan 2025 09:15:05 +0200 Subject: [PATCH 18/23] Update deprecated-features.rst (#7716) * Update deprecated-features.rst * Update source/about/deprecated-features.rst --------- Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> --- source/about/deprecated-features.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/source/about/deprecated-features.rst b/source/about/deprecated-features.rst index aed46ddaec0..50cb83be28a 100644 --- a/source/about/deprecated-features.rst +++ b/source/about/deprecated-features.rst @@ -6,6 +6,11 @@ This page describes features that are removed from support for Mattermost, or wi Removed features in upcoming versions ------------------------------------- +Mattermost Server v10.6.0 +~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Support for PostgreSQL v11 and v12 will be removed. The new minimum PostgreSQL version will be v13+. See the :ref:`minimum supported PostgreSQL version policy ` documentation for details. + Mattermost Mobile App v2.25.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 61b36064e3f12b97c5011a141f69a4d1569dc4d5 Mon Sep 17 00:00:00 2001 From: Ibrahim Serdar Acikgoz Date: Thu, 30 Jan 2025 14:55:28 +0100 Subject: [PATCH 19/23] reflect changes on dbcmp tooling (#7717) --- source/deploy/manual-postgres-migration.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/source/deploy/manual-postgres-migration.rst b/source/deploy/manual-postgres-migration.rst index bc67a5eb136..eb4350af645 100644 --- a/source/deploy/manual-postgres-migration.rst +++ b/source/deploy/manual-postgres-migration.rst @@ -421,7 +421,9 @@ To avoid performance regression on ``Posts`` and ``FileInfo`` table access, foll Compare the data ~~~~~~~~~~~~~~~~ -We internally developed a tool to simplify the process of comparing the contents of two databases. The ``dbcmp`` tool compares every table and reports whether there is a diversion between two schemas. Note that ``dbcmp`` does not compare individual rows, instead, it calculates the checksum value of given ``page-size`` and compares those values. This means it cannot calculate or provide diffs on individual rows. +We developed an internal tool called ``dbcmp`` to simplify database comparison. It checks every table in two databases and reports any differences in their schemas. However, ``dbcmp`` does not compare individual rows. Instead, it calculates checksum values based on a specified page-size and compares them. This means it cannot generate row-level diffs. + +We recommend using ``dbcmp`` as an additional check to verify data integrity, especially if custom casting rules (beyond the defaults or those provided by us) were used during migration. Otherwise, running this tool is not necessary. The tool includes a few flags to run a comparison: @@ -432,16 +434,21 @@ The tool includes a few flags to run a comparison: Flags: --exclude strings exclude tables from comparison, takes comma-separated values. + --include strings include only matching tables for comparison, takes comma-separated values. -h, --help help for dbcmp --source string source database dsn --target string target database dsn -v, --version version for dbcmp +.. note:: + + ``--exclude`` and ``--include`` flags are mutually exclusive and they can't be used together. + For our case, we can simply run the following command: .. code-block:: sh - dbcmp --source "${MYSQL_DSN}" --target "${POSTGRES_DSN} " --exclude="db_migrations,ir_,focalboard,systems" + dbcmp --source "${MYSQL_DSN}" --target "${POSTGRES_DSN} " --include="posts,users" An example command would look like: ``dbcmp --source "user:password@tcp(address:3306)/db_name --target "postgres://user:password@address:5432/db_name`` From cf553b8d8fc03feca1a2762a840386e2372fd7ac Mon Sep 17 00:00:00 2001 From: kshitij katiyar <90389917+Kshitij-Katiyar@users.noreply.github.com> Date: Mon, 3 Feb 2025 15:10:20 +0530 Subject: [PATCH 20/23] [MM-1137]: Updated the Jira docs with help text for Admin API Token and Admin Email (#7605) * [MM-1137]: Updated the Jira docs with help text for Admin API Token and Admin Email * Editorial updates * Update source/integrate/jira-interoperability.rst * Update source/integrate/jira-interoperability.rst * MM-1137: review fixes --------- Co-authored-by: Raghav Aggarwal Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> Co-authored-by: Doug Lauder --- source/integrate/jira-interoperability.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/integrate/jira-interoperability.rst b/source/integrate/jira-interoperability.rst index 2daa4c0f3a2..584208f7865 100644 --- a/source/integrate/jira-interoperability.rst +++ b/source/integrate/jira-interoperability.rst @@ -50,6 +50,8 @@ A Mattermost system admin must perform the following steps in Mattermost. - **Hide issue descriptions and comments**: Show or hide issue descriptions and comments from subscription and webhook messages. - **Enable slash command**: Enable or disable slash command autocompletion to guide users through available ``/jira`` slash commands. - **Display Subscription name in notifications**: Show or hide subscription name in notification messages posted to a channel. + - **Admin API Token**: Set an `API token `_ to get notified for comments and issue creation events, even when the user triggering the event isn't connected to Jira, and set up Autolink. API tokens must be created using an admin Jira account; otherwise, notifications won't be delivered for projects the user can't access, and Autolink won't work. + - **Admin Email**: Set Admin email to get notified for comment and issue created events even if the user triggering the event is not connected to Jira and setup Autolink for Jira plugin. 2. Run ``/jira setup`` to start the wizard to configure the plugin. If you wish to set up the plugin manually, then please follow the steps below. From 96fa5c5185183d0407aade492d65883a7b23682d Mon Sep 17 00:00:00 2001 From: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> Date: Mon, 3 Feb 2025 14:55:00 -0600 Subject: [PATCH 21/23] Update faq-business.rst (#7722) --- source/about/faq-business.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/about/faq-business.rst b/source/about/faq-business.rst index e00710b3f4d..25d539af129 100644 --- a/source/about/faq-business.rst +++ b/source/about/faq-business.rst @@ -10,7 +10,7 @@ For example, the Mattermost server source code is and always has been made avail For clarity, this license information regarding forking the source specifically refers to the use (and compilation) of the Mattermost source code by third parties. Third parties are obligated to comply with the open source licenses referenced above in connection with their derivative works. Compiled versions and derivative works of Mattermost prepared by third parties may not be made available under any license other than those under which the applicable source code is made available. -In contrast, Mattermost, as the copyright holder to the collection of the Mattermost source code, has exercised its exclusive right to make compiled versions of the Mattermost source code available under various other licenses (such as the MIT license and the Mattermost Commercial Enterprise License, as more specifically made clear in the table here: https://docs.mattermost.com/about/faq-enterprise.html#what-are-mattermost-s-policies-around-licensing-terms-of-use-and-privacy). +In contrast, Mattermost, as the copyright holder to the collection of the Mattermost source code, has exercised its exclusive right to make compiled versions of the Mattermost source code available under various other licenses (such as the MIT license and the Mattermost Commercial Enterprise License, as more specifically made clear in the table here: https://docs.mattermost.com/about/faq-license.html). How can I create an open source derivative work of Mattermost? -------------------------------------------------------------- From e9538d5a6e920258669df2ee43038db231fdb05f Mon Sep 17 00:00:00 2001 From: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com> Date: Tue, 4 Feb 2025 08:48:16 -0600 Subject: [PATCH 22/23] Update access-your-workspace.rst (#7723) * Update access-your-workspace.rst Added note that Server URLs must begin with either http:// or https:// in mobile as I have seen a few outreaches from users stuck at this point. * Update source/collaborate/access-your-workspace.rst --------- Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> --- source/collaborate/access-your-workspace.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/collaborate/access-your-workspace.rst b/source/collaborate/access-your-workspace.rst index 618ad357151..2465e82f257 100644 --- a/source/collaborate/access-your-workspace.rst +++ b/source/collaborate/access-your-workspace.rst @@ -47,7 +47,7 @@ Your Mattermost :doc:`workspace ` is accessible through .. tab:: Mobile 1. Download and install the Mattermost :doc:`iOS mobile app ` or the :doc:`Android mobile app `. - 2. When prompted, enter the Mattermost server link and a display name for the Mattermost instance. The display name is helpful in cases where you connect to multiple Mattermost instances. See the :doc:`server connections ` documentation for details. + 2. When prompted, enter the Mattermost server link and a display name for the Mattermost instance. Server URLs must begin with either ``http://`` or ``https://``. The display name is helpful in cases where you connect to multiple Mattermost instances. See the :doc:`server connections ` documentation for details. 3. Enter your user credentials to log into Mattermost. 4. The team that displays first in the team sidebar opens. If you're not a member of a team yet, you're prompted to select a team to join. @@ -116,4 +116,4 @@ Multi-factor authentication If your system admin :ref:`enables multi-factor authentication ` for your Mattermost instance, you can :doc:`optionally set up multi-factor authentication ` for your Mattermost user account by selecting your profile picture located in the top-right corner of Mattermost, and going to **Security > Multi-Factor Authentication**. -If your system admin :ref:`enforces multi-factor authentication `, you are required to :doc:`set up multi-factor authentication ` for your Mattermost account. When you attempt to log in to Mattermost, you're directed to the multi-factor authentication setup page. You won't be able to access Mattermost until multi-factor setup is complete. If you encounter issues setting up multi-factor authentication, contact your Mattermost system admin for assistance. \ No newline at end of file +If your system admin :ref:`enforces multi-factor authentication `, you are required to :doc:`set up multi-factor authentication ` for your Mattermost account. When you attempt to log in to Mattermost, you're directed to the multi-factor authentication setup page. You won't be able to access Mattermost until multi-factor setup is complete. If you encounter issues setting up multi-factor authentication, contact your Mattermost system admin for assistance. From e02f18390976f8a3ecda205bc25527818e2c3e7f Mon Sep 17 00:00:00 2001 From: Christopher Poile Date: Mon, 10 Feb 2025 09:22:33 -0500 Subject: [PATCH 23/23] [MM-62887] Update docs for removed command line export cmds (#7728) * update docs for removed command line export cmds * Update source/manage/command-line-tools.rst * Update source/manage/command-line-tools.rst * Update source/manage/command-line-tools.rst --------- Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> --- source/manage/command-line-tools.rst | 89 ++++------------------------ 1 file changed, 13 insertions(+), 76 deletions(-) diff --git a/source/manage/command-line-tools.rst b/source/manage/command-line-tools.rst index 8679d7b56a8..8e91d1761f4 100644 --- a/source/manage/command-line-tools.rst +++ b/source/manage/command-line-tools.rst @@ -232,17 +232,6 @@ Format mattermost db version -Example - .. code-block:: sh - - bin/mattermost export actiance --exportFrom=1513102632 - -Options - .. code-block:: text - - --exportFrom string Unix timestamp (milliseconds since epoch, UTC) to export data from. - --batchSize int The number of posts to export. The default of -1 means no limit. - ---- mattermost export @@ -255,82 +244,26 @@ Description Commands for exporting data for compliance and for merging multiple Mattermost instances. Child Commands - - `mattermost export actiance`_ - Export data from Mattermost in Actiance XML format. Requires a Mattermost Enterprise subscription plan. + - `mattermost export actiance`_ - Deprecated from Mattermost v10.5 in favor of `mattermost export schedule`_. + - `mattermost export csv`_ - Deprecated from Mattermost v10.5. + - `mattermost export global-relay-zip`_ - Deprecated from Mattermost v10.5. + - `mattermost export schedule`_ - Schedule a compliance export job. - `mattermost export bulk`_ - Export data to a file compatible with the Mattermost :doc:`Bulk Import format `. Deprecated in favor of :ref:`mmctl export commands `. - - `mattermost export csv`_ - Export data from Mattermost in CSV format. Requires a Mattermost Enterprise subscription plan. - - `mattermost export global-relay-zip`_ - Export data from Mattermost into a ZIP file containing emails to send to Global Relay for debug and testing purposes only. Requires a Mattermost Enterprise subscription plan. - - `mattermost export schedule`_ - Schedule an export job mattermost export actiance ~~~~~~~~~~~~~~~~~~~~~~~~~~ -Description - Export data from Mattermost in Actiance XML format. - -Format - .. code-block:: sh - - mattermost export actiance - -Example - .. code-block:: sh - - bin/mattermost export actiance --exportFrom=1513102632 - -Options - .. code-block:: text - - --exportFrom string Unix timestamp (milliseconds since epoch, UTC) to export data from. - --batchSize int The number of posts to export. The default of -1 means no limit. - -mattermost export bulk -~~~~~~~~~~~~~~~~~~~~~~ - -From Mattermost v6.0, this command has been deprecated in favor of :ref:`mmctl export commands ` as the supported way to export data out of Mattermost. +From Mattermost v10.5, this command has been deprecated. It will be added to the mmctl command line tool in a future version. Until then, please use `mattermost export schedule`_. mattermost export csv ~~~~~~~~~~~~~~~~~~~~~ -Description - Export data from Mattermost in CSV format. - -Format - .. code-block:: sh - - mattermost export csv - -Example - .. code-block:: sh - - bin/mattermost export csv --exportFrom=1513102632 - -Options - .. code-block:: text - - --exportFrom string Unix timestamp (seconds since epoch, UTC) to export data from. - --batchSize int The number of posts to export. The default of -1 means no limit. +From Mattermost v10.5, this command has been deprecated. It will be added to the mmctl command line tool in a future version. mattermost export global-relay-zip ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Description - Export data from Mattermost into a zip file containing emails to send to Global Relay for debug and testing purposes only. This does not archive any information in Global Relay. - -Format - .. code-block:: sh - - mattermost export global-relay-zip - -Example - .. code-block:: sh - - bin/mattermost export global-relay-zip --exportFrom=1513102632 - -Options - .. code-block:: text - - --exportFrom string Unix timestamp (seconds since epoch, UTC) to export data from. - --batchSize int The number of posts to export. The default of -1 means no limit. +From Mattermost v10.5, this command has been deprecated. It will be added to the mmctl command line tool in a future version. mattermost export schedule ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -346,15 +279,19 @@ Format Example .. code-block:: sh - bin/mattermost export schedule --format=actiance --exportFrom=1513102632 + bin/mattermost export schedule --exportFrom=1513102632 Options .. code-block:: text - --format string Output file format. Currently, only ``actiance`` is supported. --exportFrom string Unix timestamp (seconds since epoch, UTC) to export data from. --timeoutSeconds string Set how long the export should run for before timing out. +mattermost export bulk +~~~~~~~~~~~~~~~~~~~~~~ + +From Mattermost v6.0, this command has been deprecated in favor of :ref:`mmctl export commands ` as the supported way to export data out of Mattermost. + ---- mattermost help