diff --git a/source/about/editions-and-offerings.rst b/source/about/editions-and-offerings.rst index e5dbdc3d412..1e67221238c 100644 --- a/source/about/editions-and-offerings.rst +++ b/source/about/editions-and-offerings.rst @@ -45,8 +45,8 @@ For customers using our service in a self-hosted deployment, the Mattermost Free The Mattermost Professional and Mattermost Enterprise editions are only available after deploying our Mattermost Enterprise Edition code base, and then applying a valid license key that comes with a subscription purchase, or by starting a 30-day free trial that can be activated either in-product (**System Console > Edition and License > Start trial**) or online at https://mattermost.com/trial/. -Mattermost Free ---------------- +Mattermost Free (Self-Hosted only) +--------------------------------------------- Mattermost Free is a set of collaboration features for accelerating your technical team’s productivity, shipping software faster with higher quality, and improving alignment among team members. diff --git a/source/about/install-mattermost-app-in-microsoft-teams.rst b/source/about/install-mattermost-app-in-microsoft-teams.rst index cbdfab6530f..1fa15e495e6 100644 --- a/source/about/install-mattermost-app-in-microsoft-teams.rst +++ b/source/about/install-mattermost-app-in-microsoft-teams.rst @@ -4,13 +4,15 @@ Install the Mattermost App in Microsoft Teams .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -.. note:: +With `Mattermost for Microsoft Teams `__, you can embed your Mattermost workspace within your Microsoft Teams instance and take advantage of `embedded app features <#benefits-of-the-embedded-app>`_. - You must `install the Microsoft Teams plugin in Mattermost `__ before you can install the Mattermost app in Microsoft Teams. +.. important:: + + You must `install the Microsoft Teams plugin in Mattermost `__ before you can embed the Mattermost app within Microsoft Teams. To install the Mattermost app in Microsoft Teams: -1. In Mattermost, as an administrator, go to System Console > Plugins > Mattermost for Microsoft Teams. At the bottom of the settings page, select **Download Manifest** to download a ZIP file containing the Microsoft Teams application manifest pre-configured for your Mattermost workspace. +1. In Mattermost, as an administrator, go to **System Console > Plugins > MSTeams Sync**. At the bottom of the settings page, select **Download Manifest** to download a ZIP file containing the Microsoft Teams application manifest pre-configured for your Mattermost workspace. 2. In Microsoft Teams, as an administrator, go to the Microsoft Teams admin center under **Teams Apps > Manage Apps**, or use the following URL: ``https://admin.teams.microsoft.com/policies/manage-apps``. 3. Select **Upload new app**, then upload the app manifest you downloaded in the previous step. @@ -20,27 +22,52 @@ Pin the Mattermost app in Microsoft Teams ------------------------------------------ 1. Add the Mattermost app by selecting **Apps** within the left-hand sidebar, select **Add** located next to the Mattermost for Microsoft Teams app, then select **Add** again. Once added, your Mattermost workspace is now embedded in your Microsoft Teams instance. -2. Pin the Mattermost app in your left-hand sidebar to access it easily in the future, by right-clicking the Mattermost tab and selecting **Pin**. -3. Sign in with your email/password credentials, and use the Mattermost app to collaborate with technical and operations teams. +2. Pin the Mattermost app in your left-hand sidebar, to access it easily in the future, by right-clicking the Mattermost tab and selecting **Pin**. +3. Sign in with your credentials, and use the Mattermost app to collaborate with technical and operations teams. + +Demonstration: Embed Mattermost within Microsoft Teams +------------------------------------------------------- + +Check out this `YouTube demo `__, from Doug Lauder, Senior Software Design Engineer at Mattermost, to learn how to embed Mattermost within Microsoft Teams: + +.. raw:: html + + + + +Get users started with the embedded app +---------------------------------------- + +See our end user documentation for a `video walkthrough of using Mattermost embedded within Microsoft Teams `__. + +Benefits of the embedded app +---------------------------- + +- **Improved reaction time in the event of an incident** by accessing alerting features in Mattermost directly from within Microsoft Teams. + + Mattermost is open-source and can be extensively customized to integrate with various system monitoring and alerting tools. If your tech team has set up unique alerting features in Mattermost, use the app to access these directly from within Teams, including system status updates, improving reaction time in the event of an incident. + +- **Simplified workflows through a single interface** for communication and DevOps management. + + If your technical team uses specific DevOps tools (such as Jenkins, Jira, GitHub, etc.) that are tightly integrated with Mattermost, embedding Mattermost in Teams can give direct access to these integrated services. This simplifies workflows by providing a single interface for DevOps use cases. + +- **Quickly run scripts within Microsoft Teams**. + + Mattermost supports the use of a CLI, which can be a major advantage for tech teams. If you need to run scripts or execute commands via Mattermost, embedding it within Teams allows you to use this functionality from either platform. + +- **Embed custom functionality to accelerate technical workflows**. + + If your tech team has created custom bots and plugins that function with Mattermost, embedding it within Microsoft Teams will allow everyone to access these utilities. These may include custom bots for streamlining incident management, security operations and red/blue team workflows. Limitations ------------ -The Mattermost app currently only supports email/password log in to the Mattermost workspace. SSO authentication with SAML 2.0 providers (Okta, OneLogin, Microsoft ADFS) and with your Microsoft365 account are under consideration. +The embedded Mattermost app currently only supports email/password log in to the Mattermost workspace. SSO authentication with SAML 2.0 providers (Okta, OneLogin, Microsoft ADFS) and with your Microsoft365 account are under consideration. -Troubleshooting ----------------- +Get help +--------- If you face any issues while installing or using the app in Microsoft Teams, you can either: - Open a new issue in the `Mattermost for Microsoft Teams GitHub repository `__. -- Or, create a new topic in our `peer-to-peer troubleshooting forum `__. - -Demonstration --------------- - -Check out this `YouTube demo `__, from Doug Lauder, Senior Software Design Engineer at Mattermost, to get started with Mattermost for Microsoft Teams: - -.. raw:: html - - \ No newline at end of file +- Or, create a new topic in our `peer-to-peer troubleshooting forum `__. \ No newline at end of file diff --git a/source/about/install-mattermost-for-microsoft-teams-plugin.rst b/source/about/install-mattermost-for-microsoft-teams-plugin.rst index 15ed73d2b7b..6acd8cf8de2 100644 --- a/source/about/install-mattermost-for-microsoft-teams-plugin.rst +++ b/source/about/install-mattermost-for-microsoft-teams-plugin.rst @@ -7,26 +7,47 @@ Install the Mattermost for Microsoft Teams plugin To install the `Mattermost for Microsoft Teams `__ plugin in Mattermost: 1. Log in to your Mattermost workspace as a system administrator. -2. Download the `latest plugin binary release `__, compatible with Mattermost v8.0.1 and later. +2. Download version v0.3.9 of `the plugin binary release `__, compatible with Mattermost v8.0.1 and later. .. tip:: If you are using an earlier version of Mattermost, `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 > Installed Plugins**, search for ``MS Teams Sync``, and select **Enable Plugin**. +4. Go to **System Console > Plugins > Plugin Management**. In the **Installed Plugins** section, scroll to **MS Teams Sync**, and select **Enable Plugin**. + +Configure how users will connect accounts +------------------------------------------ + +Mattermost admins can configure Mattermost to automatically prompt users to connect their Mattermost user account to their Microsoft Teams user account on login. + +1. Go to **System Console > Plugins > MS Teams Sync**. +2. Enable **Enforce connected accounts** to prompt users to connect if they haven't done so. +3. (Optional) Enable **Allow to temporarily skip connect user** to allow users to skip the connection prompt temporarily. Users are prompted on refresh and login. Configure the plugin -------------------- Additional configuration settings are available for this plugin. See the `MS Teams Sync plugin configuration settings `__ documentation for details. -Demonstration --------------- +Get started with the plugin +--------------------------- + +See our `collaborate using Mattermost for MS Teams `__ documentation for details on how to collaborate across both Mattermost and Microsoft Teams at the same time. + +Troubleshooting +--------------- + +If you encounter issues when connecting user accounts or linking channels, we recommend restarting the plugin as a Mattermost system admin. + +1. Go to **System Console > Plugins > Plugin Management**. +2. Under **Installed Plugins**, scroll to the **MSTeams Sync** section, select **Disable** then wait for the State to change to **Not running**. +3. Select **Enable** and wait for the State to change to **Running**. -Check out this `YouTube demo `__, from Doug Lauder, Senior Software Design Engineer at Mattermost, to learn how to embed Mattermost in Microsoft Teams: +Get help +--------- -.. raw:: html - - +If you face any issues while installing the Mattermost for Microsoft Teams sync plugin, you can either: +- Open a new issue in the `Mattermost for Microsoft Teams GitHub repository `__. +- Or, create a new topic in our `peer-to-peer troubleshooting forum `__. diff --git a/source/about/mattermost-for-microsoft-teams.rst b/source/about/mattermost-for-microsoft-teams.rst index 44e3ddb4c02..d923f3c28f6 100644 --- a/source/about/mattermost-for-microsoft-teams.rst +++ b/source/about/mattermost-for-microsoft-teams.rst @@ -15,21 +15,4 @@ See the following product documentation to install and use Mattermost for Micros - `Install the Mattermost app in Microsoft Teams `__ - `Collaborate using Mattermost for Microsoft Teams `__ -Additional integration features include: - -- **Improved reaction time in the event of an incident** by accessing alerting features in Mattermost directly from within Teams. - - Mattermost is open-source and can be extensively customized to integrate with various system monitoring and alerting tools. If your tech team has set up unique alerting features in Mattermost, use the app to access these directly from within Teams, including system status updates, improving reaction time in the event of an incident. - -- **Simplified workflows through a single interface** for communication and DevOps management. - - If your technical team uses specific DevOps tools (such as Jenkins, Jira, GitHub, etc.) that are tightly integrated with Mattermost, embedding Mattermost in Teams can give direct access to these integrated services. This simplifies workflows by providing a single interface for DevOps use cases. - -- The ability to **quickly run scripts within Microsoft Teams**. - - Mattermost supports the use of a CLI, which can be a major advantage for tech teams. If you need to run scripts or execute commands via Mattermost, embedding it within Teams allows you to use this functionality from either platform. - -- The ability to **embed custom functionality to accelerate technical workflows**. - - If your tech team has created custom bots and plugins that function with Mattermost, embedding it within Teams will allow everyone to access these utilities. These may include custom bots for streamlining incident management, security operations and red/blue team workflows. diff --git a/source/channels/collaborate-using-mattermost-for-microsoft-teams.rst b/source/channels/collaborate-using-mattermost-for-microsoft-teams.rst index 161c492a9fc..52b3ee13409 100644 --- a/source/channels/collaborate-using-mattermost-for-microsoft-teams.rst +++ b/source/channels/collaborate-using-mattermost-for-microsoft-teams.rst @@ -4,6 +4,75 @@ Collaborate using Mattermost for MS Teams .. include:: ../_static/badges/allplans-cloud-selfhosted.rst :start-after: :nosearch: -Mattermost for Microsoft Teams enables you to collaborate with technical & operations teams seamlessly through the Mattermost app, without leaving Microsoft Teams. +.. |plus-icon| image:: ../images/plus_F0415.svg + :alt: Open menus using the plus icon. -Join us on `Mattermost Academy `__ to enroll in the `Mattermost for Microsoft Teams `__ training course where you'll learn how to start collaborating with colleagues across both systems. \ No newline at end of file +`Mattermost for Microsoft Teams `__ enables you to collaborate with technical & operations teams seamlessly through the Mattermost app, without leaving Microsoft Teams. + +Join us on `Mattermost Academy `__ to enroll in the `Mattermost for Microsoft Teams `__ training course where you'll learn how to start collaborating with colleagues across both systems. + +Connect your Mattermost account to your MS Teams account +--------------------------------------------------------- + +To use the Mattermost for Microsoft Teams plugin, you must connect your Mattermost user account to Microsoft Teams. You only need to complete this step once. + +1. Log into Mattermost using your credentials. +2. When you log in, you’ll be prompted to enter your Microsoft Teams user information, including your Microsoft Teams email address and your Microsoft Teams password. + +Mattermost will tell you when you’ve successfully connected your account. + +.. note:: + + - If you're not prompted to connect your accounts, display the prompt in a browser window by running the Mattermost slash command ``/msteams-sync connect`` in Mattermost. Follow the link to connect your accounts. + - To change which accounts are linked, in Mattermost, run the slash command ``/msteams-sync disconnect``, then connect your Mattermost account to a new Microsoft Teams account. + - If a Microsoft Teams user account is removed from Microsoft Teams, the linked Mattermost user account is also removed the next time user accounts are synchronized. + +Once you've connected your Mattermost account to your Microsoft Teams account, you’re ready to collaborate across your organization, regardless of which tool you’re in. You have two ways to collaborate: + +- `Through direct and group messages <#collaborate-through-messages>`_ +- `Through linked channels <#collaborate-through-linked-channels>`_ + +Collaborate through messages +---------------------------- + +You can start a direct or group message between Mattermost and Microsoft Teams users unless your Mattermost administrator has `disabled the ability to do so in the System Console `__. + +- Within Mattermost select the |plus-icon| icon next to **Direct Messages** in the left pane, then search for the user you want to message. Your direct or group conversation is visible in both Mattermost and Microsoft Teams. + +- Within Microsoft Teams, select **Chat > New chat**, and select the users you want to chat with. Your conversation is visible in both Mattermost and Microsoft Teams for all users who have connected their Mattermost user account to their Microsoft Teams user account. + +Collaborate through linked channels +------------------------------------ + +Collaborating through linked channels starts with a Mattermost admin linking a Mattermost public or private channel to a Microsot Teams channel. + +Link channels +~~~~~~~~~~~~~~ + +As a Mattermost channel admin, team admin, or system admin, run the following slash command in the channel you want to link: ``/msteams-sync link``, then select the Microsoft Teams team and channel identifiers you want to link the current Mattermost channel to. Mattermost notifies you when the linking is complete or if the channel is already linked. + +.. tip:: + + Want to change an existing link? Unlink a current Mattermost channel using the ``/msteams-sync unlink`` slash command, then relink to a new Microsoft Teams channel as needed. + +Collaborate with colleagues +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You have many ways to collaborate with colleagues in linked channels using a web browser or the Mattermost desktop app, including: + +- `Send messages `__ and `reply to messages `__ +- `Attach files to messages `__ +- `Express yourself with emojis `__ +- `Share complex systems data and formatted code `__ +- `Edit or delete sent messages `__ + +No matter which tool you use, your message is visible across both Mattermost and Microsoft Teams. + +Demonstration: Mattermost embedded in Microsoft Teams +------------------------------------------------------ + +Check out this `YouTube demo `__, from Doug Lauder, Senior Software Design Engineer at Mattermost, to learn more about using the embedded Mattermost instance within Microsoft Teams: + +.. raw:: html + + \ No newline at end of file diff --git a/source/channels/organize-conversations.rst b/source/channels/organize-conversations.rst index 244a405b9e9..0b5f2180813 100644 --- a/source/channels/organize-conversations.rst +++ b/source/channels/organize-conversations.rst @@ -101,4 +101,3 @@ In particular, please be aware of these important known issues and risks: - You may experience lag in your desktop or web client if you're following many threads or opening threads with many replies. - Server performance for instances with many users and posts may be impacted. - You should expect to see more unread channels and notifications on your mobile device than you'll see on your desktop instance of Mattermost. This is expected when running a mobile app release older than v1.46. - - For a comprehensive list of known issues, and to see our work queue in priority order, check out our `Kanban board `__. \ No newline at end of file diff --git a/source/configure/enabling-chinese-japanese-korean-search.rst b/source/configure/enabling-chinese-japanese-korean-search.rst index d0a5474c564..dbee269f614 100644 --- a/source/configure/enabling-chinese-japanese-korean-search.rst +++ b/source/configure/enabling-chinese-japanese-korean-search.rst @@ -1,6 +1,6 @@ .. _i18n: -Chinese, Japanese, and Korean search +Chinese, Japanese and Korean search ====================================== .. include:: ../_static/badges/allplans-selfhosted.rst @@ -18,65 +18,92 @@ Below is additional information on how to configure the database for different l 中文 / Chinese -------------- -数据库版本请参考： `配置要求 `__ 。 -其中MySQL的ngram配置可以参考 `Cannot search CJK contents `__ 。 +尽管在 Mattermost 8.0 更新后，官方推荐为了更好的性能请使用 PostgreSQL 作为后端数据库。 -更多中文相关问题讨论请访问 `中文讨论组 `__ 。 +但就目前而言，使用 MySQL 能够更容易的实现中文语言的全文搜索功能，在妥善配置 ngram 后，根据官方数据库构造重新生成索引即可达成。 +具体的操作方式，可参考： `Cannot search CJK contents `__。 -以Ubuntu 14.04 PostgreSQL 9.3 数据库 mattermost 为例。 +有关 PostgreSQL 的配置方式，请参考以下流程： -编译scws -~~~~~~~~ +配置 SCWS +~~~~~~~~~~ .. code:: bash - wget -q -O - http://www.xunsearch.com/scws/down/scws-1.2.2.tar.bz2 | tar xjf - - cd scws-1.2.2 - ./configure - make install - -编译zhparser -~~~~~~~~~~~~ + # 取得 SCWS 代码 + wget http://www.xunsearch.com/scws/down/scws-1.2.3.tar.bz2 + # 解压缩 + tar xvjf scws-1.2.3.tar.bz2 + # 进入解压后的目录 + cd scws-1.2.3 + # 执行配置脚本、编译并安装 + ./configure --prefix=/usr/local/scws ; make ; make install + + # 可选：检查文件是否存在 + ls -al /usr/local/scws/lib/libscws.la + /usr/local/scws/bin/scws -h + # 可选：将词典安装在 /usr/local/scws/etc 中 + cd /usr/local/scws/etc + wget http://www.xunsearch.com/scws/down/scws-dict-chs-gbk.tar.bz2 + wget http://www.xunsearch.com/scws/down/scws-dict-chs-utf8.tar.bz2 + tar xvjf scws-dict-chs-gbk.tar.bz2 + tar xvjf scws-dict-chs-utf8.tar.bz2 + +配置 Zhparser +~~~~~~~~~~~~~~ .. code:: bash - sudo apt-get install --yes postgresql-server-dev-9.3 libpq-dev + # 下载 Zhparser 源代码 git clone https://github.com/amutu/zhparser.git - SCWS_HOME=/usr/local make && make install + # 进入下载后的目录 + cd zhparser + # 编译并安装 + SCWS_HOME=/usr/local/scws make && make install .. note:: - 通过 Docker 镜像（mattermost/mattermost-prod-db）应用数据库的用户，请按照下述方法安装依赖项。 - .. code:: bash + 自 Mattermost 6.0 起，官方已不再使用 mattermost/mattermost-prod-db 作为数据库镜像，你可以直接使用安装在服务器上的 PostgreSQL 数据库，或者使用 PostgreSQL 官方的 Docker 镜像。 + + 如果使用 Docker 镜像作为数据库，可以预先执行以下命令，安装依赖（请根据实际的 PostgreSQL 版本选择）。 - # Alpine 通过 apk add 命令安装依赖项 - apk add wget tar gcc git postgresql-dev + .. code:: bash -创建extension以及增加解析配置 + # 更新本地缓存 + apt update + # 配置 SCWS 时需要的依赖 + apt install wget make gcc + # 配置 Zhparser 时需要的依赖 + apt install git postgresql-server-dev-13 + +创建 extension 并增加解析配置 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. code:: bash +.. code:: sql - sudo -i -u postgres - psql mattermost -c 'CREATE EXTENSION zhparser' - psql mattermost -c 'CREATE TEXT SEARCH CONFIGURATION simple_zh_cfg (PARSER = zhparser);' - psql mattermost -c 'ALTER TEXT SEARCH CONFIGURATION simple_zh_cfg ADD MAPPING FOR n,v,a,i,e,l WITH simple;' + -- 创建 extension + CREATE EXTENSION zhparser + -- 创建 text search configuration + CREATE TEXT SEARCH CONFIGURATION simple_zh_cfg (PARSER = zhparser); + -- 配置 token mapping + ALTER TEXT SEARCH CONFIGURATION simple_zh_cfg ADD MAPPING FOR n,v,a,i,e,l WITH simple; -设置postgresql -~~~~~~~~~~~~~~ +更新 PostgreSQL 配置 +~~~~~~~~~~~~~~~~~~~~~ -将 /etc/postgresql/9.3/main/postgresql.conf 中 default_text_search_config 的值更改为 simple_zh_cfg，然后重启postgresql: sudo service postgresql restart +将 postgresql.conf 中的 default_text_search_config 的值更改为 simple_zh_cfg。 -调试 -~~~~ +更改后，需要重启数据库方可生效。 -可以打开 mattermost 的配置 config/config.json 中 SqlSettings 的设置 Trace: true，然后可以在mattermost的标准输出看到执行的SQL语句。 +.. note:: -.. code:: sql + 配置完成后，需根据 Mattermost 官方仓库中的 SQL 建表语句重新创建索引，方可正式启用中文语言的全文搜索功能。 + + 未尽事宜，可以参考以下链接： - SELECT to_tsvector('simple_zh_cfg', '开始全面整修道路'); - SELECT to_tsvector('simple_zh_cfg', '开始全面整修道路') @@ to_tsquery('simple_zh_cfg', '全面'); - SELECT * FROM Posts WHERE Message @@ to_tsquery('simple_zh_cfg', '全面'); + - `SCWS 官方文档 `__ + - `Zhparser 官方文档 `__ + - `Mattermost 建表语句 `__ 日本語 / Japanese ----------------- diff --git a/source/install/cloud-changelog.md b/source/install/cloud-changelog.md index 7f2649172c6..b85183da800 100644 --- a/source/install/cloud-changelog.md +++ b/source/install/cloud-changelog.md @@ -4,12 +4,22 @@ This changelog summarizes updates to [Mattermost Cloud](https://mattermost.com/g Latest Mattermost Cloud releases: +- [Release 2023-07-20](#release-2023-07-20) +- [Release 2023-07-19](#release-2023-07-19) - [Release 2023-07-11](#release-2023-07-11) - [Release 2023-06-26](#release-2023-06-26) - [Release 2023-06-13](#release-2023-06-13) - [Release 2023-05-31](#release-2023-05-31) -- [Release 2023-05-01](#release-2023-05-01) -- [Release 2023-04-21](#release-2023-04-21) + +## Release 2023-07-20 + +### Bug Fixes + - Added support for a new Cloud Export storage and a presigned URL generation. + +## Release 2023-07-19 + +### Bug Fixes + - Fixed an issue where a "Seeker can't seek" error was displayed when viewing older image attachments. ## Release 2023-07-11 diff --git a/source/manage/cloud-data-export.rst b/source/manage/cloud-data-export.rst index 1c92018a87c..4556951aa7c 100644 --- a/source/manage/cloud-data-export.rst +++ b/source/manage/cloud-data-export.rst @@ -37,7 +37,7 @@ Authentication is done with either Mattermost login credentials or an authentica .. code:: - $ mmctl auth login https://yourdomain.cloud.mattermost.com + mmctl auth login https://yourdomain.cloud.mattermost.com You'll be prompted for a username (use your admin user), password, and for a connection name. The connection name can be anything you want, and it's used to identify this set of credentials in the future, for your convenience. Then you will be able to start the export process. @@ -48,9 +48,9 @@ Once you're logged in, run: .. code:: - $ mmctl export create --attachments + mmctl export create -This will create a full export of the server, and include attached files. Leave out ``--attachments`` if you do not wish to export attached files from your instance. This process can take some time, so ``mmctl`` will return immediately, and the job will run in the background on the Mattermost instance until the export is fully created. If successful, the command will immediately output a job ID, like this: +This will create a full export of the server, and include attached files. Append ``--no-attachments`` if you do not wish to export attached files from your instance. This process can take some time, so ``mmctl`` will return immediately, and the job will run in the background on the Mattermost instance until the export is fully created. If successful, the command will immediately output a job ID, like this: .. code:: @@ -60,11 +60,11 @@ While the job is running, its status can be checked using the ID that was provid .. code:: - $ mmctl export job show yfrr9ku5i7fjubeshs1ksrknzc - ID: yfrr9ku5i7fjubeshs1ksrknzc - Status: success - Created: 2021-11-03 10:44:13 -0500 CDT - Started: 2021-11-03 10:44:23 -0500 CDT + mmctl export job show yfrr9ku5i7fjubeshs1ksrknzc + ID: yfrr9ku5i7fjubeshs1ksrknzc + Status: success + Created: 2021-11-03 10:44:13 -0500 CDT + Started: 2021-11-03 10:44:23 -0500 CDT Download the export ------------------- @@ -73,14 +73,14 @@ Once the status is ``success``, you can download the export onto your local mach .. code:: - $ mmctl export list + mmctl export list r3kcj8yuwbramdt714doafi3oo_export.zip This will show all of the exports on the server, so be sure to download the latest one and to delete it when you're done to save storage. Download the file with a command like the following, but with the filename of the export on your server: .. code:: - $ mmctl export download r3kcj8yuwbramdt714doafi3oo_export.zip + mmctl export download r3kcj8yuwbramdt714doafi3oo_export.zip Upload the export to the new server ----------------------------------- @@ -89,7 +89,7 @@ Finally, it's time to take our export from the source server and use it as an im .. code:: - $ mmctl auth login https://localinstance.company.com + mmctl auth login https://localinstance.company.com Use the following command to upload the export to the destination server. The speed of the upload may vary based on connection speed. When the upload is complete the command will return with the ID of the import: @@ -104,33 +104,33 @@ Complete the import into the new server .. code:: - $ mmctl import list available + mmctl import list available cfuq6q9kkjrqfgnph1pew3db4e_r3kcj8yuwbramdt714doafi3oo_export.zip Run the import job to process to import the export file into the server. The speed of this process may vary based on connection speed. First, start the import process: .. code:: - $ mmctl import process cfuq6q9kkjrqfgnph1pew3db4e_r3kcj8yuwbramdt714doafi3oo_export.zip + mmctl import process cfuq6q9kkjrqfgnph1pew3db4e_r3kcj8yuwbramdt714doafi3oo_export.zip Once you've marked the file for processing, you can check the status of the job using ``mmctl import job list``: .. code:: - $ mmctl --local import job list - ID: f93jxu1hzty79enwa1xy6f1tbr - Status: pending - Created: 2021-10-28 13:32:55 +0200 CEST + mmctl --local import job list + ID: f93jxu1hzty79enwa1xy6f1tbr + Status: pending + Created: 2021-10-28 13:32:55 +0200 CEST When the job is complete, the ``success`` status is displayed: .. code:: - $ mmctl --local import job list - ID: f93jxu1hzty79enwa1xy6f1tbr - Status: success - Created: 2021-10-28 13:32:55 +0200 CEST - Started: 2021-10-28 13:33:05 +0200 CEST + mmctl --local import job list + ID: f93jxu1hzty79enwa1xy6f1tbr + Status: success + Created: 2021-10-28 13:32:55 +0200 CEST + Started: 2021-10-28 13:33:05 +0200 CEST Then extract the export file to use it by running the following mmctl command: @@ -174,7 +174,7 @@ Use your administrator credentials to log into your self-hosted Mattermost serve .. code:: - $ mmctl export create --attachments + mmctl export create --attachments This creates a full export of the server, and includes attached files. If you don’t want to export attached files, leave out ``--attachments``. @@ -188,15 +188,14 @@ While the job is running, its status can be checked using the ID that was provid .. code:: - $ mmctl export job show yfrr9ku5i7fjubeshs1ksrknzc - ID: yfrr9ku5i7fjubeshs1ksrknzc - Status: success - Created: 2021-11-03 10:44:13 -0500 CDT - Started: 2021-11-03 10:44:23 -0500 CDT + mmctl export job show yfrr9ku5i7fjubeshs1ksrknzc + ID: yfrr9ku5i7fjubeshs1ksrknzc + Status: success + Created: 2021-11-03 10:44:13 -0500 CDT + Started: 2021-11-03 10:44:23 -0500 CDT The completed file will be downloaded to your desktop as a ``.zip`` file. - .. note:: Do not rename the file as the file name is referenced in log files, which are used by the Support team to validate the exported file. diff --git a/source/manage/mmctl-command-line-tool.rst b/source/manage/mmctl-command-line-tool.rst index cfaab42f641..1fd7a04dcf9 100644 --- a/source/manage/mmctl-command-line-tool.rst +++ b/source/manage/mmctl-command-line-tool.rst @@ -2277,7 +2277,7 @@ Create an export file. .. code-block:: sh - --no-attachments Set to true to include file attachments in the export file. + --no-attachments Omit to include file attachments in the export file. -h, --help help for create **Options inherited from parent commands** diff --git a/source/onboard/migrating-to-mattermost.rst b/source/onboard/migrating-to-mattermost.rst index 8728e79b31e..8739dee18a7 100644 --- a/source/onboard/migrating-to-mattermost.rst +++ b/source/onboard/migrating-to-mattermost.rst @@ -211,6 +211,13 @@ Debugging imports The ``mmctl import job show`` shows a detailed error message. If you run into problems which the error message does not help to resolve, your best bet is to use the ``mattermost bulk import`` command. The ``mmctl`` import process does not give you any additional debugging information, even in the Mattermost server logs. +Additional tools +^^^^^^^^^^^^^^^^ + +* `mm-emoji `__ - Designed to smoothly transition emojis from a Slack instance to Mattermost. +* `mm-importjs `__ - Breaks up large import files into smaller ones, as well as automatically remove null characters in post content when importing data to Mattermost. +* `slack-migrate-pinned-posts `__ - Migrates pinned posts from Slack to Mattermost. + Use the Mattermost web app (deprecated) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/onboard/sso-gitlab.rst b/source/onboard/sso-gitlab.rst index fee38425a90..836945085a8 100644 --- a/source/onboard/sso-gitlab.rst +++ b/source/onboard/sso-gitlab.rst @@ -15,7 +15,7 @@ Follow these steps to configure Mattermost to use GitLab as a Single Sign-on (SS - Mattermost's open source Team Edition supports the OAuth 2.0 standard. - Mattermost Professional and Enterprise support the OpenID Connect standard. -Step 1: Add an OpenID Connect application to your GitLab account +Step 1: Add a Mattermost application to your GitLab account ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1. Log in to your GitLab account, then go to ``https://{gitlab-site-name}/profile/applications``. For *{gitlab-site-name}* use the name of your GitLab instance. If you're using GitLab itself as your service provider, use ``gitlab.com``. @@ -46,11 +46,11 @@ Step 2: Configure Mattermost for GitLab SSO 1. Log in to Mattermost, then go to **System Console > Authentication > OpenID Connect**. 2. Select **GitLab** as the service provider. -3. Enter the **Gitlab Site URL** of your GitLab instance. If your GitLab instance is not set up to use SSL, start the URL with ``http://`` instead of ``https://``. If you are using GitLab itself as your provider, use ``gitlab.com``. +3. Enter the **GitLab Site URL** of your GitLab instance. If your GitLab instance is not set up to use SSL, start the URL with ``http://`` instead of ``https://``. If you are using GitLab itself as your provider, use ``gitlab.com``. 4. The **Discovery Endpoint** for OpenID Connect with GitLab is prepopulated with ``https://gitlab.com/.well-known/openid-configuration``. 5. Paste the **Application ID** from GitLab as the **Client ID** in Mattermost. 6. Paste the **Application Secret Key** from GitLab as the **Client Secret** in Mattermost. -7. Update the ``config.json`` file and specify the scopes you selected in GitLab under the ``GitLabSettings`` property. At a minimum, ``openid`` is a required scope for Mattermost Professional and Enterprise, and `read_user` is a required scope for Mattermost Team Edition. Changes to this setting require a server restart before taking effect. +7. Update the ``config.json`` file and specify the scopes you selected in GitLab under the ``GitLabSettings`` property. At a minimum, ``openid`` is a required scope for Mattermost Professional and Enterprise, and ``read_user`` is a required scope for Mattermost Team Edition. Mattermost Team Edition does not work with scopes other than ``read_user``. Changes to this setting require a server restart before taking effect. 8. Select **Save**. .. note::