Skip to content

Commit 6578922

Browse files
committed
Update the Slack import docs with latest features.
This updates the Slack import docs, in particular to note the fact that Bot messages, and file attachments can now be imported. PLT-4280.
1 parent d672997 commit 6578922

File tree

2 files changed

+69
-25
lines changed

2 files changed

+69
-25
lines changed

source/administration/migrating.rst

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,70 @@ The following instructions migrate Mattermost from one server to another by back
2626
Migrating from Slack
2727
====================
2828

29-
You can import channels and users from Slack into Mattermost from Team Settings > Import. Please review our documentation on `Slack Import <https://docs.mattermost.com/help/settings/team-settings.html#import-from-slack-beta>`_ for more details.
29+
.. note:: As a proprietary SaaS service, Slack is able to change its export format quickly and without notice. If you encounter issues not mentioned in the documentation below, please alert the product team by `filing an issue <https://github.com/mattermost/platform/issues>`_.
30+
31+
The Slack Import feature in Mattermost is in "Beta" and focus is on supporting migration of teams of less than 100 registered users.
32+
33+
This feature can be accessed through the `Mattermost Web App </administration/migrating.html#migrating-from-slack-using-the-mattermost-web-app>`_ or using the `CLI </administration/migrating.html#migrating-from-slack-using-the-mattermost-cli>`_.
34+
35+
.. warning:: **It is highly recommended that you test Slack import before applying it to an instance intended for production.**
36+
37+
If you use Docker, you can spin up a test instance in one line (``docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform``). If you don't use Docker, there are `step-by-step instructions <http://docs.mattermost.com/install/docker-local-machine.html>`_ to install Mattermost in preview mode in less than 5 minutes.
38+
39+
Supported Features
40+
++++++++++++++++++
41+
42+
The following key features are supported out of the box when importing from Slack:
43+
44+
* User accounts with and email address set.
45+
46+
* Public channels and text messages posted in them by users.
47+
48+
* Channel topic and purpose.
49+
50+
* Automatically adding imported users to their channels.
51+
52+
Messages with file attachments are imported as a message containing a link to Slack's servers by default. The file attachments themselves can be imported to Mattermost by using the `Slack Advanced Exporter <https://github.com/grundleborg/slack-advanced-exporter>`_ tool to add them to your archive before importing it.
53+
54+
Bot and Integration messages are imported by default, but if you would like them to display with the appropriate username when imported, you should ensure that `Enable Integrations to Override Usernames </administration/config-settings.html#enable-integrations-to-override-usernames>`_ is set **before** doing the import.
55+
56+
.. note:: Slack user accounts with the same email address as existing accounts on your Mattermost server will be merged into those accounts on import.
57+
58+
Limitations
59+
+++++++++++
60+
61+
The following limitations are present when importing from Slack:
62+
63+
* The Markdown subset used by Slack's Posts 2.0 feature announced on September 28, 2015 is not yet supported.
64+
65+
* Direct Message and Private Group history. Slack does not include these messages when generating the export archive.
66+
67+
Migrating from Slack using the Mattermost Web App
68+
+++++++++++++++++++++++++++++++++++++++++++++++++
69+
70+
.. note:: For larger imports, particularly those where you have used the `slack-advanced-exporter tool` to add Slack post attachments to the archive, it is recommended to import the Slack data using the `CLI </administration/migrating.html#migrating-from-slack-using-the-mattermost-cli>`_.
71+
72+
1. Generate a Slack "Export" file from **Slack > Team Settings > Import/Export Data > Export > Start Export**.
73+
74+
2. In Mattermost go to **Team Settings > Import > Import from Slack**. *Team Administrator* or *System Administrator* role is required to access this menu option.
75+
76+
3. Click **Select file** to upload Slack export file and click **Import**.
77+
78+
79+
Migrating from Slack using the Mattermost CLI
80+
+++++++++++++++++++++++++++++++++++++++++++++
81+
82+
1. Generate a Slack "Export" file from **Slack > Team Settings > Import/Export Data > Export > Start Export**.
83+
84+
2. Run the following Mattermost CLI command, with the name of a team you have already created:
85+
86+
``$ platform -slack_import -team_name="your-team" -import_archive /path/to/your-slack-export.zip``
87+
88+
Using the Imported Team
89+
+++++++++++++++++++++++
90+
91+
* During the import process, the emails and usernames from Slack are used to create new Mattermost accounts.
92+
93+
* Slack users can activate their new Mattermost accounts by using Mattermost's Password Reset screen with their email addresses from Slack to set new passwords for their Mattermost accounts.
94+
95+
* Once logged in, the Mattermost users will have access to previous Slack messages in the public channels imported from Slack.

source/help/settings/team-settings.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -27,29 +27,7 @@ The **Invite Code** is used as part of the URL in the team invitation link retri
2727

2828
### Import
2929

30-
#### Import from Slack (Beta)
30+
#### Import from Slack (Beta)
3131

32-
*Note: As a proprietary SaaS service, Slack is able to change its export format quickly and without notice. If you encounter issues not mentioned in the documentation below, please alert the product team by [filing an issue](https://github.com/mattermost/platform/issues).*
32+
You can import channels and users from Slack into Mattermost from **Team Settings > Import**. Please review our documentation on [Slack Import](https://docs.mattermost.com/administration/migrating.html?highlight=slack#migrating-from-slack) for more details.
3333

34-
The Slack Import feature in Mattermost is in "Beta" and focus is on supporting migration of teams of less than 100 registered users. To use:
35-
36-
1. Generate a Slack "Export" file from **Slack > Team Settings > Import/Export Data > Export > Start Export**.
37-
38-
2. In Mattermost go to **Team Settings > Import > Import from Slack**. _Team Administrator_ or _System Administrator_ role is required to access this menu option.
39-
40-
3. Click **Select file** to upload Slack export file and click **Import**.
41-
42-
4. Emails and usernames from Slack are used to create new Mattermost accounts.
43-
44-
5. Slack users can activate their new Mattermost accounts by using Mattermost's Password Reset screen with their email addresses from Slack to set new passwords for their Mattermost accounts.
45-
46-
6. Once logged in, the Mattermost users will have access to previous Slack messages in the public channels imported from Slack.
47-
48-
**It is highly recommended that you test Slack import before applying it to an instance intended for production.** If you use Docker, you can spin up a test instance in one line (`docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform`). If you don't use Docker, there are [step-by-step instructions](http://docs.mattermost.com/install/docker-local-machine.html) to install Mattermost in preview mode in less than 5 minutes.
49-
50-
#### Limitations
51-
52-
- Newly added markdown support in Slack's Posts 2.0 feature announced on September 28, 2015 is not yet supported.
53-
- Slack does not export files or images your team has stored in Slack's database. Mattermost will provide links to the location of your assets in Slack's web UI. However, you can use [this tool](https://github.com/grundleborg/slack-advanced-exporter) to include files in the Slack export, and import them into Mattermost.
54-
- Slack does not export any content from private groups or direct messages that your team has stored in Slack's database.
55-
- In Beta, Slack accounts with usernames or email addresses identical to existing Mattermost accounts will be merged. No pre-check or roll-back is currently offered.

0 commit comments

Comments
 (0)