-
Notifications
You must be signed in to change notification settings - Fork 585
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update the Slack import docs with latest features. #673
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -26,4 +26,76 @@ The following instructions migrate Mattermost from one server to another by back | |
Migrating from Slack | ||
==================== | ||
|
||
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. | ||
.. 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://www.mattermost.org/filing-issues/>`_. | ||
|
||
The Slack Import feature in Mattermost is in "Beta" and focused on supporting migration of teams of less than 100 registered users. | ||
|
||
This feature can be accessed through the `Mattermost Web App <https://docs.mattermost.com/administration/migrating.html#migrating-from-slack-using-the-mattermost-web-app>`_ or using the `CLI <https://docs.mattermost.com/administration/migrating.html#migrating-from-slack-using-the-mattermost-cli>`_. | ||
|
||
.. warning:: **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: | ||
|
||
.. code:: bash | ||
|
||
docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform | ||
|
||
If you don't use Docker, there are `step-by-step instructions <https://docs.mattermost.com/install/docker-local-machine.html>`_ to install Mattermost in preview mode in less than 5 minutes. | ||
|
||
Supported Features | ||
++++++++++++++++++ | ||
|
||
The following key features are supported when importing from Slack: | ||
|
||
* User accounts with an email address set | ||
|
||
* Public channels and the text messages posted in them | ||
|
||
* Channel topic and purpose | ||
|
||
* Imported users added automatically to their channels | ||
|
||
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. | ||
|
||
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 <https://docs.mattermost.com/administration/config-settings.html#enable-integrations-to-override-usernames>`_ is set in **System Console > Integrations > Custom Integrations** *before* doing the import. | ||
|
||
.. note:: Slack user accounts with the same email address as existing accounts on your Mattermost server will be merged into those accounts on import. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Note:" should be in bold and the following text should be on the same line There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not changed, as discussed on pre-release. |
||
|
||
Limitations | ||
+++++++++++ | ||
|
||
The following limitations are present when importing from Slack: | ||
|
||
* The Markdown subset used by Slack's Posts 2.0 feature announced on September 28, 2015 is not yet supported. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Non-documentation question: Wondering if we could create a Help Wanted issue for it? Someone might be interested in adding support for it. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, that's a good idea. I've got the PLT ticket in my backlog, so I'll tidy it up with some proper instructions on what's still needed and pointers to the right places in the code and then we can make it into a Help Wanted ticket on Github. |
||
|
||
* Direct Message and Private Groups cannot be imported. Slack does not include these messages when generating the export archive. | ||
|
||
Migrating from Slack using the Mattermost Web App | ||
+++++++++++++++++++++++++++++++++++++++++++++++++ | ||
|
||
.. 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 <https://docs.mattermost.com/administration/migrating.html#migrating-from-slack-using-the-mattermost-cli>`_. | ||
|
||
1. Generate a Slack "Export" file from **Slack > Team Settings > Import/Export Data > Export > Start Export**. | ||
|
||
2. In Mattermost go to **Team Settings > Import > Import from Slack**. Team Admin or System Admin role is required to access this menu option. | ||
|
||
3. Click **Select file** to upload Slack export file and click **Import**. | ||
|
||
|
||
Migrating from Slack using the Mattermost CLI | ||
+++++++++++++++++++++++++++++++++++++++++++++ | ||
|
||
1. Generate a Slack "Export" file from **Slack > Team Settings > Import/Export Data > Export > Start Export**. | ||
|
||
2. Run the following Mattermost CLI command, with the name of a team you have already created: | ||
|
||
``$ platform -slack_import -team_name="your-team" -import_archive /path/to/your-slack-export.zip`` | ||
|
||
Using the Imported Team | ||
+++++++++++++++++++++++ | ||
|
||
* During the import process, the emails and usernames from Slack are used to create new Mattermost accounts. | ||
|
||
* 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. | ||
|
||
* Once logged in, Mattermost users will have access to previous Slack messages in the public channels imported from Slack. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Warning:" should be in bold and the following text should be on the same line