Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

v10.4 Docs #7667

Open
wants to merge 28 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
efbe578
Update conf.py (#7666)
amyblais Dec 18, 2024
fbd25cc
Merge branch 'master' into v10.4-documentation
amyblais Dec 18, 2024
45df626
Merge branch 'master' into v10.4-documentation
amyblais Dec 18, 2024
f44ff00
Merge branch 'master' into v10.4-documentation
amyblais Jan 2, 2025
c9482b4
Merge branch 'master' into v10.4-documentation
amyblais Jan 6, 2025
6766dfb
Merge branch 'master' into v10.4-documentation
amyblais Jan 7, 2025
f4cc5c5
Fixed typo (#7679)
cwarnermm Jan 10, 2025
81484f4
Clarified team admin capabilities (#7681)
cwarnermm Jan 10, 2025
c441633
Added diagnostics file to Support Packet (#7682)
cwarnermm Jan 10, 2025
789780a
Added Enterprise-only About > Hostname (#7683)
cwarnermm Jan 10, 2025
a57d22f
Updated web & desktop notification prompt details (#7685)
cwarnermm Jan 10, 2025
881a793
Clarified min server version requirements (#7688)
cwarnermm Jan 10, 2025
710c117
Added Amazon S3 storage class config settings (#7691)
cwarnermm Jan 10, 2025
06c8466
Added WIP Locales config setting (#7690)
cwarnermm Jan 10, 2025
e87e100
Removed Slack theme import functionality (#7684)
cwarnermm Jan 10, 2025
a183dae
Added Redis config settings (#7689)
cwarnermm Jan 10, 2025
46852c3
Docs listening: Added clarity on how to access config settings in the…
cwarnermm Jan 10, 2025
b8b3ca9
Incorporated https://github.com/mattermost/docs/pull/7467
cwarnermm Jan 10, 2025
14a2d89
Merge branch 'master' into v10.4-documentation
cwarnermm Jan 10, 2025
9ae1cae
Broken link fixes
cwarnermm Jan 10, 2025
836bccb
Merge branch 'v10.4-documentation' of https://github.com/mattermost/d…
cwarnermm Jan 10, 2025
8ee98ea
Added emoji prefix recommendation for channels & channel categories (…
cwarnermm Jan 10, 2025
e77ae0c
Added scheduled maintenance comms guidance (#7696)
cwarnermm Jan 10, 2025
6d10809
Incorporated reviewer feedback
cwarnermm Jan 13, 2025
9d84314
v10.4 Changelog (#7664)
amyblais Jan 14, 2025
65e3f5b
Merge branch 'master' into v10.4-documentation
cwarnermm Jan 14, 2025
70e18a3
Merge branch 'master' into v10.4-documentation
amyblais Jan 15, 2025
4430334
Merge branch 'master' into v10.4-documentation
amyblais Jan 15, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/_templates/custom-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ <h4>Connect and collaborate</h4>
</div>
<div class='masthead-card__content'>
<h4>Build repeatable processes</h4>
<p>Most faster and make fewer mistakes with checklist-based automation that
<p>Move faster and make fewer mistakes with checklist-based automation that
powers your team workflows.</p>
<p class='link'>Get started »</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions source/about/certifications-and-compliance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.bis.doc.gov/index.php/regulations/export-administration-regulations-ear>`_ (EAR), however, business operations may subject you to other regulations such as the `International Traffic in Arms Regulations <https://www.pmddtc.state.gov/regulations_laws?id=ddtc_kb_article_page&sys_id=24d528fddbfc930044f9ff621f961987>`_.
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 <https://www.pmddtc.state.gov/regulations_laws?id=ddtc_kb_article_page&sys_id=24d528fddbfc930044f9ff621f961987>`_.

General information
~~~~~~~~~~~~~~~~~~~~
Expand All @@ -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 <https://www.bis.doc.gov/index.php/forms-documents/regulations-docs/federal-register-notices/federal-register-2014/1063-746-1/file>`_ and `OFAC <https://ofac.treasury.gov/>`_. The countries and their sanctions are subject to change.
located at `BIS <https://www.bis.gov/>`_. 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 <https://www.bis.doc.gov/index.php/documents/regulation-docs/413-part-736-general-prohibitions/file>`_ of weapons of mass destruction, along with other prohibited end-uses under the U.S. Export Administration Regulations (“EAR”).
Expand Down
5 changes: 5 additions & 0 deletions source/about/deprecated-features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
1 change: 1 addition & 0 deletions source/about/mattermost-server-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <release-v10.4-feature-release>` | 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 <release-v10.3-feature-release>` | 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 <release-v10.2-feature-release>` | 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 <release-v10.1-feature-release>` | 2024-10-16 | 2025-01-15 |
Expand Down
78 changes: 78 additions & 0 deletions source/about/mattermost-v10-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion source/about/unsupported-legacy-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 8 additions & 0 deletions source/collaborate/channel-naming-conventions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------
Expand Down
2 changes: 1 addition & 1 deletion source/collaborate/learn-about-roles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------
Expand Down
4 changes: 2 additions & 2 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
11 changes: 9 additions & 2 deletions source/configure/authentication-configuration-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`__
Expand All @@ -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 <https://stedolan.github.io/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
Expand Down
Loading
Loading