diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml index d5a3819af72..188ee57ad73 100644 --- a/.github/workflows/cd.yml +++ b/.github/workflows/cd.yml @@ -1,30 +1,33 @@ name: CD + on: workflow_run: - workflows: ["CI"] + workflows: + - CI types: - completed - branches: ["master"] -permissions: - contents: read + branches: + - master + jobs: s3-release-prod: runs-on: ubuntu-latest steps: + - name: cd/Download artifacts + uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 + with: + run-id: ${{ github.event.workflow_run.id }} + github-token: ${{ github.token }} + name: docs + path: build/html + - name: cd/Configure AWS - uses: aws-actions/configure-aws-credentials@07c2f971bac433df982ccc261983ae443861db49 # v1-node16 + uses: aws-actions/configure-aws-credentials@e3dd6a429d7300a6a4c196c26e071d42e0343502 # v4.0.2 with: aws-region: us-east-1 aws-access-key-id: ${{ secrets.DOCS_BUILDS_BUCKET_AWS_ACCESS_KEY_ID }} aws-secret-access-key: ${{ secrets.DOCS_BUILDS_BUCKET_AWS_SECRET_ACCESS_KEY }} - - name: cd/Download artifacts - uses: dawidd6/action-download-artifact@0c49384d39ceb023b8040f480a25596fd6cf441b # v2.26.0 - with: - workflow: ${{ github.event.workflow_run.workflow_id }} - run_id: ${{ github.event.workflow_run.id }} - workflow_conclusion: success - name: docs - path: build/html + - name: cd/Upload artifacts to S3 run: | - aws s3 sync build/html s3://docs.mattermost.com/ --delete --cache-control no-cache --acl public-read --no-progress + aws s3 sync build/html s3://docs.mattermost.com/ --delete --cache-control no-cache --acl public-read --no-progress diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 73ebf185a97..c024db35773 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -12,23 +12,33 @@ jobs: runs-on: ubuntu-latest steps: - name: ci/Checkout code - uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0 - - uses: actions/setup-python@db9987b4c1f10f0404fa60ee629f675fafbd6763 # v4.6.0 + uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1 + + - uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0 with: - python-version: 3.9 + python-version: 3.12 + - name: ci/Install dependencies run: make python-deps + - name: ci/Run tests - run: TZ=UTC make test + env: + TZ: UTC + run: make test + - name: ci/Build docs - run: TZ=UTC make html + env: + TZ: UTC + run: make html + - name: ci/Persist docs artifacts - uses: actions/upload-artifact@65d862660abb392b8c4a3d1195a2108db131dd05 # v3.1.2 + uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3 with: name: docs path: build/html + - name: ci/Persist doc logs artifacts - uses: actions/upload-artifact@65d862660abb392b8c4a3d1195a2108db131dd05 # v3.1.2 + uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3 with: name: doc-logs path: build/*.log diff --git a/.github/workflows/preview-env-template.yml b/.github/workflows/preview-env-template.yml index 1f28a20ff95..33618082c21 100644 --- a/.github/workflows/preview-env-template.yml +++ b/.github/workflows/preview-env-template.yml @@ -26,13 +26,10 @@ jobs: - name: Setup Python uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0 with: - python-version: "3.9" + python-version: 3.12 - - name: Install pipenv - run: pip install pipenv - - - name: Install dependencies - run: pipenv install --dev + - name: ci/Install dependencies + run: make python-deps - name: Build run: make SPHINXOPTS="-j auto -D html_baseurl=http://mattermost-docs-preview-pulls.s3-website-us-east-1.amazonaws.com/${{ inputs.PR_NUMBER }}" html @@ -42,7 +39,7 @@ jobs: with: aws_key_id: ${{ secrets.AWS_KEY_ID }} aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} - aws_bucket: ${{ secrets.AWS_BUCKET }} + aws_bucket: mattermost-docs-preview-pulls source_dir: ./build/html destination_dir: ${{ inputs.PR_NUMBER }} diff --git a/.gitignore b/.gitignore index 820fb675a36..fcda51943ec 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,8 @@ logs node_modules dist npm-debug.log - +.venv +extensions/**/__pycache__/ web/static/js/bundle*.js web/static/js/libs*.js model/version.go diff --git a/Makefile b/Makefile index b8957d64d5c..cdf337203bb 100644 --- a/Makefile +++ b/Makefile @@ -35,8 +35,8 @@ endif # Install necessary dependencies for the CI build pipeline. # NOTE: if the version of Python used to build the docs changes, update the `pipenv` command below accordingly. python-deps: - pip install pipenv==2023.11.15 - pipenv install --dev --clear --deploy --python 3.9 + pip install pipenv==2024.1.0 + pipenv install --dev --clear --deploy --python 3.12 test: pipenv run pytest diff --git a/source/_static/images/azure/aks-cluster.png b/source/_static/images/azure/aks-cluster.png new file mode 100644 index 00000000000..b06547a5398 Binary files /dev/null and b/source/_static/images/azure/aks-cluster.png differ diff --git a/source/_static/images/azure/basics.png b/source/_static/images/azure/basics.png new file mode 100644 index 00000000000..64c923f6e24 Binary files /dev/null and b/source/_static/images/azure/basics.png differ diff --git a/source/_static/images/azure/deployment-details.png b/source/_static/images/azure/deployment-details.png new file mode 100644 index 00000000000..201fe958b1f Binary files /dev/null and b/source/_static/images/azure/deployment-details.png differ diff --git a/source/_static/images/azure/networking-details.png b/source/_static/images/azure/networking-details.png new file mode 100644 index 00000000000..4af893f634d Binary files /dev/null and b/source/_static/images/azure/networking-details.png differ diff --git a/source/_static/images/azure/postgreSQL.png b/source/_static/images/azure/postgreSQL.png new file mode 100644 index 00000000000..79e3583f3c2 Binary files /dev/null and b/source/_static/images/azure/postgreSQL.png differ diff --git a/source/about/cloud-dedicated.rst b/source/about/cloud-dedicated.rst index b08205c5bbc..983a4ab726a 100644 --- a/source/about/cloud-dedicated.rst +++ b/source/about/cloud-dedicated.rst @@ -52,7 +52,7 @@ Mattermost offers advanced security and authentication options for integrating w Secure networking ~~~~~~~~~~~~~~~~~~ -Mattermost Cloud Dedicated supports :doc:`IP filtering ` through CIDR-based IP ranges, providing flexibility for system administrators to include various authorized IPs or IP ranges for seamless access control. Users attempting to access the workspace from IPs outside defined ranges are restricted from entry. Cloud system admins can :ref:`configure IP filtering ` through their Mattermost System Console. +Mattermost Cloud Dedicated supports :doc:`IP filtering ` through CIDR-based IP ranges, providing flexibility for system administrators to include various authorized IPs or IP ranges for seamless access control. Users attempting to access their :doc:`workspace ` from IPs outside defined ranges are restricted from entry. Cloud system admins can :ref:`configure IP filtering ` through their Mattermost System Console. Encryption ~~~~~~~~~~~ @@ -70,7 +70,7 @@ Connections to calls are secured with a combination of: Cloud native exports ~~~~~~~~~~~~~~~~~~~~ -Mattermost supports optional :ref:`filestore configuration settings ` to direct compliance and bulk export data to a separate S3 bucket from standard files. This separate bucket can be configured to allow for secure access by Mattermost Cloud teams as well as the workspace admins who manage a given installation. The exports can also be accessed by generating unique download links as needed. +Mattermost supports optional :ref:`filestore configuration settings ` to direct compliance and bulk export data to a separate S3 bucket from standard files. This separate bucket can be configured to allow for secure access by Mattermost Cloud teams as well as admins who manage a given Mattermost deployment. The exports can also be accessed by generating unique download links as needed. The following diagram provides a high-level view of how this functionality works: @@ -98,4 +98,4 @@ Approved plugins developed and/or tested by Mattermost are supported and availab Migrate from a self-hosted instance ------------------------------------ -See our :ref:`workspace migration ` documentation to learn more about migrating from a self-hosted to a Mattermost Cloud instance. \ No newline at end of file +See our :ref:`self-hosted to cloud migration ` documentation to learn more about migrating from a self-hosted to a Mattermost Cloud instance. \ No newline at end of file diff --git a/source/about/cloud-shared.rst b/source/about/cloud-shared.rst index 3d14265583c..8b9891a5fc6 100644 --- a/source/about/cloud-shared.rst +++ b/source/about/cloud-shared.rst @@ -6,7 +6,7 @@ Cloud Shared Mattermost Cloud Shared is designed as a cost-effective solution for companies who don't have strict security and compliance requirements that need a straightforward, managed communication platform without the necessity for extensive customization or dedicated resources. -Your Mattermost workspace is isolated, is fully hosted and managed by Mattermost, and runs :ref:`Mattermost Enterprise ` on shared infrastructure where resources are shared among multiple Mattermost customers, which might affect performance during peak times. +Your Mattermost deployment is isolated, is fully hosted and managed by Mattermost, and runs :ref:`Mattermost Enterprise ` on shared infrastructure where resources are shared among multiple Mattermost customers, which might affect performance during peak times. Reference architecture ---------------------- @@ -52,7 +52,7 @@ Mattermost offers advanced security and authentication options for integrating w Secure networking ~~~~~~~~~~~~~~~~~~ -Enterprise customers with a Mattermost Cloud Shared deployment can :ref:`configure IP filtering ` through CIDR-based IP ranges, within the Mattermost System Console to specify authorized IPs or IP ranges for seamless access control. Users attempting to access the workspace from IPs outside defined ranges are restricted from entry. +Enterprise customers with a Mattermost Cloud Shared deployment can :ref:`configure IP filtering ` through CIDR-based IP ranges, within the Mattermost System Console to specify authorized IPs or IP ranges for seamless access control. Users attempting to access their :doc:`workspace ` from IPs outside defined ranges are restricted from entry. Encryption ~~~~~~~~~~~ @@ -70,7 +70,7 @@ Connections to calls are secured with a combination of: Cloud native exports ~~~~~~~~~~~~~~~~~~~~ -Mattermost supports optional :ref:`filestore configuration settings ` to direct compliance and bulk export data to a separate S3 bucket from standard files. This separate bucket can be configured to allow for secure access by Mattermost Cloud teams as well as the workspace admins who manage a given installation. The exports can also be accessed by generating unique download links as needed. +Mattermost supports optional :ref:`filestore configuration settings ` to direct compliance and bulk export data to a separate S3 bucket from standard files. This separate bucket can be configured to allow for secure access by Mattermost Cloud teams as well as deployment admins who manage a given installation. The exports can also be accessed by generating unique download links as needed. The following diagram provides a high-level view of how this functionality works: @@ -100,4 +100,4 @@ Custom plugins and integrations outside of Mattermost Marketplace aren’t curre Migrate from a self-hosted instance ------------------------------------ -See our :ref:`workspace migration ` documentation to learn more about migrating from a self-hosted to a Mattermost Cloud instance. \ No newline at end of file +See our :ref:`self-hosted to cloud migration ` documentation to learn more about migrating from a self-hosted to a Mattermost Cloud instance. \ No newline at end of file diff --git a/source/about/cloud-subscriptions.rst b/source/about/cloud-subscriptions.rst index d2511c328dd..8e69a12a91c 100644 --- a/source/about/cloud-subscriptions.rst +++ b/source/about/cloud-subscriptions.rst @@ -13,7 +13,7 @@ Cloud subscriptions Cloud Shared Cloud VPC Private Connectivity -Mattermost offers secure, cloud-based collaboration for fast moving enterprises that’s private, scaleable, and low maintenance. Cloud-native architecture supports organizations of any size for a workspace that scales with your team, without any resource planning. +Mattermost offers secure, cloud-based collaboration for fast moving enterprises that’s private, scaleable, and low maintenance. Cloud-native architecture supports organizations of any size for a deployment that scales with your team, without any resource planning. Enterprises can choose between dedicated and shared infrastructure based on your organizations’ size, budget, technical requirements, and level of control and customization needed: diff --git a/source/about/cloud-vpc-private-connectivity.rst b/source/about/cloud-vpc-private-connectivity.rst index ff39e36ad8c..4aab2d7d339 100644 --- a/source/about/cloud-vpc-private-connectivity.rst +++ b/source/about/cloud-vpc-private-connectivity.rst @@ -4,13 +4,13 @@ Cloud VPC Private Connectivity .. include:: ../_static/badges/ent-cloud-only.rst :start-after: :nosearch: -Virtual Private Cloud (VPC) Private Connectivity (Private Link) offers Enterprise Cloud customers tailored solutions for private connectivity needs with Mattermost Cloud. These options enable customers to access Mattermost Cloud through AWS's network without using the public internet, or allow the Mattermost Infrastructure team to manage a Mattermost workspace hosted in the customer's VPC via an EKS cluster. +Virtual Private Cloud (VPC) Private Connectivity (Private Link) offers Enterprise Cloud customers tailored solutions for private connectivity needs with Mattermost Cloud. These options enable customers to access Mattermost Cloud through AWS's network without using the public internet, or allow the Mattermost Infrastructure team to manage a Mattermost instance hosted in the customer's VPC via an EKS cluster. It also provides the ability for customers to connect from Mattermost Cloud to their private webhooks,endpoints and integrations. The key objectives of this offering are to: - Allow customers to access Mattermost Cloud within their internal network. -- Enable the Mattermost Infrastructure team to perform operations on a Mattermost workspace hosted in the customer’s VPC, upon request. +- Enable the Mattermost Infrastructure team to perform operations on a Mattermost instance hosted in the customer’s VPC, upon request. - Establish connectivity between the customer's VPC and Mattermost exclusively through AWS’s network, without exposure to the public internet. - Ensure the setup process is straightforward and easy to implement. - Adhere to all security best practices. diff --git a/source/about/editions-and-offerings.rst b/source/about/editions-and-offerings.rst index 01cb18861a9..562af6310fa 100644 --- a/source/about/editions-and-offerings.rst +++ b/source/about/editions-and-offerings.rst @@ -127,7 +127,7 @@ Features include: - Teams and channels for one-to-one and group messaging, file sharing, and unlimited search history with threaded messaging, emoji, and custom emoji. - Native apps for iOS, Android, Windows, macOS, and Linux. -- Pre-packaged integrations with most common developer tools, including Jira, Confluence, GitHub, GitLab, CircleCI, Zoom, Jitsi, and more. +- Pre-packaged integrations with most common developer tools, including Jira, GitHub, GitLab, Zoom, and more. - Tools for :doc:`custom branding ` and :doc:`themes `. - :doc:`Multi-factor authentication `. - Single Sign-on with :doc:`GitLab ` using the OAuth 2.0 standard. diff --git a/source/about/faq-enterprise.rst b/source/about/faq-enterprise.rst index ef78d457409..06132115f40 100644 --- a/source/about/faq-enterprise.rst +++ b/source/about/faq-enterprise.rst @@ -49,7 +49,7 @@ Yes, Enterprises can inquire about `Mattermost Cloud Enterprise ` is available as a self-serve, multi-tenant, software-as-a-service offering, which can be purchased with a credit card at https://customers.mattermost.com/cloud/connect-workspace +For small businesses, :ref:`Mattermost Professional ` is available as a self-serve, multi-tenant, software-as-a-service offering. Do you offer special programs for non-profit organizations, open source projects, or educational institutions? ---------------------------------------------------------------------------------------------------------------- diff --git a/source/about/mattermost-mobile-releases.md b/source/about/mattermost-mobile-releases.md index bc837aef4a1..8fbb9ee01ac 100644 --- a/source/about/mattermost-mobile-releases.md +++ b/source/about/mattermost-mobile-releases.md @@ -18,7 +18,8 @@ See the [Mobile app changelog](/about/mobile-app-changelog) for release details, | **Release** | **Released on** | **Support ends** | **Compatible with** | |:---|:---|:---|:---| -| v2.20 {ref}`FEATURE ` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.20.1) \| {ref}`Changelog ` | 2024-09-16 | 2024-10-15 | {ref}`v10.0 `, {ref}`v9.11 `, {ref}`v9.10 `, {ref}`v9.9 `, {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 `, `v10.0 `, {ref}`v9.11 `, {ref}`v9.10 `, {ref}`v9.5 ` | +| v2.20 {ref}`FEATURE ` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.20.1) \| {ref}`Changelog ` | 2024-09-16 | 2024-10-15 | {ref}`v10.0 `, {ref}`v9.11 `, {ref}`v9.10 `, {ref}`v9.9 `, {ref}`v9.5 ` | | v2.19 {ref}`FEATURE ` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.19.2) \| {ref}`Changelog ` | 2024-08-16 | 2024-09-15 | {ref}`v9.11 `, {ref}`v9.10 `, {ref}`v9.9 `, {ref}`v9.8 `, {ref}`v9.5 ` | | v2.18 {ref}`FEATURE ` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.18.1) \| {ref}`Changelog ` | 2024-07-16 | 2024-08-15 | {ref}`v9.10 ` | | v2.17 {ref}`FEATURE ` [Download](https://github.com/mattermost/mattermost-mobile/releases/tag/v2.17.1) \| {ref}`Changelog ` | 2024-06-16 | 2024-07-15 | {ref}`v9.9 ` | diff --git a/source/about/mattermost-server-releases.md b/source/about/mattermost-server-releases.md index 6be17adae9d..0fa6b00d4c3 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.1 [Download](https://releases.mattermost.com/10.1.1/mattermost-10.1.1-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-10-16 | 2025-01-15 | | v10.0 [Download](https://releases.mattermost.com/10.0.1/mattermost-10.0.1-linux-amd64.tar.gz) \| {ref}`Changelog ` | 2024-09-16 | 2024-12-15 | | v9.11 [Download](https://releases.mattermost.com/9.11.3/mattermost-9.11.3-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 | diff --git a/source/about/mattermost-v10-changelog.md b/source/about/mattermost-v10-changelog.md index 40ad09a129d..0bad784488c 100644 --- a/source/about/mattermost-v10-changelog.md +++ b/source/about/mattermost-v10-changelog.md @@ -7,6 +7,83 @@ 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.1-feature-release)= +## Release v10.1 - [Feature Release](https://docs.mattermost.com/about/release-policy.html#release-types) + +- **10.1.1, released 2024-10-16** + - Fixed an issue where a shared indicator was shown in all Direct Messages, regardless of the user coming from a shared server [MM-60744](https://mattermost.atlassian.net/browse/MM-60744). + - Mattermost v10.1.1 contains no database or functional changes. +- **10.1.0, released 2024-10-16** + - Original 10.1.0 release. + +```{Important} +If you upgrade from a release earlier than v10.0, please read the other [Important Upgrade Notes](https://docs.mattermost.com/upgrade/important-upgrade-notes.html). +``` + +### Improvements + +#### User Interface (UI) + - Added Metrics plugin to the prepackaged plugins, [v0.5.3](https://github.com/mattermost/mattermost-plugin-metrics/releases/tag/v0.5.3). + - Pre-packaged Calls plugin [v1.1.0](https://github.com/mattermost/mattermost-plugin-calls/releases/tag/v1.1.0). + - Enabled Channel Bookmarks, added re-ordering, and fixed URL validity checking. + - Added a more descriptive error message, "Uploaded plugin size exceeds limit." for plugin uploads that are too large. + - Added channel specific message notification sounds configuration. + +#### Administration + - Added ``DeleteAt`` field for ``SharedChannelRemotes`` and ``RemoteClusters``. + - Added support for sending channel invites to offline remotes in Shared Channels. + - Changed server-side logic to return a ``413: Request Entity Too Large`` HTTP status code for a plugin upload that is too large. + - Direct and Group Message unread/read state over export and import will now be carried over. + - CRT memberships are now importable for import. + - CRT memberships are now exportable for bulk export. + - Added ``--local mode`` support in MMCTL to handle user preferences. + - Plugins are now allowed to mark setting fields as secret, obfuscating them in the System Console and the Support Packet. + +#### Performance + - Improved metrics related to push proxy errors. + - Improved metrics around notifications. + +### Bug Fixes + - Fixed an issue where threads would be marked as read if they were open in the background. + - Fixed an issue where Direct and Group Messages didn't load correctly in the sidebar when refreshing the app from Drafts. + - Fixed an issue attempting to bind to Apps plugin when the plugin was not enabled. + - Fixed an issue where the Unreads tab would not update correctly after the websocket reconnected. + - Fixed an issue with focusing on the main box when loading the app. + - Fixed an issue where Team and Channel Admins could lose the ability to create posts in a moderated channel. + - Fixed an issue where marking a channel as unread did not show immediately in other clients. + - Fixed an issue with not allowing to use ``@`` and ``~`` in the ``in:`` search modifier without affecting search results. + - Fixed an issue with YouTube previews no longer being displayed. + +### 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 ``ExperimentalSettings`` in ``config.json``: + - Added ``YoutubeReferrerPolicy`` to fix an issue where YouTube previews showed an “Video Unavailable” error instead of the video. + +#### Changes to the Enterprise plan: + - Under ``ConnectedWorkspacesSettings`` in ``config.json``: + - Added ``DisableSharedChannelsStatusSync`` to add status sync support to Shared Channels. + - Under ``ConnectedWorkspacesSettings`` in ``config.json``: + - Moved the Shared Channel related configuration properties out of the Experimental section. + - Added the ``MaxPostsPerSync`` configuration property. + +### API Changes + - Added new API endpoints to manage shared channels. + - Added proper response to ``/api/v4/client_perf`` endpoint. + +### Go Version + - v10.1 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. + - The Playbooks left-hand sidebar doesn't update when a user is added to a run or playbook without a refresh. + - If a user isn't a member of a configured broadcast channel, posting a status update might fail without any error feedback. As a temporary workaround, join the configured broadcast channels, or remove those channels from the run configuration. + +### Contributors + - [adityasoni2019](https://github.com/adityasoni2019), [agarciamontoro](https://github.com/agarciamontoro), [agnivade](https://github.com/agnivade), [algeorgiadis](https://github.com/algeorgiadis), [amyblais](https://github.com/amyblais), [andreabia](https://translate.mattermost.com/user/andreabia), [andrleite](https://github.com/andrleite), [angeloskyratzakos](https://github.com/angeloskyratzakos), [armmanvaillancourt](https://github.com/armmanvaillancourt), [Aryakoste](https://github.com/Aryakoste), [ayusht2810](https://github.com/ayusht2810), [azistellar](https://translate.mattermost.com/user/azistellar), [azizthegit](https://github.com/azizthegit), [BenCookie95](https://github.com/BenCookie95), [calebroseland](https://github.com/calebroseland), [catalintomai](https://github.com/catalintomai), [ChinoUkaegbu](https://github.com/ChinoUkaegbu), [Chlbek](https://translate.mattermost.com/user/Chlbek), [crspeller](https://github.com/crspeller), [ctlaltdieliet](https://translate.mattermost.com/user/ctlaltdieliet), [cwarnermm](https://github.com/cwarnermm), [danielsischy](https://github.com/danielsischy), [daveseo901](https://github.com/daveseo901), [devinbinnie](https://github.com/devinbinnie), [DHaussermann](https://github.com/DHaussermann), [Eleferen](https://translate.mattermost.com/user/Eleferen), [emdecr](https://github.com/emdecr), [enahum](https://github.com/enahum), [enzowritescode](https://github.com/enzowritescode), [esarafianou](https://github.com/esarafianou), [esethna](https://github.com/esethna), [fmartingr](https://github.com/fmartingr), [frankps](https://translate.mattermost.com/user/frankps), [fsilye](https://github.com/fsilye), [gabrieljackson](https://github.com/gabrieljackson), [Gesare5](https://github.com/Gesare5), [Glandos](https://github.com/Glandos), [grundleborg](https://github.com/grundleborg), [gvarma28](https://github.com/gvarma28), [hanzei](https://github.com/hanzei), [harshilsharma63](https://github.com/harshilsharma63), [hereje](https://github.com/hereje), [hmhealey](https://github.com/hmhealey), [ifoukarakis](https://github.com/ifoukarakis), [isacikgoz](https://github.com/isacikgoz), [ja49619](https://translate.mattermost.com/user/ja49619), [johnsonbrothers](https://github.com/johnsonbrothers), [jones](https://translate.mattermost.com/user/jones), [jprusch](https://github.com/jprusch), [JulienTant](https://github.com/JulienTant), [jwilander](https://github.com/jwilander), [kaakaa](https://github.com/kaakaa), [kaoski](https://github.com/kaoski), [kayazeren](https://github.com/kayazeren), [Kshitij-Katiyar](https://github.com/Kshitij-Katiyar), [L3o-pold](https://github.com/L3o-pold), [larkox](https://github.com/larkox), [lieut-data](https://github.com/lieut-data), [lindalumitchell](https://github.com/lindalumitchell), [lukasMega](https://github.com/lukasMega), [M-ZubairAhmed](https://github.com/M-ZubairAhmed), [majo](https://translate.mattermost.com/user/majo), [manujgrover71](https://github.com/manujgrover71), [master7](https://translate.mattermost.com/user/master7), [matt-w99](https://github.com/matt-w99), [matthew-w](https://translate.mattermost.com/user/matthew-w), [matthewbirtch](https://github.com/matthewbirtch), [mgdelacroix](https://github.com/mgdelacroix), [milotype](https://translate.mattermost.com/user/milotype), [Morgan_svk](https://translate.mattermost.com/user/Morgan_svk), [Movion](https://github.com/Movion), [mvitale1989](https://github.com/mvitale1989), [nekodayo2222](https://translate.mattermost.com/user/nekodayo2222), [nickmisasi](https://github.com/nickmisasi), [nikhilskul7](https://github.com/nikhilskul7), [Porma120](https://github.com/Porma120), [pvev](https://github.com/pvev), [raghavaggarwal2308](https://github.com/raghavaggarwal2308), [rahimrahman](https://github.com/rahimrahman), [Rajat-Dabade](https://github.com/Rajat-Dabade), [Rishiii7](https://github.com/Rishiii7), [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), [stylianosrigas](https://github.com/stylianosrigas), [testtomato1230](https://translate.mattermost.com/user/testtomato1230), [TheInvincibleRalph](https://github.com/TheInvincibleRalph), [ThrRip](https://translate.mattermost.com/user/ThrRip), [toninis](https://github.com/toninis), [tsabi](https://github.com/tsabi), [vish9812](https://github.com/vish9812), [wiggin77](https://github.com/wiggin77), [Willyfrog](https://github.com/Willyfrog), [yasserfaraazkhan](https://github.com/yasserfaraazkhan), [yaz](https://translate.mattermost.com/user/yaz), [yuney-worx4you](https://github.com/yuney-worx4you) + (release-v10.0-major-release)= ## Release v10.0 - [Major Release](https://docs.mattermost.com/about/release-policy.html#release-types) diff --git a/source/about/mobile-app-changelog.md b/source/about/mobile-app-changelog.md index eec9aa84cdd..405a3a35ae2 100644 --- a/source/about/mobile-app-changelog.md +++ b/source/about/mobile-app-changelog.md @@ -5,6 +5,28 @@ This changelog summarizes updates to Mattermost mobile apps releases for [Mattermost](https://mattermost.com). +(release-v2-21-0)= +## 2.21.0 Release + - Release Date: October 16, 2024 + - Server Versions Supported: Server v9.5.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.5.0 or later is required.** Support for server [Extended Support Release](https://docs.mattermost.com/upgrade/extended-support-release.html) (ESR) v8.1.0 has ended and upgrading to server ESR v9.5.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+ is required. + +### Improvements + - Removed unneeded permissions on Android. + - Improved metrics around notifications. + +### Bug Fixes + - Fixed an issue with handling of malformed Markdown tables. + - Fixed an issue where Calls buttons and actions were not hidden if the plugin was disabled. + +### 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-20-1)= ## 2.20.1 Release - Release Date: October 9, 2024 diff --git a/source/about/version-archive.rst b/source/about/version-archive.rst index 85adf47b294..81fa22a432d 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.1.1 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.1.1/mattermost-10.1.1-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``aaeb49e8891780ff20ac5a09fe3ee624145404fc4dda72a5174e85cb2744ffa6`` + - GPG Signature: https://releases.mattermost.com/10.1.1/mattermost-10.1.1-linux-amd64.tar.gz.sig Mattermost Enterprise Edition v10.0.1 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/10.0.1/mattermost-10.0.1-linux-amd64.tar.gz`` - SHA-256 Checksum: ``c0e8242168968bf7c9dce0c5a3a372183d1056eb6d92cd095e812b0e28bca761`` @@ -383,6 +387,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.1.1 - `View Changelog `__ - `Download `__ + - ``https://releases.mattermost.com/10.1.1/mattermost-team-10.1.1-linux-amd64.tar.gz`` + - SHA-256 Checksum: ``5b08c9685950b22611d56d0a0e77b25d0d57f201a54cc2a8b7148608d5f048af`` + - GPG Signature: https://releases.mattermost.com/10.1.1/mattermost-team-10.1.1-linux-amd64.tar.gz.sig Mattermost Team Edition v10.0.1 - `View Changelog `__ - `Download `__ - ``https://releases.mattermost.com/10.0.1/mattermost-team-10.0.1-linux-amd64.tar.gz`` - SHA-256 Checksum: ``932090fd6fbc44e33ddcdc57f89fe1048c3a1d486de3b0395839aef47a182b77`` diff --git a/source/collaborate/access-your-workspace.rst b/source/collaborate/access-your-workspace.rst index cde1e7a0228..618ad357151 100644 --- a/source/collaborate/access-your-workspace.rst +++ b/source/collaborate/access-your-workspace.rst @@ -4,7 +4,7 @@ Access your workspace .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -Mattermost is accessible through a URL link. You'll receive a link from your Mattermost system admin or through an email invitation. You can use that link in a web browser, or as a server connection in the :doc:`desktop app `, the :doc:`mobile app for iOS `, or the :doc:`mobile app for Android `. +Your Mattermost :doc:`workspace ` is accessible through a URL link. You'll receive a link from your Mattermost system admin or through an email invitation. You can use that link in a web browser, or as a server connection in the :doc:`desktop app `, the :doc:`mobile app for iOS `, or the :doc:`mobile app for Android `. .. tip:: diff --git a/source/collaborate/built-in-slash-commands.rst b/source/collaborate/built-in-slash-commands.rst index 18f2bf3aef7..8a4117f641c 100644 --- a/source/collaborate/built-in-slash-commands.rst +++ b/source/collaborate/built-in-slash-commands.rst @@ -9,7 +9,7 @@ You can interact with Mattermost users, channels, conversations, and more using Slash commands -------------- -The following built-in slash comamnds are available in your Mattermost workspace. +The following built-in slash comamnds are available in your Mattermost :doc:`workspace `. .. tip:: diff --git a/source/collaborate/collaborate-with-audio-video.rst b/source/collaborate/collaborate-with-audio-video.rst new file mode 100644 index 00000000000..1ce320c0f3c --- /dev/null +++ b/source/collaborate/collaborate-with-audio-video.rst @@ -0,0 +1,85 @@ +Collaborate with audio and video +================================ + +Mattermost offers native real-time chat, self-hosted audio calls, and screen sharing within your own network, enabling secure, effective team communication and collaboration. + +For video conferencing, Mattermost integrates seamlessly with leading providers, giving users the flexibility to easily transition from chat to video: + +- **Pexip**: An enterprise-grade video conferencing solution with advanced security features, tailored for secure and scalable video collaboration. +- :doc:`Zoom `: A widely used, cloud-based video conferencing platform known for its ease of use and wide range of collaboration tools, including screen sharing and breakout rooms. +- `Webex `_: A comprehensive video conferencing solution designed for enterprise-grade security, offering features like file sharing, virtual backgrounds, and meeting recordings. +- :doc:`Microsoft Teams `: A cloud-based collaboration platform that integrates with Microsoft 365, with text, voice, video, and file-sharing features. + +With always-online calls and screen sharing, Mattermost ensures that communications remain uninterrupted, even during maintenance or outages, and scales effortlessly to meet your team’s growing needs, safeguarding the integrity of mission-critical operations. + +Conference call plan comparison +------------------------------- + +The following chart outlines the various conferencing features supported across Mattermost plans, including on mobile devices: + ++---------------------------------+----------+------------------+----------------+ +| **Mattermost Calls** | **Free** | **Professional** | **Enterprise** | ++=================================+==========+==================+================+ +| 1:1 audio call | X | X | X | ++---------------------------------+----------+------------------+----------------+ +| Audio conference call | | X | X | ++---------------------------------+----------+------------------+----------------+ +| Screen share | X | X | X | ++---------------------------------+----------+------------------+----------------+ +| Chat/messaging during calls | X | X | X | ++---------------------------------+----------+------------------+----------------+ +| Search chat history post-call | X | X | X | ++---------------------------------+----------+------------------+----------------+ +| Host controls | | X | X | ++---------------------------------+----------+------------------+----------------+ +| Call recording | | | X | ++---------------------------------+----------+------------------+----------------+ +| Call transcription | | | X | ++---------------------------------+----------+------------------+----------------+ +| Live captioning | | | X | ++---------------------------------+----------+------------------+----------------+ +| AI call summarization | | | X | ++---------------------------------+----------+------------------+----------------+ +| Advanced security controls | | | X | ++---------------------------------+----------+------------------+----------------+ +| Redundancy | | | X | ++---------------------------------+----------+------------------+----------------+ +| Scaleable calls and screenshare | | | X | ++---------------------------------+----------+------------------+----------------+ + +Conference call provider comparison +----------------------------------- + +Here’s a breakdown of the conference call features supported across the available call providers on Mattermost: + ++--------------------------------+-----------+----------+--------------+-----------+ +| **Feature** | **Pexip** | **Zoom** | **Microsoft | **Webex** | +| | | | Teams** | | ++================================+===========+==========+==============+===========+ +| Video conferencing | X | X | X | X | ++--------------------------------+-----------+----------+--------------+-----------+ +| Audio conferencing | X | X | X | X | ++--------------------------------+-----------+----------+--------------+-----------+ +| Screen share | X | X | X | X | ++--------------------------------+-----------+----------+--------------+-----------+ +| Chat/messaging during calls | X | X | X | X | ++--------------------------------+-----------+----------+--------------+-----------+ +| Cloud recording calls | X | X | X | X | ++--------------------------------+-----------+----------+--------------+-----------+ +| Self-hosted video meetings | X | | | X | ++--------------------------------+-----------+----------+--------------+-----------+ +| On-premise recording calls | X | | | X | ++--------------------------------+-----------+----------+--------------+-----------+ +| Virtual backgrounds | X | X | X | X | ++--------------------------------+-----------+----------+--------------+-----------+ +| Custom layouts for video calls | X | X | X | X | ++--------------------------------+-----------+----------+--------------+-----------+ +| End-to-end encryption | X | X | X | X | ++--------------------------------+-----------+----------+--------------+-----------+ +| SIP support | X | X | X | X | ++--------------------------------+-----------+----------+--------------+-----------+ + +.. note:: + + - Webex is community supported and not maintained by Mattermost. Please see the `GitHub repository `_ for the latest releases and documentation. + - Community supported integrations are not available to Cloud deployments of Mattermost. \ No newline at end of file diff --git a/source/collaborate/collaborate-within-channels.rst b/source/collaborate/collaborate-within-channels.rst index 367bcebb680..671448e1022 100644 --- a/source/collaborate/collaborate-within-channels.rst +++ b/source/collaborate/collaborate-within-channels.rst @@ -9,7 +9,7 @@ Channels are where you connect, collaborate, and communicate with your team abou You're added to default channels automatically ---------------------------------------------- -Everyone who joins a Mattermost workspace is automatically added to two default public channels: **Town Square** and **Off-Topic**. See our :doc:`Channel Types ` documentation for details. +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. @@ -51,6 +51,7 @@ Learn more about collaborating within Mattermost channels: Browse channels Navigate between channels Mark channels as favorites + Manage channel bookmarks Mark channels as unread Archive and unarchive channels @@ -67,5 +68,6 @@ Learn more about collaborating within Mattermost channels: * :doc:`Convert group messages to private channels ` - Learn how to convert group messages to private channels. * :doc:`Manage channel members ` - Add and remove users from channels. * :doc:`Mark channels as favorites ` - Mark commonly visited channels as favorites. +* :doc:`Manage channel bookmarks ` - Manage quick access links or files pinned to the top of channels. * :doc:`Mark channels as unread ` - Mark channels unread to return to messages later. * :doc:`Archive and unarchive channels ` - Keep the number of available channels manageable. \ No newline at end of file diff --git a/source/collaborate/extend-mattermost-with-integrations.rst b/source/collaborate/extend-mattermost-with-integrations.rst index 0a3560e9ae0..f555aa546c3 100644 --- a/source/collaborate/extend-mattermost-with-integrations.rst +++ b/source/collaborate/extend-mattermost-with-integrations.rst @@ -6,7 +6,7 @@ Ensure your teams are are always informed about important events, status changes Interoperability with pre-packaged integrations ------------------------------------------------ -The following pre-packaged feature & interoperability integrations are available for your Mattermost system admin to enable and configure for you to use. +Your system admin can install the following pre-packaged integrations through the Mattermost Marketplace, and enable and configure them in the Mattermost System Console. Mattermost features ~~~~~~~~~~~~~~~~~~~~ diff --git a/source/collaborate/invite-people.rst b/source/collaborate/invite-people.rst index 90677909a62..6eab01c3b3d 100644 --- a/source/collaborate/invite-people.rst +++ b/source/collaborate/invite-people.rst @@ -4,11 +4,11 @@ Add people to your workspace .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -Getting people set up with a Mattermost account is typically something that admins do when deploying and configuring the Mattermost workspace. However, :ref:`team admins ` can also invite people, including :doc:`guests `, to a Mattermost team via a `direct invite <#send-a-direct-invite>`__, a `public team invite link <#send-a-team-invite-link>`__. +Getting people set up with a Mattermost account is typically something that system admins do when deploying and configuring the Mattermost instance. However, :ref:`team admins ` can also invite people, including :doc:`guests `, to a Mattermost team via a `direct invite <#send-a-direct-invite>`__, a `public team invite link <#send-a-team-invite-link>`__. All users can add existing Mattermost users to a Mattermost team or channel, unless the system admin has restricted the ability for you to do so. -- Inviting people to a team sends an email prompting recipients to create a Mattermost account on your Mattermost workspace. +- Inviting people to a team sends an email prompting recipients to create a Mattermost account on your Mattermost :doc:`workspace `. - Adding an existing user to a team or to a channel makes those users team or channel members. .. tip:: diff --git a/source/collaborate/learn-about-roles.rst b/source/collaborate/learn-about-roles.rst index 19c3107cf3e..ed4e5cc74de 100644 --- a/source/collaborate/learn-about-roles.rst +++ b/source/collaborate/learn-about-roles.rst @@ -58,12 +58,12 @@ The person who creates a channel is assigned the channel admin role for that cha - Ability to remove members from the channel. - Ability to configure channel actions that automate tasks based on trigger conditions, such as :ref:`joining a channel ` or :doc:`sending a message ` in a channel. -Depending on your system configuration, channel admins can be granted special permissions by the system admin to rename and delete channels. +Depending on your system configuration, channel admins can be granted special permissions by the system admin to rename and delete channels. Member ------ -This is the default role given to users when they join a team. Members have basic permissions on a Mattermost team. +This is the default role given to users when they join a team. Members have basic permissions on a Mattermost team. See the :doc:`advanced permissions backend infrastructure ` documentation for details. Guest ----- diff --git a/source/collaborate/manage-channel-bookmarks.rst b/source/collaborate/manage-channel-bookmarks.rst new file mode 100644 index 00000000000..1be8b4a5cef --- /dev/null +++ b/source/collaborate/manage-channel-bookmarks.rst @@ -0,0 +1,116 @@ +Manage channel bookmarks +========================= + +.. include:: ../_static/badges/ent-pro-cloud-selfhosted.rst + :start-after: :nosearch: + +You can bookmark up to 50 links or files to the top of channels for quick and easy access, unless your system admin has disabled your ability to do so. Bookmarked links and files display in the bookmarks bar located directly below the channel header. + +.. tip:: + + Any file added as a channel bookmark is also searchable in Mattermost. + +Open a bookmark +--------------- + +Opening a channel bookmark works the same way as selecting a file link or attachment in a message. Select or tap a bookmark to view the file or link. + +Add a bookmark +-------------- + +.. tab:: Web/Desktop + + 1. In the bookmarks bar, select **Add a bookmark**. + + .. image:: ../images/desktop-bookmark-add.png + :alt: Using a web browser or the desktop app, select the Plus icon to add a channel bookmark. + :scale: 50 + + - Select **Add a link** to specify the link URL, specify bookmark text, and an optional bookmark icon. + - Select **Add a file** to select a file, specify bookmark text, and an optional bookmark icon. + + .. image:: ../images/desktop-bookmark-add-choice.png + :alt: Using a web browser or the desktop app, choose whether to add a link or a file. + :scale: 50 + +.. tab:: Mobile + + The bookmarks bar is hidden by default when a channel has no bookmarks. + + 1. Select the **More** |more-icon| icon and select **View info**, and **Add a bookmark** to add the first bookmark. For subsequent bookmarks, select the **Plus** |plus| icon in the bookmarks bar. + + .. image:: ../images/mobile-bookmark-add.png + :alt: Using the mobile app, go to the channel view info screen to add a bookmark for the first time. + :scale: 50 + + - Select **Add a link** to specify the link URL, specify bookmark text, and an optional bookmark icon. + - Select **Add a file** to select a file, specify bookmark text, and an optional bookmark icon. + + .. image:: ../images/mobile-bookmark-add-choice.png + :alt: Using the mobile app, choose whether to add a link or a file. + :scale: 50 + + .. image:: ../images/mobile-bookmark-add-details.png + :alt: Using the mobile app, specify the link or file, bookmark text, and an optional bookmark icon. + :scale: 50 + + 2. Select **Add bookmark**. + +Manage bookmarks +---------------- + +You can `edit <#edit-bookmarks>`__ and `delete <#delete-bookmarks>`__ bookmarks, as well as `copy bookmark links <#copy-bookmark-links>`__. Additionally, web and desktop users can `reorder bookmarks <#reorder-bookmarks>`__, and mobile users can `share bookmarks <#share-bookmarks>`__. Changes to bookmarks are visible to all channel members. + +Reorder bookmarks +^^^^^^^^^^^^^^^^^ + +Using Mattermost in a web browser or the desktop app, drag bookmarks to reorder them in the bookmarks bar. Reordering channel bookmarks changes the display order for all channel members. + +.. note:: + + You can't reorder channel bookmarks using the mobile app. + +Edit bookmarks +^^^^^^^^^^^^^^^ + +You can make changes to the bookmark link or file, the bookmark title, or the optional bookmark icon. Editing a bookmark changes the bookmark for all channel members. + +.. tab:: Web/Desktop + + Select the **More** |more-icon| icon next to a bookmark and select **Edit**. + +.. tab:: Mobile + + Long-press on a bookmark and select **Edit**. + +Share bookmarks +^^^^^^^^^^^^^^^^ + +Using the mobile app, long-press on a bookmark and select **Share**. + +Copy bookmark links +^^^^^^^^^^^^^^^^^^^^ + +You can copy bookmark links when your system admin has :ref:`enabled your ability to do so `. + +.. tab:: Web/Desktop + + Select the **More** |more-icon| icon next to a bookmark and select **Copy link**. + +.. tab:: Mobile + + Long-press on a bookmark and select **Copy link**. + +Delete bookmarks +^^^^^^^^^^^^^^^^^ + +Deleting a channel bookmark deletes it for all channel members. + +.. tab:: Web/Mobile + + Select the **More** |more-icon| icon next to a bookmark and select **Delete**. + +.. tab:: Mobile + + Long-press on a bookmark and select **Delete**. + diff --git a/source/collaborate/organize-using-custom-user-groups.rst b/source/collaborate/organize-using-custom-user-groups.rst index a3c4d3db21b..35145fa04dd 100644 --- a/source/collaborate/organize-using-custom-user-groups.rst +++ b/source/collaborate/organize-using-custom-user-groups.rst @@ -27,7 +27,7 @@ Create a custom group 1. Using Mattermost in a web browser or the desktop app, select |plus| at the top of the channel sidebar, then select **Create New User Group**. -2. Specify a name and mention. The mention is the handle you use to @mention a notification to the group. Group names must be unique across the Mattermost workspace. If a name is in use as a channel name, display name, or another custom group's name, it won't be available. +2. Specify a name and mention. The mention is the handle you use to @mention a notification to the group. Group names must be unique across the Mattermost :doc:`workspace `. If a name is in use as a channel name, display name, or another custom group's name, it won't be available. 3. Search for and select members to add to the custom user group, then select **Create Group**. diff --git a/source/collaborate/organize-using-teams.rst b/source/collaborate/organize-using-teams.rst index 9ac079798cf..168ea674df5 100644 --- a/source/collaborate/organize-using-teams.rst +++ b/source/collaborate/organize-using-teams.rst @@ -12,9 +12,9 @@ Organize using teams Team settings Team keyboard shortcuts -A team is a digital workspace where you and your teammates can collaborate in Mattermost. Depending on how Mattermost is set up in your organization, you can belong to one team or multiple teams. +A team is a digital :doc:`workspace ` where you and your teammates can collaborate in Mattermost. Depending on how Mattermost is :ref:`set up ` in your organization, you can belong to one team or multiple teams, and :ref:`access to the team ` can be open or restricted. -Users with the **Create Teams** permission can `create new teams <#create-a-team>`__ and :doc:`manage team settings ` for existing teams. +Users with the **Create Teams** permission can `create new teams <#create-a-team>`__ and :doc:`manage team settings ` for existing teams. System admins can grant the **Create Team** permission to roles via the :ref:`System scheme ` or the :ref:`Team override scheme `. .. include:: ../_static/badges/academy-teams.rst :start-after: :nosearch: diff --git a/source/collaborate/react-with-emojis-gifs.rst b/source/collaborate/react-with-emojis-gifs.rst index 494aaca4624..ac206c48dcb 100644 --- a/source/collaborate/react-with-emojis-gifs.rst +++ b/source/collaborate/react-with-emojis-gifs.rst @@ -58,7 +58,7 @@ Select the **Skin tone** icon in the top right corner of the emoji picker to spe Upload custom emojis ~~~~~~~~~~~~~~~~~~~~ -Using Mattermost in a web browser or the desktop app, you can upload new emojis that everyone in your Mattermost workspace can access to react to messages. From the emoji picker, select **Custom Emoji**. Small, square pictures work best when selecting an image to upload. The file can be any JPG, GIF, or PNG that's up to 512 KiB in size. +Using Mattermost in a web browser or the desktop app, you can upload new emojis that everyone in your Mattermost :doc:`workspace ` can access to react to messages. From the emoji picker, select **Custom Emoji**. Small, square pictures work best when selecting an image to upload. The file can be any JPG, GIF, or PNG that's up to 512 KiB in size. 1. Enter a name for your custom emoji. This is the name that shows up in the emoji autocomplete. 2. Choose **Select**, then select the image to use for the emoji. diff --git a/source/collaborate/search-for-messages.rst b/source/collaborate/search-for-messages.rst index c00b6781836..5a3a05a2965 100644 --- a/source/collaborate/search-for-messages.rst +++ b/source/collaborate/search-for-messages.rst @@ -35,7 +35,7 @@ Search for message and files File contents that match on file name, or contain matching text content within supported document types, are returned in the Search Results pane. Each search result includes file name, extension, and size details, as well as details about when and where the file was originally shared. - - For Mattermost Cloud workspaces, supported document file formats include PDF, PPTX, DOCX, ODT, HTML, and plain text documents. DOC and RTF file formats, as well as the contents of ZIP files, are not supported. + - For Mattermost Cloud :doc:`workspaces `, supported document file formats include PDF, PPTX, DOCX, ODT, HTML, and plain text documents. DOC and RTF file formats, as well as the contents of ZIP files, are not supported. - For Mattermost self-hosted deployments, supported document file formats include PDF, PPTX, DOCX, ODT, HTML, and plain text documents. .. note:: diff --git a/source/collaborate/share-files-in-messages.rst b/source/collaborate/share-files-in-messages.rst index d56ac5b8bd8..71b03e906a5 100644 --- a/source/collaborate/share-files-in-messages.rst +++ b/source/collaborate/share-files-in-messages.rst @@ -16,7 +16,7 @@ With file attachments, you can share additional information that helps your team **Share public links** - Public links allow you to share message attachments with anyone outside your Mattermost workspace. To share an attachment, select the thumbnail of an attachment, then select **Get Public Link**. + Public links allow you to share message attachments with anyone outside your Mattermost :doc:`workspace `. To share an attachment, select the thumbnail of an attachment, then select **Get Public Link**. .. tip:: diff --git a/source/comply/export-mattermost-channel-data.rst b/source/comply/export-mattermost-channel-data.rst index c702cc4e182..4d96209baf9 100644 --- a/source/comply/export-mattermost-channel-data.rst +++ b/source/comply/export-mattermost-channel-data.rst @@ -15,7 +15,7 @@ Enable For self-hosted deployments, a Mattermost system admin must perform the following steps in Mattermost. -1. Log in to your Mattermost workspace as a system administrator. +1. Log in to your Mattermost :doc:`workspace ` as a system administrator. 2. Download the latest version of `the plugin binary release `__, compatible with Mattermost v8.0.1 and later. If you are using an earlier version of Mattermost, :doc:`follow our documentation ` to upgrade to Mattermost v8.0.1 or later. 3. Go to **System Console > Plugins > Plugin Management > Upload Plugin**, and upload the plugin binary you downloaded in the previous step. 4. Go to **System Console > Plugins > Plugin Management**. In the **Installed Plugins** section, scroll to **Channel Export**, and select **Enable**. diff --git a/source/comply/legal-hold.rst b/source/comply/legal-hold.rst index c34a7b04b72..3cfa464f866 100644 --- a/source/comply/legal-hold.rst +++ b/source/comply/legal-hold.rst @@ -49,7 +49,7 @@ Step 3: Set up the Mattermost Legal Hold plugin Install the plugin ^^^^^^^^^^^^^^^^^^ -1. Log in to your Mattermost workspace as a system administrator. +1. Log in to your Mattermost :doc:`workspace ` as a system administrator. 2. Download the latest version of the `plugin binary release `_, compatible with Mattermost v8.0.1 and later. If you are using an earlier version of Mattermost, :doc:`follow our documentation ` to upgrade to Mattermost v8.0.1 or later. 3. Go to **System Console > Plugins > Plugin Management > Upload Plugin**, and upload the plugin binary you downloaded in the previous step. 4. In the **Installed Plugins** section, scroll to **Legal Hold Plugin**, and select **Enable**. diff --git a/source/conf.py b/source/conf.py index d93f469296e..a9c2538719c 100644 --- a/source/conf.py +++ b/source/conf.py @@ -3542,9 +3542,9 @@ def setup(_: Sphinx): # built documents. # # The short X.Y version. -# version = '10.0' +# version = '10.1' # The full version, including alpha/beta/rc tags. -# release = '10.0' +# release = '10.1' # 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 65f4bb74473..2adc13e1bcb 100644 --- a/source/configure/authentication-configuration-settings.rst +++ b/source/configure/authentication-configuration-settings.rst @@ -53,6 +53,9 @@ Enable account creation | Selecting **Create Account** displays an error. | | | Applies to email, OpenID Connect, and OAuth 2.0 user account authentication. | | +---------------------------------------------------------------------------------+------------------------------------------------------------------------+ +| **Note**: LDAP and SAML users can always create a Mattermost account by logging in using LDAP or SAML user credentials, regardless of whether this | +| configuration setting is enabled. | ++---------------------------------------------------------------------------------+------------------------------------------------------------------------+ .. config:setting:: signup-restrictcreationtodomains :displayname: Restrict account creation to specified email domains (Signup) @@ -2913,7 +2916,7 @@ Enable guest access | | - Environment variable: ``MM_GUESTACCOUNTSSETTINGS_ENABLE`` | +----------------------------------------------------------------+---------------------------------------------------------------------+ | **Note**: For billing purposes, activated guest accounts do consume a licensed seat, which is returned when the guest account is | -| deactivated.This means that guest accounts count as a paid user in your Mattermost workspace. | +| deactivated.This means that guest accounts count as a paid user in your Mattermost :doc:`workspace `. | +--------------------------------------------------------------------------------------------------------------------------------------+ .. config:setting:: guest-whitelistdomains diff --git a/source/configure/cloud-billing-account-settings.rst b/source/configure/cloud-billing-account-settings.rst index 7552530446b..510b24617a0 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 workspace: +Go to **System Console > Billing and Account** to manage the following aspects of your Cloud deployment: - Access billing history - Manage the :doc:`product subscription ` and account details for your Mattermost Cloud deployment. diff --git a/source/configure/configuration-settings.rst b/source/configure/configuration-settings.rst index 0b48b37eded..b134bf290e2 100644 --- a/source/configure/configuration-settings.rst +++ b/source/configure/configuration-settings.rst @@ -4,7 +4,7 @@ Configuration settings .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -System admins for both self-hosted and Cloud Mattermost workspaces 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. For self-hosted deployments, admins can additionally edit the ``config.json`` file. .. note:: @@ -24,7 +24,7 @@ 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 workspaces can also modify the ``config.json`` file directly using a text editor. +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/deprecated-configuration-settings.rst b/source/configure/deprecated-configuration-settings.rst index da80e2d987a..73399322bb1 100644 --- a/source/configure/deprecated-configuration-settings.rst +++ b/source/configure/deprecated-configuration-settings.rst @@ -3,7 +3,6 @@ Deprecated configuration settings The following Mattermost configuration settings are deprecated and are no longer supported in current Mattermost releases: -- `Mattermost Boards settings <#mattermost-boards-settings>`__ - `Bleve settings <#bleve-settings>`__ - `Elasticsearch settings <#elasticsearch-settings>`__ - `Service settings <#service-settings>`__ @@ -25,29 +24,6 @@ The following Mattermost configuration settings are deprecated and are no longer ---- -Mattermost Boards setting --------------------------- - -*Removed in the Mattermost v8.0 release* - -Enable publicly-shared boards -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -+------------------------------------------------------+--------------------------------------------------------------------------------------+ -| Enable or disable the ability to share | - System Config path: **Products > Boards** | -| links to Mattermost boards with other users. | - ``config.json`` setting: ``".ProductSettings.EnablePublicSharedBoards: false”,`` | -| | - Environment variable: ``MM_PRODUCTSETTINGS_ENABLEPUBLICSHAREDBOARDS`` | -| - **true**: Enables the ability to share links to | | -| Mattermost boards with other users. | | -| - **false**: **(Default)** Mattermost boards can't | | -| be shared with other users. | | -+------------------------------------------------------+--------------------------------------------------------------------------------------+ -| **Notes**: | -| | -| - From Mattermost v7.7 through Mattermost v7.10, this configuration setting applies to Mattermost Boards available as an official | -| in-product vertical. | -+------------------------------------------------------+--------------------------------------------------------------------------------------+ - Bleve settings -------------- diff --git a/source/configure/enable-copilot.rst b/source/configure/enable-copilot.rst index ecbaa4b31aa..2b0d9a4b585 100644 --- a/source/configure/enable-copilot.rst +++ b/source/configure/enable-copilot.rst @@ -12,7 +12,9 @@ Signficantly increase team productivity and decision-making speed by enhancing y Setup ------ -Mattermost AI Copilot comes pre-installed from Mattermost Server v9.7 or later. You must be a Mattermost system admin to `enable <#enable>`__ and `configure <#mattermost-configuration>`__ it using the System Console. +From Mattermost v9.7, you can install Mattermost Copilot from the in-product Mattermost Marketplace by selecting the **Product** |product-list| icon and selecting **App Marketplace**. Search for **Copilot** and select **Install**. + +You must be a Mattermost system admin to `enable <#enable>`__ and `configure <#mattermost-configuration>`__ it using the System Console. .. note:: If you're running Mattermost Server v9.6 or earlier, AI Copilot must be installed using the `latest binary available for download from the plugin repository `_. For an optimized user experience and compatibility, we recommend using Mattermost Copilot with Mattermost v9.7 and later. diff --git a/source/configure/experimental-configuration-settings.rst b/source/configure/experimental-configuration-settings.rst index 5bd6f97c54a..c1971b882cf 100644 --- a/source/configure/experimental-configuration-settings.rst +++ b/source/configure/experimental-configuration-settings.rst @@ -691,7 +691,7 @@ This setting enables you to specify an alternate filestore target for Mattermost **False**: Standard :ref:`file storage ` is used (or when the configuration setting is omitted). -When an alternate filestore target is configured, Mattermost Cloud admins can generate an S3 presigned URL for exports using the ``/exportlink [job-id|zip file|latest]`` slash command. See the :ref:`Mattermost workspace migration ` documentation for details. Alternatively, Cloud and self-hosted admins can use the :ref:`mmctl export generate-presigned-url ` command to generate a presigned URL directly from mmctl. +When an alternate filestore target is configured, Mattermost Cloud admins can generate an S3 presigned URL for exports using the ``/exportlink [job-id|zip file|latest]`` slash command. See the :ref:`Mattermost data migration ` documentation for details. Alternatively, Cloud and self-hosted admins can use the :ref:`mmctl export generate-presigned-url ` command to generate a presigned URL directly from mmctl. .. note:: diff --git a/source/configure/manage-user-surveys.rst b/source/configure/manage-user-surveys.rst index 3e30ad2823e..6ae353c4f6a 100644 --- a/source/configure/manage-user-surveys.rst +++ b/source/configure/manage-user-surveys.rst @@ -27,7 +27,7 @@ Install Mattermost offers an additonal :doc:`User Satisfaction Surveys ` option with limited customization options within the **Plugins** list where surveys are enabled by default. We recommend :ref:`disabling the User Satisfaction Surveys functionality ` when using this user survey integration. -1. Log in to your Mattermost workspace as a system administrator. +1. Log in to your Mattermost :doc:`workspace ` as a system administrator. 2. In Mattermost, from the Product menu |product-list|, select **App Marketplace**. 3. Search for or scroll to User Survey, and select **Install**. 4. Once installed, select **Configure**. You're taken to the System Console, directly to the **User Survey** integration page, under **Plugins**. diff --git a/source/configure/optimize-your-workspace.rst b/source/configure/optimize-your-workspace.rst index 3ef7dee1193..414fde58eb8 100644 --- a/source/configure/optimize-your-workspace.rst +++ b/source/configure/optimize-your-workspace.rst @@ -8,8 +8,6 @@ With workspace optimizations, system admins can review their workspace health an System admins can access their workspace optimization page in the System Console by 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/reporting-configuration-settings.rst b/source/configure/reporting-configuration-settings.rst index 67d1e46909b..34c3ccdee13 100644 --- a/source/configure/reporting-configuration-settings.rst +++ b/source/configure/reporting-configuration-settings.rst @@ -31,7 +31,8 @@ Site statistics | :doc:`Microsoft Teams integrations ` | | and :doc:`shared channels users ` aren't counted towards the total number of activated users. | | - For billing purposes, activated guest accounts do consume a licensed seat, which is returned when the guest account is | -| deactivated.This means that guest accounts count as a paid user in your Mattermost workspace. | +| deactivated. This means that guest accounts count as a paid user in your Mattermost | +| :doc:`workspace `. | +---------------------------------------------------------------+--------------------------------------------------------------+ ---- diff --git a/source/configure/self-hosted-account-settings.rst b/source/configure/self-hosted-account-settings.rst index d0cf64b8446..17830132411 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 workspace: +Go to **System Console > About** to manage the following aspects of your self-hosted deployment: - View the :doc:`edition ` of your Mattermost self-hosted deployment. - Manage your :doc:`product subscription `. diff --git a/source/configure/user-management-configuration-settings.rst b/source/configure/user-management-configuration-settings.rst index 4d1a86014df..92da301f1a5 100644 --- a/source/configure/user-management-configuration-settings.rst +++ b/source/configure/user-management-configuration-settings.rst @@ -27,7 +27,7 @@ Mattermost system admins can provision and manage user accounts, team membership Provision users ~~~~~~~~~~~~~~~ -Getting people set up with a Mattermost account is typically something that system admins do when deploying and configuring the Mattermost workspace. A Mattermost admin can :doc:`provision Mattermost users ` using one or more of the following methods: +Getting people set up with a Mattermost account is typically something that system admins do when deploying and configuring the Mattermost deployment. A Mattermost admin can :doc:`provision Mattermost users ` using one or more of the following methods: - :ref:`Enable account creation `. - Use :ref:`mmctl user create ` or Mattermost `APIs `__ to create user accounts. @@ -257,10 +257,21 @@ Teams | | - Environment variable: N/A | +---------------------------------------------------------------+-------------------------------------------------------------+ -See the :ref:`using AD/LDAP synchronized groups ` documentation for details on managing team or private channel membership. +Archive the team +~~~~~~~~~~~~~~~~~ See the :ref:`archive a team ` documentation for details on archiving teams that are no longer needed. +Synchronize team members +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Admins can choose between inviting members to a team manually or synchronizing members automatically from AD/LDAP groups. See the :ref:`using AD/LDAP synchronized groups ` documentation for details on managing team or private channel membership. + +Who can join the team? +~~~~~~~~~~~~~~~~~~~~~~~~ + +Admins can choose to make the team discoverable by allowing anyone with an account to join the team. Alternatively admins can enable specific email domains to join the team. + ---- Channels diff --git a/source/guides/administration.rst b/source/guides/administration.rst index eb98c1a5fe5..d83f3da82fb 100644 --- a/source/guides/administration.rst +++ b/source/guides/administration.rst @@ -16,8 +16,8 @@ Manage Mattermost This guide is for people who administer an existing Mattermost server. It’s divided into four parts: -* :doc:`Get started ` - An overview of standard configurations and features for both self-hosted and Cloud workspaces. -* :doc:`Cloud workspace management ` - Detailed information about admin capabilities of Mattermost Cloud workspaces. +* :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. * :doc:`Self-hosted administration ` - Detailed information about admin capabilities of self-hosted Mattermost servers. * :doc:`Other resources ` - Additional migration, conversion, and troubleshooting resources. diff --git a/source/guides/cloud-workspace-management.rst b/source/guides/cloud-workspace-management.rst index 0f56c02c474..d51777af869 100644 --- a/source/guides/cloud-workspace-management.rst +++ b/source/guides/cloud-workspace-management.rst @@ -5,7 +5,7 @@ This section of the guide is for system admins of Mattermost Cloud deployments. .. tip:: - If you're the admin for a Mattermost self-hosted workspace, see the :doc:`Self-hosted administration ` documentation. + If you're the system admin for a Mattermost self-hosted workspace, see the :doc:`Self-hosted administration ` documentation. .. toctree:: :maxdepth: 1 diff --git a/source/guides/collaborate.rst b/source/guides/collaborate.rst index 7416be9a2bf..8dbab9e729a 100644 --- a/source/guides/collaborate.rst +++ b/source/guides/collaborate.rst @@ -21,6 +21,7 @@ This Mattermost end user documentation is designed for anyone who wants guidance Organize using custom user groups Invite people Learn about Mattermost roles + Collaborate with audio and video Collaborate within channels Communicate with messages and threads Collaborate within Microsoft Teams @@ -33,6 +34,7 @@ This Mattermost end user documentation is designed for anyone who wants guidance * :doc:`Organize using custom user groups ` - Learn about creating and managing custom user groups in Mattermost. * :doc:`Invite people to your workspace ` - Learn how to add new users to Mattermost and add users to existing teams and channels. * :doc:`Learn about Mattermost user roles ` - Learn about the 6 user roles in Mattermost and what they can do. +* :doc:`Collaborate with audio and video ` - Learn about Mattermost's native real-time chat, self-hosted audio calls, and screen sharing capabilities. * :doc:`Collaborate within channels ` - Learn how to get started collaborating within Mattermost channels. * :doc:`Communicate with messages and threads ` Learn how to get started collaborating within Mattermost channels. * :doc:`Collaborate within Microsoft Teams ` - Learn how to get started collaborating within Microsoft Teams. diff --git a/source/guides/deployment.rst b/source/guides/deployment.rst index 0483e8cd9a0..4fa1798f28d 100644 --- a/source/guides/deployment.rst +++ b/source/guides/deployment.rst @@ -18,6 +18,7 @@ Learn how to install, deploy, and scale Mattermost for teams and organizations o Deploy with a tarball Deploy using Omnibus Deploy using Kubernetes + Deploy Mattermost on Azure AKS Deploy on Red Hat Set up an NGINX proxy Set up TLS @@ -41,6 +42,7 @@ Learn how to install, deploy, and scale Mattermost for teams and organizations o * :doc:`Deploy with a tarball ` - Support for any Linux distribution. * :doc:`Deploy using Omnibus ` - An entire Mattermost installation on a single server. * :doc:`Deploy using Kubernetes ` - Install using the Mattermost Helm Chart or Operator and simplified updates. +* :doc:`Deploy Mattermost on Azure AKS ` - Deploy Mattermost on Azure AKS. * :doc:`Deploy on Red Hat ` - Support for all current Red Hat Enterprise Linux platforms with a tarball. * :doc:`Set up NGINX proxy ` - Learn how to configure Mattermost for HTTPS for deployments of more than 200 users. * :doc:`Set up TLS ` - Learn how to configure Mattermost for HTTPS for deployments of fewer than 200 concurrent users. diff --git a/source/guides/repeatable-processes.rst b/source/guides/repeatable-processes.rst index e9c32c28c6d..eb06e49bf88 100644 --- a/source/guides/repeatable-processes.rst +++ b/source/guides/repeatable-processes.rst @@ -14,7 +14,15 @@ Playbooks monitor channels for keywords or user actions to trigger a structured :doc:`Advanced permissions ` are also available to delegate and manage playbook controls in larger organizations. -Collaborative playbooks are available in Mattermost self-hosted and Mattermost Cloud workspaces by selecting the product menu located in the top-left corner of the Mattermost interface. Use collaborative playbooks to orchestrate prescribed workflows and define, streamline, and document complex, recurring operations, and help your organization stay in command with integrated communication, collaboration, and status dashboards managing your workflow life cycles. +Configuration +-------------- + +Playbooks comes pre-packaged, installed, and enabled with Mattermost server. Access playbooks by selecting the product menu located in the top-left corner of the Mattermost interface. + +Usage +----- + +Use collaborative playbooks to orchestrate prescribed workflows and define, streamline, and document complex, recurring operations, and help your organization stay in command with integrated communication, collaboration, and status dashboards managing your workflow life cycles. .. include:: ../_static/badges/academy-playbooks.rst :start-after: :nosearch: diff --git a/source/guides/self-hosted-administration.rst b/source/guides/self-hosted-administration.rst index 1b2e0d4ff68..0e42b6752cb 100644 --- a/source/guides/self-hosted-administration.rst +++ b/source/guides/self-hosted-administration.rst @@ -5,7 +5,7 @@ This section of the guide is for system admins of self-hosted Mattermost servers .. tip:: - If you're the admin for a Mattermost Cloud workspace, see the :doc:`Cloud workspace management ` documentation. + If you're the system admin for a Mattermost Cloud workspace, see the :doc:`Cloud workspace management ` documentation. .. toctree:: :maxdepth: 1 diff --git a/source/guides/use-mattermost.rst b/source/guides/use-mattermost.rst index 433f684e613..40b67729dd3 100644 --- a/source/guides/use-mattermost.rst +++ b/source/guides/use-mattermost.rst @@ -4,7 +4,12 @@ Use Mattermost .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -This Mattermost end user documentation is designed for anyone looking to connect and collaborate in Mattermost, build repeatable, automated processes, and make Mattermost match your work preferences. +If you're using Mattermost to connect and collaborate, build repeatable, automated processes, and making Mattermost match your work preferences, this Mattermost end user product documentation is for you. + +In this documentation, you'll learn about using Mattermost. + +- Your Mattermost system admin has deployed Mattermost for your organization. A live Mattermost instance is ready for you to log into using your user credentials. +- Your Mattermost workspace is where you'll send and receive messages, see activity notifications, create, run, and participate in playbook runs, and where you'll customize look and feel through workspace preferences. .. toctree:: :maxdepth: 1 diff --git a/source/images/desktop-bookmark-add-choice.png b/source/images/desktop-bookmark-add-choice.png new file mode 100644 index 00000000000..4a8a0cdd17d Binary files /dev/null and b/source/images/desktop-bookmark-add-choice.png differ diff --git a/source/images/desktop-bookmark-add-details.png b/source/images/desktop-bookmark-add-details.png new file mode 100644 index 00000000000..b44719496ef Binary files /dev/null and b/source/images/desktop-bookmark-add-details.png differ diff --git a/source/images/desktop-bookmark-add.png b/source/images/desktop-bookmark-add.png new file mode 100644 index 00000000000..fe0caa9f576 Binary files /dev/null and b/source/images/desktop-bookmark-add.png differ diff --git a/source/images/dm-display.gif b/source/images/dm-display.gif index 33a6d723eeb..04325811976 100644 Binary files a/source/images/dm-display.gif and b/source/images/dm-display.gif differ diff --git a/source/images/mobile-bookmark-add-choice.png b/source/images/mobile-bookmark-add-choice.png new file mode 100644 index 00000000000..ecf68c0543d Binary files /dev/null and b/source/images/mobile-bookmark-add-choice.png differ diff --git a/source/images/mobile-bookmark-add-details.png b/source/images/mobile-bookmark-add-details.png new file mode 100644 index 00000000000..9a4f74c7641 Binary files /dev/null and b/source/images/mobile-bookmark-add-details.png differ diff --git a/source/images/mobile-bookmark-add.png b/source/images/mobile-bookmark-add.png new file mode 100644 index 00000000000..6b1e7d1c66b Binary files /dev/null and b/source/images/mobile-bookmark-add.png differ diff --git a/source/install/common-prod-deploy-omnibus.rst b/source/install/common-prod-deploy-omnibus.rst index c5c529138bb..7371049ab4c 100644 --- a/source/install/common-prod-deploy-omnibus.rst +++ b/source/install/common-prod-deploy-omnibus.rst @@ -8,7 +8,7 @@ Mattermost bundles the components of a Mattermost deployment into a single insta **Minimum system requirements** - Hardware: 2 vCPUs/cores with 4GB RAM (support for 1,000-2,000 users) -- Database: PostgreSQL v12+ or MySQL v8+ +- Database: PostgreSQL v12+ - Network ports required: - Application ports 80/443, TLS, TCP Inbound diff --git a/source/install/common-prod-deploy-tar.rst b/source/install/common-prod-deploy-tar.rst index 6bb537e3730..4db672e8207 100644 --- a/source/install/common-prod-deploy-tar.rst +++ b/source/install/common-prod-deploy-tar.rst @@ -11,7 +11,7 @@ These instructions outline how to install Mattermost Server on a 64-bit Linux ho **Minimum system requirements** - Hardware: 2 vCPUs/cores with 4GB RAM (support for 1,000-2,000 users) -- Database: PostgreSQL v12+ or MySQL v8+ +- Database: PostgreSQL v12+ - Network ports required: - Application ports 80/443, TLS, TCP Inbound diff --git a/source/install/download-latest-tarball.rst b/source/install/download-latest-tarball.rst index a327345b24b..b8b99be0343 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.0.1/mattermost-10.0.1-linux-amd64.tar.gz + wget https://releases.mattermost.com/10.1.1/mattermost-10.1.1-linux-amd64.tar.gz .. tab:: Current ESR diff --git a/source/install/install-kubernetes-aks.rst b/source/install/install-kubernetes-aks.rst new file mode 100644 index 00000000000..5e7f8d36cb3 --- /dev/null +++ b/source/install/install-kubernetes-aks.rst @@ -0,0 +1,114 @@ +Install Mattermost on Azure AKS +================================ + +.. include:: ../_static/badges/allplans-selfhosted.rst + :start-after: :nosearch: + +You can use a supported `Azure Marketplace Container Offer `__ to install Mattermost on your existing Azure infrastructure. + +Infrastructure pre-requisites +----------------------------- + +Deploying Mattermost on Azure AKS requires the following database and cluster prerequisites. + +PostgreSQL v13.0+ database +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Mattermost requires a pre-existing PostgreSQL database within your infrastructure. We recommend using `Azure Database for PostgreSQL - Flexible Server `_. Deploy one by following `this Microsoft quick start guide `_. + +.. tip:: + We recommend using Private Access for your database. + +Running AKS cluster +~~~~~~~~~~~~~~~~~~~ + +Mattermost Azure Container Offer requires a pre-existing Kubernetes Cluster with an Ingress Controller pre-installed. We recommend creating a new AKS cluster with the `AGIC add-on enabled `_. + +Follow `this tutorial `_ to create a new AKS cluster with the add-on enabled. + +.. tip:: + + - Connectivity should be already in place between the AKS cluster and the PostgreSQL database. + - Any pre-installed Ingress Controller within the cluster that supports the Ingress Kubernetes resource and TLS termination should work out of the box. + +Deployment pre-requisites +------------------------- + +Deploying Mattermost on Azure AKS requires the following deployment prerequisites. + +Valid DNS name and TLS certificates +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Mattermost relies on strong TLS certification in order to provide all the features to users. You need to have access to a DNS zone and be able to provide a valid TLS key and certificate for the Ingress Controller. + +Mattermost License and AKS Capacity +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. include:: ../_static/badges/ent-only.rst + :start-after: :nosearch: + +If your deployment option is for more than ``100 users``, you must have more than 2 nodes on your AKS cluster to support High Availability, and you must provide a valid Mattermost License file. + +.. note:: + + Providing a license is optional at this stage. You can enable a **30 day** Mattermost trial once the server is deployed. + +Deploy Mattermost +----------------- + +1. Navigate to our `Azure Marketplace Container Offer `_ and get the offer. + + Alternatively, you can go to the ``Extensions + Applications`` section of your AKS cluster and install the Mattermost offering from there. Visit the `Microsoft cluster extensions documentation `_ to learn more. + +2. Choose the **Resource Group** and the **Region** of your installed AKS and PostgreSQL database. + + .. image:: ../_static/images/azure/basics.png + :alt: An example of the Azure AKS Project details screen. + +3. Choose your AKS cluster. + + .. image:: ../_static/images/azure/aks-cluster.png + :alt: An example of the Azure AKS cluster setup screen. + +4. Fill in the details for your PostgreSQL database. + + .. image:: ../_static/images/azure/postgreSQL.png + :alt: An example of the Azure AKS Database setup screen. + + .. note:: + + - Connectivity should be already in place between the AKS cluster and the database. + - Database should already exist and the user specified must have full access. + +5. Adjust deployment details. + + .. image:: ../_static/images/azure/deployment-details.png + :alt: An example of the Azure AKS Deployment Details setup screen. + +.. note:: + You can define a Deployment size to automatically adjust the installation. A valid Mattermost license is required for deployments of more than 100 users. + +6. Configure Mattermost installation hostname and Ingress details. The AGIC add-on is used in the following example to show the ingress annotations required. + + .. code-block:: yaml + + kubernetes.io/ingress.class: azure/application-gateway + appgw.ingress.kubernetes.io/ssl-redirect: "true" + +Upload yor own TLS certificates at this stage to take advantage of all Mattermost features. + + .. image:: ../_static/images/azure/networking-details.png + :alt: An example of the Azure AKS Networking Details setup screen. + +7. Ensure that everything is running. You should be able to check the installed plugin from the **AKS Extensions + Applications** page under the **Settings** menu. + + a. When the deployment is complete, obtain the hostname or IP address of your Mattermost deployment using the following command: + + .. code-block:: sh + + kubectl -n mattermost-operator get ingress + + b. Get the resulting IP address from the ``ADDRESS`` column, and use your domain registration service to create a DNS record. + c. You should be good to go. + +Learn more about managing your Mattermost server by visiting the :doc:`Managing Mattermost ` documentation. \ No newline at end of file diff --git a/source/install/install-kubernetes.rst b/source/install/install-kubernetes.rst index 51daadf521c..1aabbebd278 100644 --- a/source/install/install-kubernetes.rst +++ b/source/install/install-kubernetes.rst @@ -1,26 +1,40 @@ -Install Mattermost on Kubernetes -================================ +Deploy Mattermost on Kubernetes +===================================== .. include:: ../_static/badges/allplans-selfhosted.rst :start-after: :nosearch: -You can install and deploy a production-ready Mattermost system on a Kubernetes cluster using the Mattermost Kubernetes Operator in practically any environment with less IT overhead and more automation. +You can install and deploy a production-ready Mattermost system on a Kubernetes cluster, such as :doc:`Azure AKS `, using the Mattermost Kubernetes Operator in practically any environment with less IT overhead and more automation. Mattermost supports Kubernetes clusters running either self-hosted in data centers, or in managed services such as Amazon EKS, Azure Kubernetes Service, Google Kubernetes Engine, DigitalOcean Kubernetes, and others. -You'll need a `Kubernetes cluster `__ running `a version that is currently supported with patch releases `__, Kubernetes CLI `kubectl `__ installed on local machine, and a basic understanding of Kubernetes concepts (such as deployments, pods) and actions (such as applying manifests, viewing pod logs). Running Mattermost in Kubernetes requires resources based on your total number of users. See the :ref:`Mattermost Kubernetes Operator ` documentation to learn more about the minimum Kubernetes cluster resources Mattermost requires at different scales. +You'll need a `Kubernetes cluster `__ running `a version that is currently supported with patch releases `__, Kubernetes CLI `kubectl `__ installed on local machine, and a basic understanding of Kubernetes concepts (such as deployments, pods) and actions (such as applying manifests, viewing pod logs). + +Running Mattermost in Kubernetes requires resources based on your total number of users. See the :ref:`Mattermost Kubernetes Operator ` documentation to learn more about the minimum Kubernetes cluster resources Mattermost requires at different scales. .. tip:: - - - If you’re unsure about which environment you want to use for your Kubernetes cluster, we suggest using a managed service such as as `Amazon EKS `__, `Azure Kubernetes Service `__, `Google Kubernetes Engine `__, or `DigitalOcean Kubernetes `__. - - Looking for a quick way to evaluate Mattermost or to try out the latest Mattermost deployment? See this article for details on creating your own Mattermost instance on Kubernetes using Minicube: https://medium.com/@Erez.Tamam/create-your-own-mattermost-instance-on-kubernetes-in-10-minutes-d13f576ed794. + + - If you’re unsure about which environment you want to use for your Kubernetes cluster, we suggest using a managed service such as as `Amazon EKS `_, `Azure Kubernetes Service `_, `Google Kubernetes Engine `_, or `DigitalOcean Kubernetes `_. + - Looking for a quick way to evaluate Mattermost or to try out the latest Mattermost deployment? Learn how to `create your own Mattermost instance on Kubernetes using Minicube `_. + - See the :doc:`configuration settings ` documentation to learn more about customizing your production Mattermost deployment. + - Encountering issues with your deployment? See the :ref:`deployment troubleshooting ` or :doc:`high scale troubleshooting ` documentation for details. + +Install Mattermost on Kubernetes +-------------------------------- + +You can install and deploy a production-ready Mattermost system on a Kubernetes cluster using the Mattermost Kubernetes Operator in practically any environment with less IT overhead and more automation. + +Mattermost supports Kubernetes clusters running either self-hosted in data centers, or in managed services such as Amazon EKS, Azure Kubernetes Service, Google Kubernetes Engine, DigitalOcean Kubernetes, and others. + +You'll need a `Kubernetes cluster `_ running `a version that is currently supported with patch releases `_, Kubernetes CLI `kubectl `_ installed on local machine, and a basic understanding of Kubernetes concepts (such as deployments, pods) and actions (such as applying manifests, viewing pod logs). Running Mattermost in Kubernetes requires resources based on your total number of users. See the :ref:`Mattermost Kubernetes Operator ` documentation to learn more about the minimum Kubernetes cluster resources Mattermost requires at different scales. Install the operators --------------------- Nginx Ingress Controller ~~~~~~~~~~~~~~~~~~~~~~~~ -See the `Kubernetes deployment documentation `__ for details on installing the NGINX ingress controller in your Kubernetes cluster. + +See the `Kubernetes deployment documentation `_ for details on installing the NGINX ingress controller in your Kubernetes cluster. Mattermost Operator ~~~~~~~~~~~~~~~~~~~ @@ -30,41 +44,42 @@ There are multiple ways to install the Mattermost Kubernetes Operator. We recomm With Helm ^^^^^^^^^ -1. Install Helm. We recommend Helm v3.13.0 or later. For installation instructions, see the `Helm quickstart documentation `__. +1. Install Helm. We recommend Helm v3.13.0 or later. For installation instructions, see the `Helm quickstart documentation `_. + 2. Once Helm is installed and initialized, run the following: - .. code-block:: sh + .. code-block:: sh - helm repo add mattermost https://helm.mattermost.com + helm repo add mattermost https://helm.mattermost.com -3. Create a file named ``config.yaml``, then copy and paste the content of `the Mattermost operator file `__ into it. +3. Create a file named ``config.yaml``, then copy and paste the content of `the Mattermost operator file `_ into it. 4. Create a namespace for the Mattermost Operator: - .. code-block:: sh + .. code-block:: sh - kubectl create ns mattermost-operator + kubectl create ns mattermost-operator 5. Install your preferred version of the Mattermost Operator using the following command: - .. code-block:: sh + .. code-block:: sh - helm install mattermost/mattermost-operator -n + helm install mattermost/mattermost-operator -n For example: - .. code-block:: sh + .. code-block:: sh - helm install mattermost-operator mattermost/mattermost-operator -n mattermost-operator + helm install mattermost-operator mattermost/mattermost-operator -n mattermost-operator To install with any customized configuration you've made in your ``config.yaml`` file, use the ``-f`` flag: - .. code-block:: sh + .. code-block:: sh - helm install mattermost-operator mattermost/mattermost-operator -n mattermost-operator -f config.yaml + helm install mattermost-operator mattermost/mattermost-operator -n mattermost-operator -f config.yaml - .. tip:: + .. tip:: If no version is specified, the latest version of the Mattermost Operator will be installed. With Kubernetes CLI @@ -74,30 +89,30 @@ With Kubernetes CLI 1. Create a namespace for the Mattermost Operator: - .. code-block:: sh + .. code-block:: sh - kubectl create ns mattermost-operator + kubectl create ns mattermost-operator 2. Install the Mattermost Operator: - .. code-block:: sh + .. code-block:: sh - kubectl apply -n mattermost-operator -f https://raw.githubusercontent.com/mattermost/mattermost-operator/master/docs/mattermost-operator/mattermost-operator.yaml + kubectl apply -n mattermost-operator -f https://raw.githubusercontent.com/mattermost/mattermost-operator/master/docs/mattermost-operator/mattermost-operator.yaml Deploy Mattermost ----------------- 1. (Mattermost Enterprise only) Create a Mattermost license secret by opening a text editor and creating a secret manifest containing the Mattermost license. Replace ``[LICENSE_FILE_CONTENTS]`` below with the contents of your Mattermost license file. Save the file as ``mattermost-license-secret.yaml``. - .. code-block:: yaml + .. code-block:: yaml - apiVersion: v1 - kind: Secret - metadata: - name: my-mattermost-license - type: Opaque - stringData: - license: + apiVersion: v1 + kind: Secret + metadata: + name: my-mattermost-license + type: Opaque + stringData: + license: .. note:: A Mattermost Enterprise license is required for a seamless experience deploying Mattermost with multiple server instances. If you plan to deploy Mattermost without an Enterprise license, we recommend a single server deployment by adding ``Replicas: 1`` to the ``spec`` section in step 2. @@ -105,225 +120,227 @@ Deploy Mattermost 2. Create an installation manifest file ``mattermost-installation.yaml`` locally, and open it with a text editor. Copy and paste the YAML structure below, and make any necessary adjustments for your configuration and environment. - .. code-block:: yaml + .. code-block:: yaml - apiVersion: installation.mattermost.com/v1beta1 - kind: Mattermost - metadata: - name: # Chose the desired installation name. Example = mm-example-full - spec: - size: # Adjust to your requirements. Example = 5000users - ingress: - enabled: true - host: # Adjust to your domain. Example = example.mattermost-example.com - annotations: - kubernetes.io/ingress.class: nginx - version: # Select a recent supported version of Mattermost. Example = 9.3.0 - licenseSecret: "" # If you created a license secret in step 1, put the secret name here - - .. note:: - While file names are provided, your file names can be different. The file names in this tutorial are used for clarity and organization. + apiVersion: installation.mattermost.com/v1beta1 + kind: Mattermost + metadata: + name: # Chose the desired installation name. Example = mm-example-full + spec: + size: # Adjust to your requirements. Example = 5000users + ingress: + enabled: true + host: # Adjust to your domain. Example = example.mattermost-example.com + annotations: + kubernetes.io/ingress.class: nginx + version: # Select a recent supported version of Mattermost. Example = 9.3.0 + licenseSecret: "" # If you created a license secret in step 1, put the secret name here + + .. note:: + + While file names are provided, your file names may be different. The file names in this tutorial are intended for clarity and organization. Some of the most commonly-used fields include: - .. csv-table:: - :header: "Field", "Description" - - "metadata.name", "The name of your Mattermost as it will be shown in Kubernetes. The shorter the better." - "spec.size", "The size of your installation. This can be '100users', '1000users, '5000users', '10000users', or '25000users'." - "spec.ingress.host", "The DNS for your Mattermost installation." - "spec.version", "The Mattermost version. Refer to :doc:`the server version archive page ` when selecting a Mattermost version." - "spec.licenseSecret", "The name of the Kubernetes secret containing your license (e.g., mattermost-license). Required for Enterprise deployments." - "spec.mattermostEnv", "List of custom environment variables for the Mattermost instance. Only required when tweaking Mattermost configuration is required." - "spec.image", "Docker image for the Mattermost app servers." - "spec.imagePullPolicy", "Image Pull policy used by Mattermost deployment." - "spec.useServiceLoadBalancer", "Set to true to use AWS or Azure load balancers instead of an NGINX controller." - "spec.serviceAnnotations", "Service annotations to use with AWS or Azure load balancers." - "spec.ingress.enabled", "Indicates if Ingress should be created by Mattermost Operator." - "spec.ingress.annotations", "Custom annotations propagated to Ingress resource." - "spec.ingress.tlsSecret", "Name of a Secret that contains TLS certificates for the ingress." - "spec.database.external.secret", "Name of a Kubernetes secret containing connection string to an external database." - "spec.fileStore.external.url", "External File Storage URL." - "spec.fileStore.external.bucket", "File Storage bucket name." - "spec.fileStore.external.secret", "Name of a Kubernetes secret that contains credentials to external file storage." - "spec.elasticSearch.host", "Elasticsearch hostname." - "spec.elasticSearch.username", "Username to log into Elasticsearch." - "spec.elasticSearch.password", "Password to log into Elasticsearch." - "spec.scheduling.resources", "Resource requests and limits of pod and container (Kubernetes)." - "spec.scheduling.nodeSelector", "Node selector for assigning pods to nodes (Kubernetes)." - "spec.scheduling.affinity", "Affinity and anti-affinity for assigning pods to nodes (Kubernetes)." - - More information on these additional fields can be found `in this example `__. If you have previous experience with Kubernetes Custom Resources, you can also check the `Custom Resource Definition `__. + .. csv-table:: + :header: "Field", "Description" + + "metadata.name", "The name of your Mattermost as it will be shown in Kubernetes. The shorter the better." + "spec.size", "The size of your installation. This can be '100users', '1000users, '5000users', '10000users', or '25000users'." + "spec.ingress.host", "The DNS for your Mattermost installation." + "spec.version", "The Mattermost version. Refer to :doc:`the server version archive page ` when selecting a Mattermost version." + "spec.licenseSecret", "The name of the Kubernetes secret containing your license (e.g., mattermost-license). Required for Enterprise deployments." + "spec.mattermostEnv", "List of custom environment variables for the Mattermost instance. Only required when tweaking Mattermost configuration is required." + "spec.image", "Docker image for the Mattermost app servers." + "spec.imagePullPolicy", "Image Pull policy used by Mattermost deployment." + "spec.useServiceLoadBalancer", "Set to true to use AWS or Azure load balancers instead of an NGINX controller." + "spec.serviceAnnotations", "Service annotations to use with AWS or Azure load balancers." + "spec.ingress.enabled", "Indicates if Ingress should be created by Mattermost Operator." + "spec.ingress.annotations", "Custom annotations propagated to Ingress resource." + "spec.ingress.tlsSecret", "Name of a Secret that contains TLS certificates for the ingress." + "spec.database.external.secret", "Name of a Kubernetes secret containing connection string to an external database." + "spec.fileStore.external.url", "External File Storage URL." + "spec.fileStore.external.bucket", "File Storage bucket name." + "spec.fileStore.external.secret", "Name of a Kubernetes secret that contains credentials to external file storage." + "spec.elasticSearch.host", "Elasticsearch hostname." + "spec.elasticSearch.username", "Username to log into Elasticsearch." + "spec.elasticSearch.password", "Password to log into Elasticsearch." + "spec.scheduling.resources", "Resource requests and limits of pod and container (Kubernetes)." + "spec.scheduling.nodeSelector", "Node selector for assigning pods to nodes (Kubernetes)." + "spec.scheduling.affinity", "Affinity and anti-affinity for assigning pods to nodes (Kubernetes)." + + More information on these additional fields can be found `in this example `_. If you have previous experience with Kubernetes Custom Resources, you can also check the `Custom Resource Definition `_. 3. Create a file ``mattermost-database-secret.yaml`` to house secrets related to your installation's database. The database secret needs to be created in the namespace that will hold the Mattermost installation. The secret should contain the following data: - .. code-block:: yaml + .. code-block:: yaml - apiVersion: v1 - data: - DB_CONNECTION_CHECK_URL: - DB_CONNECTION_STRING: - MM_SQLSETTINGS_DATASOURCEREPLICAS: - kind: Secret - metadata: - name: my-postgres-connection - type: Opaque + apiVersion: v1 + data: + DB_CONNECTION_CHECK_URL: + DB_CONNECTION_STRING: + MM_SQLSETTINGS_DATASOURCEREPLICAS: + kind: Secret + metadata: + name: my-postgres-connection + type: Opaque - .. csv-table:: - :header: "Key", "Description", "Required" + .. csv-table:: + :header: "Key", "Description", "Required" - "DB_CONNECTION_STRING", "Connection string to the database.", "Yes" - "MM_SQLSETTINGS_DATASOURCEREPLICAS", "Connection string to read replicas of the database.", "No" - "DB_CONNECTION_CHECK_URL", "The URL used for checking that the database is accessible.", "No" + "DB_CONNECTION_STRING", "Connection string to the database.", "Yes" + "MM_SQLSETTINGS_DATASOURCEREPLICAS", "Connection string to read replicas of the database.", "No" + "DB_CONNECTION_CHECK_URL", "The URL used for checking that the database is accessible.", "No" Here's an example of a secret for AWS Aurora with PostgreSQL: - .. code-block:: yaml + .. code-block:: yaml - apiVersion: v1 - data: - DB_CONNECTION_CHECK_URL: cG9zdGdyZXM6Ly91c2VyOnN1cGVyX3NlY3JldF9wYXNzd29yZEBteS1kYXRhYmFzZS5jbHVzdGVyLWFiY2QudXMtZWFzdC0xLnJkcy5hbWF6b25hd3MuY29tOjU0MzIvbWF0dGVybW9zdD9jb25uZWN0X3RpbWVvdXQ9MTAK - DB_CONNECTION_STRING: cG9zdGdyZXM6Ly91c2VyOnN1cGVyX3NlY3JldF9wYXNzd29yZEBteS1kYXRhYmFzZS5jbHVzdGVyLWFiY2QudXMtZWFzdC0xLnJkcy5hbWF6b25hd3MuY29tOjU0MzIvbWF0dGVybW9zdD9jb25uZWN0X3RpbWVvdXQ9MTAK - MM_SQLSETTINGS_DATASOURCEREPLICAS: cG9zdGdyZXM6Ly91c2VyOnN1cGVyX3NlY3JldF9wYXNzd29yZEBteS1kYXRhYmFzZS5jbHVzdGVyLXJvLWFiY2QudXMtZWFzdC0xLnJkcy5hbWF6b25hd3MuY29tOjU0MzIvbWF0dGVybW9zdD9jb25uZWN0X3RpbWVvdXQ9MTAK - kind: Secret - metadata: - name: my-postgres-connection - type: Opaque + apiVersion: v1 + data: + DB_CONNECTION_CHECK_URL: cG9zdGdyZXM6Ly91c2VyOnN1cGVyX3NlY3JldF9wYXNzd29yZEBteS1kYXRhYmFzZS5jbHVzdGVyLWFiY2QudXMtZWFzdC0xLnJkcy5hbWF6b25hd3MuY29tOjU0MzIvbWF0dGVybW9zdD9jb25uZWN0X3RpbWVvdXQ9MTAK + DB_CONNECTION_STRING: cG9zdGdyZXM6Ly91c2VyOnN1cGVyX3NlY3JldF9wYXNzd29yZEBteS1kYXRhYmFzZS5jbHVzdGVyLWFiY2QudXMtZWFzdC0xLnJkcy5hbWF6b25hd3MuY29tOjU0MzIvbWF0dGVybW9zdD9jb25uZWN0X3RpbWVvdXQ9MTAK + MM_SQLSETTINGS_DATASOURCEREPLICAS: cG9zdGdyZXM6Ly91c2VyOnN1cGVyX3NlY3JldF9wYXNzd29yZEBteS1kYXRhYmFzZS5jbHVzdGVyLXJvLWFiY2QudXMtZWFzdC0xLnJkcy5hbWF6b25hd3MuY29tOjU0MzIvbWF0dGVybW9zdD9jb25uZWN0X3RpbWVvdXQ9MTAK + kind: Secret + metadata: + name: my-postgres-connection + type: Opaque - .. note:: + .. note:: - For PostgreSQL databases, the connection is checked with `pg_isready `__ so the ``DB_CONNECTION_CHECK_URL`` is the same as connection string. + For PostgreSQL databases, the connection is checked with `pg_isready `__ so the ``DB_CONNECTION_CHECK_URL`` is the same as connection string. 4. Create a file ``mattermost-filestore-secret.yaml`` to house secrets related to your installation's filestore. The filestore secret needs to be created in the namespace that will hold the Mattermost installation. The secret should contain the following data: - .. code-block:: yaml + .. code-block:: yaml - apiVersion: v1 - data: - accesskey: - secretkey: - kind: Secret - metadata: - name: - type: Opaque + apiVersion: v1 + data: + accesskey: + secretkey: + kind: Secret + metadata: + name: + type: Opaque - .. csv-table:: - :header: "Key", "Description", "Required" + .. csv-table:: + :header: "Key", "Description", "Required" - "accesskey", "Filestore access key.", "Yes" - "secretkey", "Filestore secret key.", "Yes" - "metadata.name", "The name of the secret.", "Yes" + "accesskey", "Filestore access key.", "Yes" + "secretkey", "Filestore secret key.", "Yes" + "metadata.name", "The name of the secret.", "Yes" Here's an example of a secret for Amazon S3: - .. code-block:: yaml + .. code-block:: yaml - apiVersion: v1 - data: - accesskey: QUNDRVNTX0tFWQo= - secretkey: U1VQRVJfU0VDUkVUX0tFWQo= - kind: Secret - metadata: - name: my-s3-iam-access-key - type: Opaque + apiVersion: v1 + data: + accesskey: QUNDRVNTX0tFWQo= + secretkey: U1VQRVJfU0VDUkVUX0tFWQo= + kind: Secret + metadata: + name: my-s3-iam-access-key + type: Opaque 5. Adjust installation manifest. - .. tip:: - For more information on where in the YAML structure to make the below updates, reference the supported fields in step 2. + .. tip:: + + For more information on where in the YAML structure to make the below updates, reference the supported fields in step 2. In order for the Mattermost Operator to utilize your external database, you must modify the Mattermost manifest (inside the ``mattermost-installation.yaml`` file) by adding the following fields: - .. code-block:: yaml + .. code-block:: yaml - spec: - ... - database: - external: - secret: # The name of the secret containing the database connection string. You set this value in step 3. Example = my-postgres-connection + spec: + ... + database: + external: + secret: # The name of the secret containing the database connection string. You set this value in step 3. Example = my-postgres-connection Now, point the Mattermost Operator at your external filestore. Modify the Mattermost manifest (inside the ``mattermost-installation.yaml`` file) by adding the following fields: - .. code-block:: yaml + .. code-block:: yaml - spec: - ... - fileStore: - external: - url: s3.amazonaws.com - bucket: my-s3-bucket - secret: # The name of the secret containing the filestore access and secret keys. You set this value in step 4. Example = my-s3-iam-access-key + spec: + ... + fileStore: + external: + url: s3.amazonaws.com + bucket: my-s3-bucket + secret: # The name of the secret containing the filestore access and secret keys. You set this value in step 4. Example = my-s3-iam-access-key Additionally when using Amazon S3, set the ``MM_FILESETTINGS_AMAZONS3SSE`` and ``MM_FILESETTINGS_AMAZONS3SSL`` environment variables to ``true``: - .. code-block:: yaml + .. code-block:: yaml - spec: - ... - mattermostEnv: - ... + spec: + ... + mattermostEnv: + ... + - name: MM_FILESETTINGS_AMAZONS3SSE + value: "true" + - name: MM_FILESETTINGS_AMAZONS3SSL + value: "true" + + If you've configured your Mattermost Enterprise Edition installation manifest with a custom PostgreSQL database, and an Amazon S3 filestore, your installation manifest should look something like this: + + .. code-block:: yaml + + apiVersion: installation.mattermost.com/v1beta1 + kind: Mattermost + metadata: + name: mm-example-external-db + spec: + size: 5000users + ingress: + enabled: true + host: example.mattermost-example.com + annotations: + kubernetes.io/ingress.class: nginx + version: 9.3.0 + licenseSecret: my-mattermost-license + database: + external: + secret: my-postgres-connection + fileStore: + external: + url: s3.amazonaws.com + bucket: my-s3-bucket + secret: my-s3-iam-access-key + mattermostEnv: - name: MM_FILESETTINGS_AMAZONS3SSE value: "true" - name: MM_FILESETTINGS_AMAZONS3SSL value: "true" - If you've configured your Mattermost Enterprise Edition installation manifest with a custom PostgreSQL database, and an Amazon S3 filestore, your installation manifest should look something like this: - - .. code-block:: yaml - - apiVersion: installation.mattermost.com/v1beta1 - kind: Mattermost - metadata: - name: mm-example-external-db - spec: - size: 5000users - ingress: - enabled: true - host: example.mattermost-example.com - annotations: - kubernetes.io/ingress.class: nginx - version: 9.3.0 - licenseSecret: my-mattermost-license - database: - external: - secret: my-postgres-connection - fileStore: - external: - url: s3.amazonaws.com - bucket: my-s3-bucket - secret: my-s3-iam-access-key - mattermostEnv: - - name: MM_FILESETTINGS_AMAZONS3SSE - value: "true" - - name: MM_FILESETTINGS_AMAZONS3SSL - value: "true" - 6. Apply the installation manifest file. Manifests are applied with ``kubectl``. Before running the commands make sure you are connected to your Kubernetes cluster. a. Create a namespace for this new Mattermost installation: - .. code-block:: sh + .. code-block:: sh - kubectl create ns mattermost + kubectl create ns mattermost b. (Mattermost Enterprise only) apply the license file by specifying the path to the file you created in step 1: - .. code-block:: sh + .. code-block:: sh - kubectl apply -n mattermost -f [PATH_TO_LICENCE_SECRET_MANIFEST] + kubectl apply -n mattermost -f [PATH_TO_LICENCE_SECRET_MANIFEST] c. Apply the installation file by specifying the path to the file you created in step 2: - .. code-block:: sh + .. code-block:: sh - kubectl apply -n mattermost -f [PATH_TO_MATTERMOST_MANIFEST] + kubectl apply -n mattermost -f [PATH_TO_MATTERMOST_MANIFEST] The deployment process can be monitored in the Kubernetes user interface or in command line by running: - .. code-block:: sh + .. code-block:: sh - kubectl -n mattermost get mm -w + kubectl -n mattermost get mm -w The installation should be deployed successfully, when the Custom Resource reaches the ``stable`` state. @@ -331,9 +348,9 @@ Deploy Mattermost a. When the deployment is complete, obtain the hostname or IP address of your Mattermost deployment using the following command: - .. code-block:: sh + .. code-block:: sh - kubectl -n mattermost get ingress + kubectl -n mattermost get ingress b. Copy the resulting hostname or IP address from the ``ADDRESS`` column, open your browser, and connect to Mattermost. @@ -341,13 +358,13 @@ Deploy Mattermost d. Navigate to the ``ingress.host`` URL in your browser and use Mattermost. -.. note:: - - If you just want to try it out on your local machine without configuring the domain, run the following command, and then navigate to http://localhost:8065. + .. note:: + + If you just want to try it out on your local machine without configuring the domain, run the following command, and then navigate to ``http://localhost:8065``. - .. code-block:: sh + .. code-block:: sh - kubectl -n mattermost port-forward svc/[YOUR_MATTERMOST_NAME] 8065:8065 + kubectl -n mattermost port-forward svc/[YOUR_MATTERMOST_NAME] 8065:8065 Mattermost CloudNative Bootstrapper (Sneak peek) ------------------------------------------------ diff --git a/source/install/install-rhel-7-postgresql.rst b/source/install/install-rhel-7-postgresql.rst index be432340c6b..4c9ad6fe9ca 100644 --- a/source/install/install-rhel-7-postgresql.rst +++ b/source/install/install-rhel-7-postgresql.rst @@ -9,7 +9,7 @@ Install PostgreSQL database ``sudo yum install -y https://download.postgresql.org/pub/repos/yum/reporpms/EL-7-x86_64/pgdg-redhat-repo-latest.noarch.rpm`` -3. Install PostgreSQL version 11 or higher. Replace the contents of the ``{version}`` with the version you wish to install. +3. Install PostgreSQL v12 or higher. Replace the contents of the ``{version}`` with the version you wish to install. ``sudo yum install -y postgresql{version}-server`` diff --git a/source/install/install-rhel-8-postgresql.rst b/source/install/install-rhel-8-postgresql.rst index aec718a5e20..387b36d8127 100644 --- a/source/install/install-rhel-8-postgresql.rst +++ b/source/install/install-rhel-8-postgresql.rst @@ -12,7 +12,7 @@ Installing PostgreSQL database ``sudo yum install postgresql-server postgresql-contrib`` -Confirm this version is PostgreSQL version 11 or higher. You can do this by running ``psql -V``. If this isn't version 11 or higher you can reference the PostgreSQL documentation [here](https://www.postgresql.org/download/linux/redhat/) to install an updated version of PostgreSQL. +Confirm this version is PostgreSQL v12 or higher. You can do this by running ``psql -V``. If this isn't version 11 or higher you can reference the PostgreSQL documentation [here](https://www.postgresql.org/download/linux/redhat/) to install an updated version of PostgreSQL. 1. Initialize the database. diff --git a/source/install/install-rhel-8.rst b/source/install/install-rhel-8.rst index 3516f72230b..fdaab8523c8 100644 --- a/source/install/install-rhel-8.rst +++ b/source/install/install-rhel-8.rst @@ -21,7 +21,7 @@ Install Mattermost on RHEL
  • Operating System: Enterprise Linux 7+, Oracle Linux 6+, Oracle Linux 7+
  • Hardware: 1 vCPU/core with 2GB RAM (support for up to 1,000 users)
    • -
  • Database: PostgreSQL v11+
    • +
  • Database: PostgreSQL v12+
  • Network:
    • Application 80/443, TLS, TCP Inbound
      • diff --git a/source/install/install-tar.rst b/source/install/install-tar.rst index 85f7d94ba5d..74d80a900d4 100644 --- a/source/install/install-tar.rst +++ b/source/install/install-tar.rst @@ -20,7 +20,7 @@ Install Mattermost Server using the tarball

      Minimum system requirements:

      • Hardware: 1 vCPU/core with 2GB RAM (support for up to 1,000 users)
        • -
      • Database: PostgreSQL v11+
        • +
      • Database: PostgreSQL v12+
      • Network:
        • Application 80/443, TLS, TCP Inbound
          • diff --git a/source/install/install-ubuntu-2004-postgresql.rst b/source/install/install-ubuntu-2004-postgresql.rst index c98335f4366..9d7c9fe5ad0 100644 --- a/source/install/install-ubuntu-2004-postgresql.rst +++ b/source/install/install-ubuntu-2004-postgresql.rst @@ -18,7 +18,7 @@ Install PostgreSQL on Ubuntu Server 20.04 When the installation is complete, the PostgreSQL server is running, and a Linux user account called *postgres* has been created. -Confirm this version is PostgreSQL version 11 or higher. You can do this by running ``psql -V``. If this isn't version 11 or higher you can reference the PostgreSQL documentation `here `__ to install an updated version of PostgreSQL. +Confirm this version is PostgreSQL v12 or higher. You can do this by running ``psql -V``. If this isn't version 11 or higher you can reference the PostgreSQL documentation `here `__ to install an updated version of PostgreSQL. 2. Access PostgreSQL with one of the following options: diff --git a/source/install/install-ubuntu.rst b/source/install/install-ubuntu.rst index c4834789e09..c22766a60de 100644 --- a/source/install/install-ubuntu.rst +++ b/source/install/install-ubuntu.rst @@ -21,7 +21,7 @@ Install Mattermost Server on Ubuntu
          • Operating System: 20.04 LTS, 22.04 LTS, 24.04 LTS
          • Hardware: 1 vCPU/core with 2GB RAM (support for up to 1,000 users)
            • -
          • Database: PostgreSQL v11+
            • +
          • Database: PostgreSQL v12+
          • Network:
            • Application 80/443, TLS, TCP Inbound
              • diff --git a/source/install/installing-mattermost-omnibus.rst b/source/install/installing-mattermost-omnibus.rst index 0f28e1aad61..824cdde5d24 100644 --- a/source/install/installing-mattermost-omnibus.rst +++ b/source/install/installing-mattermost-omnibus.rst @@ -21,7 +21,7 @@ Install Mattermost Omnibus
              • Hardware: 1 vCPU/core with 2GB RAM (support for up to 1,000 users)
              • Operating System: Ubuntu 20.04 or greater
                • -
              • Database: PostgreSQL v11+
                • +
              • Database: PostgreSQL v12+
              • Network ports required:
                • Application ports 80/443, TLS, TCP Inbound
                  • diff --git a/source/install/trouble-postgres.rst b/source/install/trouble-postgres.rst index 81e982a3b77..99514287292 100644 --- a/source/install/trouble-postgres.rst +++ b/source/install/trouble-postgres.rst @@ -1,7 +1,7 @@ PostgreSQL installation troubleshooting ======================================= -Mattermost supports PostgreSQL v11+. +Mattermost supports PostgreSQL v12+. 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. diff --git a/source/install/troubleshooting.rst b/source/install/troubleshooting.rst index 4eec3485d32..18994085cc5 100644 --- a/source/install/troubleshooting.rst +++ b/source/install/troubleshooting.rst @@ -361,7 +361,7 @@ Mattermost server Database server - Internal hostname: postgresql.lan - - PostgreSQL v11 + - PostgreSQL v12 - LDAP Provider - 192.168.1.102 - Internal hostname: ldap.lan - OpenLDAP 2.4.54 (Docker container) @@ -386,7 +386,7 @@ Database servers - Hostnames: db1.local.lan, db2.local.lan, db3.local.lan - Primary: db1.local.lan - Read-Only: db2.local.lan, db3.local.lan - - PostgreSQL v11 + - PostgreSQL v12 Elasticsearch server diff --git a/source/integrate/microsoft-calendar-interoperability.rst b/source/integrate/microsoft-calendar-interoperability.rst index 6ed8fc01fbd..e0bed9209a8 100644 --- a/source/integrate/microsoft-calendar-interoperability.rst +++ b/source/integrate/microsoft-calendar-interoperability.rst @@ -75,7 +75,7 @@ You're all set for configuration in the Azure portal. Install the Microsoft Calendar integration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1. Log in to your Mattermost workspace as a system administrator. +1. Log in to your Mattermost :doc:`workspace ` as a system admin. 2. In Mattermost, from the Product menu |product-list|, select **App Marketplace**. 3. Search for or scroll to Microsoft Calendar, and select **Install**. 4. Once installed, select **Configure**. You're taken to the System Console, directly to the **Microsoft Calendar** integration page, under **Plugins**. diff --git a/source/integrate/microsoft-teams-interoperability.rst b/source/integrate/microsoft-teams-interoperability.rst index 0bc221de5c4..2b1347de2e2 100644 --- a/source/integrate/microsoft-teams-interoperability.rst +++ b/source/integrate/microsoft-teams-interoperability.rst @@ -94,7 +94,7 @@ Install and configure the Microsoft Teams integration in Mattermost These installation instructions assume you already have a Mattermost instance running v9.8.0 (or later) and configured to use PostgreSQL. This Mattermost integration doesn't support MySQL databases. -1. Log in to your Mattermost workspace as a system administrator. +1. Log in to your Mattermost :doc:`workspace ` as a system admin. 2. In Mattermost, from the Product menu |product-list|, select **App Marketplace**. 3. Search for or scroll to MS Teams, and select **Install**. 4. Once installed, select **Configure**. You're taken to the System Console. diff --git a/source/integrate/microsoft-teams-meetings-interoperability.rst b/source/integrate/microsoft-teams-meetings-interoperability.rst index bdae4064a79..695599b46e0 100644 --- a/source/integrate/microsoft-teams-meetings-interoperability.rst +++ b/source/integrate/microsoft-teams-meetings-interoperability.rst @@ -65,7 +65,7 @@ You're all set for configuration inside of the Azure portal. Install the Microsoft Teams Meetings integration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1. Log in to your Mattermost workspace as a system administrator. +1. Log in to your Mattermost :doc:`workspace ` as a system admin. 2. In Mattermost, from the Product menu |product-list|, select **App Marketplace**. 3. Search for or scroll to MS Teams Meetings, and select **Install**. 4. Once installed, select **Configure**. You're taken to the System Console, directly to the **MS Teams Meetings** integration page, under **Plugins**. diff --git a/source/manage/bulk-export-data.rst b/source/manage/bulk-export-data.rst index 9805cc5fd80..bb4ba53468a 100644 --- a/source/manage/bulk-export-data.rst +++ b/source/manage/bulk-export-data.rst @@ -5,7 +5,7 @@ Bulk export data .. tab:: Use mmctl - 1. Create a full export file including attachments by running the :ref:`mmctl export create -- attachments ` command. See the :ref:`Mattermost workspace migration ` documentation for details. + 1. Create a full export file including attachments by running the :ref:`mmctl export create -- attachments ` command. See the :ref:`Mattermost data migration ` documentation for details. 2. While the job is running, you can check its status by running the :ref:`mmctl export job show ` command. diff --git a/source/manage/logging.rst b/source/manage/logging.rst index fe5d6f8c5aa..5a77304707b 100644 --- a/source/manage/logging.rst +++ b/source/manage/logging.rst @@ -114,7 +114,7 @@ Audit logging (Beta) .. include:: ../_static/badges/ent-only.rst :start-after: :nosearch: -By default, Mattermost doesn’t write audit logs locally to a file on the server. You can enable and customize experimental audit logging in Mattermost to record activities and events performed within a Mattermost workspace, such as access to the Mattermost REST API or mmctl. +By default, Mattermost doesn’t write audit logs locally to a file on the server. You can enable and customize experimental audit logging in Mattermost to record activities and events performed within a Mattermost :doc:`workspace `, such as access to the Mattermost REST API or mmctl. .. tip:: From Mattermost v9.3, you can enable and customize advanced logging for AD/LDAP events separately from other logging. diff --git a/source/manage/team-channel-members.rst b/source/manage/team-channel-members.rst index d67f79c4f28..4bfce2e7049 100644 --- a/source/manage/team-channel-members.rst +++ b/source/manage/team-channel-members.rst @@ -112,8 +112,9 @@ Advanced access control settings enable system admins to restrict actions within - **Make channel read-only:** :ref:`Read-only channels ` enable system admins to turn off posting in specified channels. - **Restrict reactions:** Turn off the ability for members and guests to post reactions. -- **Restrict channel mentions:** Turn off the ability for users to post channel wide mentions (@all/channel/here) in specified channels. -- **Channel member management:** Only Admins have the ability to add and remove channel members in the specified channels. +- **Restrict channel mentions:** Turn off the ability for users to post channel wide mentions (@all/@channel/@here) in specified channels. +- **Channel member management:** Only admins have the ability to add and remove channel members in the specified channels. +- **Bookmarks management:** Only channel and system admins can :doc:`manage channel bookmarks `. These settings are modified in **System Console > User Management > Channels**. diff --git a/source/manage/telemetry.rst b/source/manage/telemetry.rst index ecbb9685609..a1718fe5cfb 100644 --- a/source/manage/telemetry.rst +++ b/source/manage/telemetry.rst @@ -18,7 +18,7 @@ We use the data for the following purposes to: .. note:: - Telemetry data collection is enabled by default for all Mattermost deployments. Self-hosted system admins can opt out of sharing telemetry data from Mattermost self-hosted servers within the System Console. Cloud system admins can't disable telemetry for Mattermost Cloud workspaces. + Telemetry data collection is enabled by default for all Mattermost deployments. Self-hosted system admins can opt out of sharing telemetry data from Mattermost self-hosted servers within the System Console. Cloud system admins can't disable telemetry for Mattermost Cloud deployments. Security update check feature ----------------------------- diff --git a/source/onboard/advanced-permissions-backend-infrastructure.rst b/source/onboard/advanced-permissions-backend-infrastructure.rst index 6692c687ab5..465af76ca4d 100644 --- a/source/onboard/advanced-permissions-backend-infrastructure.rst +++ b/source/onboard/advanced-permissions-backend-infrastructure.rst @@ -220,6 +220,22 @@ Permissions in Mattermost are a property of the server code base and are not cre +----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | manage_ldap_sync_job | system | Manage the status of an LDAP synchronization job. | +----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| add_bookmark_public_channel | channel | Add bookmarks to a public channel. | ++----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| add_bookmark_private_channel | channel | Add bookmarks to a private channel. | ++----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| edit_bookmark_public_channel | channel | Make changes to bookmarks in a public channel. | ++----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| edit_bookmark_private_channel | channel | Make changes to bookmarks in a private channel. | ++----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| delete_bookmark_public_channel | channel | Delete bookmarks in a public channel. | ++----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| delete_bookmark_private_channel | channel | Delete bookmarks in a private channel. | ++----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| order_bookmark_public_channel | channel | Reorder bookmarks in a public channel. | ++----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| order_bookmark_private_channel | channel | Reorder bookmarks in a private channel. | ++----------------------------------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ``Roles`` field ~~~~~~~~~~~~~~~ @@ -260,6 +276,14 @@ The following built-in roles and associated permissions are available: - remove_reaction - manage_public_channel_members - manage_channel_roles +- add_bookmark_public_channel +- edit_bookmark_public_channel +- delete_bookmark_public_channel +- order_bookmark_public_channel +- add_bookmark_private_channel +- edit_bookmark_private_channel +- delete_bookmark_private_channel +- order_bookmark_private_channel *channel_guest* @@ -293,6 +317,14 @@ The following built-in roles and associated permissions are available: - manage_private_channel_properties - create_post - edit_post +- add_bookmark_public_channel +- edit_bookmark_public_channel +- delete_bookmark_public_channel +- order_bookmark_public_channel +- add_bookmark_private_channel +- edit_bookmark_private_channel +- delete_bookmark_private_channel +- order_bookmark_private_channel *system_admin* @@ -416,6 +448,14 @@ The following built-in roles and associated permissions are available: - manage_elasticsearch_post_indexing_job - manage_elasticsearch_post_aggregation_job - manage_ldap_sync_job +- add_bookmark_public_channel +- edit_bookmark_public_channel +- delete_bookmark_public_channel +- order_bookmark_public_channel +- add_bookmark_private_channel +- edit_bookmark_private_channel +- delete_bookmark_private_channel +- order_bookmark_private_channel *system_custom_group_admin* @@ -591,6 +631,14 @@ The following built-in roles and associated permissions are available: - convert_public_channel_to_private - add_reaction - import_team +- add_bookmark_public_channel +- edit_bookmark_public_channel +- delete_bookmark_public_channel +- order_bookmark_public_channel +- add_bookmark_private_channel +- edit_bookmark_private_channel +- delete_bookmark_private_channel +- order_bookmark_private_channel *team_guest* diff --git a/source/onboard/guest-accounts.rst b/source/onboard/guest-accounts.rst index a9b08b110eb..011390d0595 100644 --- a/source/onboard/guest-accounts.rst +++ b/source/onboard/guest-accounts.rst @@ -17,7 +17,7 @@ Guest accounts are a way to collaborate with individuals, such as vendors and co .. important:: - For billing purposes, activated guest accounts do consume a licensed seat, which is returned when the guest account is deactivated.This means that guest accounts count as a paid user in your Mattermost workspace. However, guests aren't automatically added to the default **Town-square** and **Off-topic** channels when they log in. Guests must be invited/added to these channels manually. + For billing purposes, activated guest accounts do consume a licensed seat, which is returned when the guest account is deactivated.This means that 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. Guests must be invited/added to these channels manually. Enable guest accounts ---------------------- diff --git a/source/onboard/shared-channels.rst b/source/onboard/shared-channels.rst index 1d42763a537..b179a5b4046 100644 --- a/source/onboard/shared-channels.rst +++ b/source/onboard/shared-channels.rst @@ -46,7 +46,7 @@ Extend the invitation ~~~~~~~~~~~~~~~~~~~~~~ 1. Copy the invitation code blob in the System message, then send the code blob and the decryption password to the remote Mattermost aystem admin you want to securely connect with. -2. Ensure that the remote Mattermost instance can access your workspace URL listed in the System message. +2. Ensure that the remote Mattermost instance can access your :doc:`workspace ` URL listed in the System message. Remove a secure connection ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/preferences/customize-your-channel-sidebar.rst b/source/preferences/customize-your-channel-sidebar.rst index d191e06d42e..9d2ca81fed7 100644 --- a/source/preferences/customize-your-channel-sidebar.rst +++ b/source/preferences/customize-your-channel-sidebar.rst @@ -168,7 +168,7 @@ Control how many direct message conversations display in the **Direct Messages** To configure the number of direct messages to display, go to **Settings > Sidebar**, then set **Number of direct messages to show**. Or select the **Channel options** icon in the sidebar, then select **Show**. -Choose from **All direct messages**, or choose to show **10**, **15**, **20**, or **40** messages. Once you exceed the number of direct messages configured, older messages are hidden from the **Direct Messages** category. You can always increase the number of conversations displayed to see older direct messages. +Choose to show **10**, **15**, **20**, or **40** messages. Once you exceed the number of direct messages configured, older messages are hidden from the **Direct Messages** category. You can always increase the number of conversations displayed to see older direct messages. .. image:: ../images/dm-display.gif :alt: alt: Control the number of direct message conversations to display under the Direct Messages category by showing all messages or a fixed number of messages. diff --git a/source/preferences/manage-your-channel-specific-notifications.rst b/source/preferences/manage-your-channel-specific-notifications.rst index 862f685273d..88cf7e38ac0 100644 --- a/source/preferences/manage-your-channel-specific-notifications.rst +++ b/source/preferences/manage-your-channel-specific-notifications.rst @@ -8,6 +8,7 @@ By default, your web and desktop notification preferences apply to all channels - `Mute channels <#mute-channels>`__ - `Ignore channel-wide @mentions <#ignore-channel-wide-@mentions>`__ +- `Message notification sounds <#message-notification-sounds>`__ - `Auto-follow all new threads <#auto-follow-all-new-channel-threads>`__ .. tab:: Web/Desktop @@ -48,26 +49,20 @@ By default, you're notified every time someone uses channel-wide :doc:`@mentions When you choose to ignore channel-wide @mentions in channels, the channel name is bolded in the channel sidebar for new unreads unless it's muted. +Message notification sounds +--------------------------- + +From Mattermost v10.1, when you configure Mattermost to notify you about all new messages, or mentions, direct messages, and keywords only, on a per-channel basis, you can also specify an audible message notification sound to play for those notifications. + Follow all new channel threads ------------------------------- By default, you don’t automatically follow new conversation threads in any channel unless you start a thread or reply to a thread, follow a thread, or are @mentioned in a thread. -You can configure Mattermost to automatically follow every thread in a channel. - -.. tab:: Web/Desktop - - 1. Select the channel name to access more channel options. - 2. Select **Notification Preferences**. - 3. Under **Follow all threads in this channel**, select **Automatically follow threads in this channel**. - 4. Select **Save**. - - Select **Threads** in the channel sidebar to access all threads you're following, and to unfollow threads you no longer want to follow. - -.. tab:: Mobile +When using Mattermost on your mobile device, you can configure Mattermost to automatically follow every thread in a channel. - 1. In a channel, tap the **More** icon |more-icon| to the right of the channel name. - 2. Tap **View info**. - 3. Tap **Follow all threads**. +1. In a channel, tap the **More** icon |more-icon| to the right of the channel name. +2. Tap **View info**. +3. Tap **Follow all threads**. - Tap **Threads** in the channel list to access all threads you're following, and to unfollow threads you no longer want to follow. \ No newline at end of file +Tap **Threads** in the channel list to access all threads you're following, and to unfollow threads you no longer want to follow. \ No newline at end of file diff --git a/source/preferences/manage-your-display-options.rst b/source/preferences/manage-your-display-options.rst index 93a0381683b..316ead05be6 100644 --- a/source/preferences/manage-your-display-options.rst +++ b/source/preferences/manage-your-display-options.rst @@ -33,7 +33,7 @@ Threaded discussions Threaded discussions offers an enhanced experience for users communicating in threads and replying to messages. Threaded discussions are generally available in Mattermost Cloud and from self-hosted Mattermost v7.0, and are enabled by default for all new Mattermost deployments. -Depending on how your system admin has :ref:`configured threaded discussions ` for your workspace, it may already be enabled for you, or you may be able to enable this feature for your account. See our :doc:`organize conversations using threaded discussions ` documentation to learn more about working with threaded discussions. +Depending on how your system admin has :ref:`configured threaded discussions ` for your :doc:`workspace `, it may already be enabled for you, or you may be able to enable this feature for your account. See our :doc:`organize conversations using threaded discussions ` documentation to learn more about working with threaded discussions. .. tab:: Web/Desktop diff --git a/source/recipes/product-vulnerability-incident.rst b/source/recipes/product-vulnerability-incident.rst index 179dfc1bc8e..85d023f3f80 100644 --- a/source/recipes/product-vulnerability-incident.rst +++ b/source/recipes/product-vulnerability-incident.rst @@ -23,9 +23,9 @@ For Cloud customers, all the functionalities works out-of-the-box with no techni 2. Playbooks setup ~~~~~~~~~~~~~~~~~~ -Now that your workspace and teammates are ready, the next step is to create a playbook for incident handling. For this recipe, we're using an adapted playbooks template used by the Mattermost Product Security team that's available for `download here `__. +Now that your :doc:`workspace ` and teammates are ready, the next step is to create a playbook for incident handling. For this recipe, we're using an adapted playbooks template used by the Mattermost Product Security team that's available for `download here `__. -After downloading the template above, connect to your Mattermost workspace. Then open the product menu and select **Playbooks**. +After downloading the template above, connect to your Mattermost :doc:`workspace `. Then open the product menu and select **Playbooks**. .. image:: ../images/recipe/prod-vuln-incident1.png :alt: From the product menu, select Playbooks. diff --git a/source/scale/collect-performance-metrics.rst b/source/scale/collect-performance-metrics.rst index 5daf33acd60..8fe59d52094 100644 --- a/source/scale/collect-performance-metrics.rst +++ b/source/scale/collect-performance-metrics.rst @@ -21,12 +21,15 @@ Mattermost configuration For a self-hosted Mattermost deployment, a Mattermost system admin must perform the following steps in Mattermost. -1. Log in to your Mattermost workspace as a system administrator. -2. Download the latest version of `the plugin binary release `__, compatible with Mattermost v8.0.1 and later. If you are using an earlier version of Mattermost, :doc:`follow our documentation ` to upgrade to Mattermost v8.0.1 or later. -3. Go to **System Console > Plugins > Plugin Management > Upload Plugin**, and upload the plugin binary you downloaded in the previous step. -4. Go to **System Console > Plugins > Plugin Management**. In the **Installed Plugins** section, scroll to **Mattermost Metrics Plugin**, and select **Enable Plugin**. -5. Specify the path of the time-series database, and select **Save**. -6. Go to **System Console > Environment > Performance Monitoring**, and set **Enable Performance Monitoring** to **true**. Select **Save**. +1. Log in to your Mattermost :doc:`workspace ` as a system admin. +2. From Mattermost v10.1, you can install the Metrics plugin from the in-product Mattermost Marketplace by selecting the **Product** |product-list| icon and selecting **App Marketplace**. Search for **Metrics** and select **Install**. +3. Go to **System Console > Plugins > Plugin Management**. In the **Installed Plugins** section, scroll to **Mattermost Metrics Plugin**, and select **Enable Plugin**. +4. Specify the path of the time-series database, and select **Save**. +5. Go to **System Console > Environment > Performance Monitoring**, and set **Enable Performance Monitoring** to **true**. Select **Save**. + +.. note:: + + For Mattermost deployments prior to v10.1, you must download the latest version of `the plugin binary release `__, compatible with Mattermost v8.0.1 and later. Go to **System Console > Plugins > Plugin Management > Upload Plugin**, and upload the plugin binary you downloaded. Upgrade ------- diff --git a/source/upgrade/open-source-components.rst b/source/upgrade/open-source-components.rst index d9f73fb238a..ee5d3df5ccc 100644 --- a/source/upgrade/open-source-components.rst +++ b/source/upgrade/open-source-components.rst @@ -32,6 +32,7 @@ Desktop Mobile ------- +- Mattermost Mobile v2.21.0 - `View Open Source Components `__. - Mattermost Mobile v2.20.0 - `View Open Source Components `__. - Mattermost Mobile v2.19.0 - `View Open Source Components `__. - Mattermost Mobile v2.18.0 - `View Open Source Components `__. @@ -113,6 +114,7 @@ Mobile Server ------------------------------ +- Mattermost Enterprise Edition v10.1.0 - `View Open Source Components `__. - Mattermost Enterprise Edition v10.0.0 - `View Open Source Components `__. - Mattermost Enterprise Edition v9.11.0 - `View Open Source Components `__. - Mattermost Enterprise Edition v9.10.0 - `View Open Source Components `__.