This repository has been archived by the owner on Jun 27, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GITBOOK-755: [Update] Import from Slack
- Loading branch information
1 parent
c34c34a
commit b7bfb05
Showing
2 changed files
with
61 additions
and
31 deletions.
There are no files selected for viewing
63 changes: 46 additions & 17 deletions
63
...-configure/environment-configuration/data-migration/import-from-slack/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,49 @@ | ||
| # Import from Slack | ||
|
|
||
| To import your current Slack data into Rocket.Chat: | ||
|
|
||
| 1. Go to `https://[your_app].slack.com/services/export` | ||
| 2. Click on **Start Export** | ||
| 3. Wait until your download is ready and download it (it will be a .zip file) | ||
| 4. Go to `https://[your_rocketchat]/admin/import/new/slack` | ||
| 5. Select "**Slack**" as Import Type | ||
| 6. Choose your downloaded .zip file and wait until Rocket.Chat can read it (it can take a few minutes, depending on the size of your Slack export) | ||
| 7. Click on Import | ||
| 8. Deselect any items you don't want to import | ||
| 9. At the top of the page, click on Start Importing | ||
|
|
||
| {% hint style="info" %} | ||
| * If your Slack workspace is currently set up to hide emails, they'll also be excluded from exports. You can update your workspace settings temporarily and re-run the export in order to include emails as well. | ||
| With Rocket.Chat's import feature, you can import your Slack users, channels, messages, and other data to your workspace. This page guides you through the required steps.  | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| * Permission to export Slack data. | ||
| * Permission to import data to Rocket.Chat workspace. | ||
|
|
||
| Before importing, keep the following points in mind: | ||
|
|
||
| * If your Slack workspace is currently set up to hide emails, they'll also be excluded from exports. You can update your workspace settings temporarily and re-run the export to include emails as well. | ||
| * It can be helpful to export time ranges from Slack such that the size of each import file is less than 15MB. | ||
| * If facing difficulties during the upload phase of the import process, try copying the archive directly to the uploads folder using other means such as scp. Then select Server File Path as the File Type. | ||
| * **Channel name with special character:** if you use **special character** in the channel name, it is important to enable the option [_"Allow Special Characters in Room Names"_](https://docs.rocket.chat/use-rocket.chat/workspace-administration/settings/layout#user-interface) in layout settings. An advanced option is to edit the special characters accepted in the [_UTF-8 setting_](https://docs.rocket.chat/use-rocket.chat/workspace-administration/settings/general#utf8) in the general configuration, **example:** `[0-9a-zA-Z-_.ãÃàèìòùÀÈÌÒÙáéíóúýÁÉÍÓÚÝâêîôûÂÊÎÔÛãñõÃÑÕäëïöüÿÄËÏÖÜŸçÇßØøÅåÆæœ]+$`. | ||
| {% endhint %} | ||
| * If facing difficulties during the upload phase of the import process, try copying the archive directly to the uploads folder using other means such as `scp`. Then select **Server File Path** as the **File Type**. | ||
| * **Channel name with special character:** If you use **special characters** in the channel name, it is important to enable the option [_"Allow Special Characters in Room Names"_](https://docs.rocket.chat/use-rocket.chat/workspace-administration/settings/layout#user-interface) in layout settings. An advanced option is to edit the special characters accepted in the [_UTF-8 setting_](https://docs.rocket.chat/use-rocket.chat/workspace-administration/settings/general#utf8) in the general configuration. For example:\ | ||
| `[0-9a-zA-Z-_.ãÃàèìòùÀÈÌÒÙáéíóúýÁÉÍÓÚÝâêîôûÂÊÎÔÛãñõÃÑÕäëïöüÿÄËÏÖÜŸçÇßØøÅåÆæœ]+$` | ||
| * If you import a Slack user with the same username as in your Rocket.Chat workspace, the Slack user is not imported. | ||
| * If you import a Slack channel with the same name as in your Rocket.Chat workspace, the messages from Slack are imported into the existing Rocket.Chat channel. | ||
|
|
||
| ## Export Slack data | ||
|
|
||
| * To export your entire Slack workspace data, go to [Export your workspace data](https://slack.com/intl/en-in/help/articles/201658943-Export-your-workspace-data) for instructions.  | ||
| * To export your user list as a CSV file, go to [Download a list of members in your workspace](https://slack.com/intl/en-in/help/articles/4405848563603-Download-a-list-of-members-in-your-workspace) for instructions. | ||
|
|
||
| Once your data is ready, go to the next steps to import it into your workspace. | ||
|
|
||
| ## Import Slack data | ||
|
|
||
| In your Rocket.Chat workspace, go to **Administration** > **Workspace** > **Import**. The **Import** page lists the import history. | ||
|
|
||
| 1. Click **Import New File**. | ||
| 2. For the **Import Type** field: | ||
| 1. Select **Slack** to import your entire workspace data. | ||
| 2. Select **Slack's Users CSV** to import the users only. | ||
| 3. Select one of the following options for the **File Type** field: | ||
| 1. **Upload**: Upload the exported data as a `.zip` file. | ||
| 2. **Public URL**: Enter the file URL. | ||
| 3. **Server File Path**: Enter the file path. | ||
| 4. Click **Import**.  | ||
| 1. If you are importing your entire **Slack** workspace data, the users, channels, and messages tabs are displayed. Deselect the **Users** and **Channels** you do not want to import. By default, all messages from the selected users and channels are imported. | ||
| 2. If you are importing only your **Slack's Users CSV**, the list of users is displayed. You can deselect the users that you do not want to import. | ||
| 5. Click **Start Importing**. Once the import is successful, you can view the import details on the **Import** page. | ||
|
|
||
| ## After import | ||
|
|
||
| Now that your Slack data has been successfully imported, you can take the following steps to verify your data: | ||
|
|
||
| 1. Go to **Administration** > **Workspace** > **Users**. Check that your Slack users are present. Note that the `Workspace Admin` role of a Slack user is inherited in Rocket.Chat as `admin`. Other users have the `user` role. | ||
| 2. Use the search option to search for the imported channels. You can see the imported messages in the channels. |
29 changes: 15 additions & 14 deletions
29
...igure/environment-configuration/data-migration/import-from-slack/slackbridge.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,23 @@ | ||
| # SlackBridge | ||
|
|
||
| SlackBridge allows you to mirror the messages received in a Slack channel or private group into Rocket.Chat in real-time. | ||
| SlackBridge allows you to mirror the messages received in a Slack channel or private group into Rocket.Chat in real-time. This means that if you send a message in a Rocket.Chat channel, the message will also be sent in the respective Slack channel, and vice versa. In this way, you can communicate across both platforms. | ||
|
|
||
| To enable it, you have to create a Custom Bot in Slack and add it to the desired channels / private groups. Once enabled and added to rooms, SlackBridge will clone the room in Rocket.Chat and also clone users that speak in that room. | ||
| To enable it, you must create a custom bot in Slack and add it to the desired channels and private groups. | ||
|
|
||
| ## To create a Custom Bot in Slack: | ||
| ## Create a custom bot in Slack | ||
|
|
||
| 1. Got to ["Set up a bot user"](https://my.slack.com/apps/A0F7YS25R-bots) | ||
| 2. Click "Add Configuration" | ||
| 3. Pick a username for your Bot and click **Add Bot Integration** | ||
| 4. Copy the API Token. You'll need it when setting up SlackBridge in Rocket.Chat | ||
| 5. Customize your bot the way you like it and click on Save Integration | ||
| 1. Go to [Set up a bot user](https://my.slack.com/apps/A0F7YS25R-bots). | ||
| 2. Click **Add Configuration**. | ||
| 3. Pick a username for your bot and click **Add Bot Integration**. | ||
| 4. Copy the API Token. You'll need it when setting up SlackBridge in Rocket.Chat. | ||
| 5. Customize your bot the way you like it and click **Save Integration**. | ||
|
|
||
| ## To enable SlackBridge in Rocket.Chat: | ||
| ## Enable SlackBridge in Rocket.Chat | ||
|
|
||
| 1. Go to `https://[your_host]/admin/SlackBridge` | ||
| 2. Enable SlackBridge | ||
| 3. Add your API Token, copied in step 4 above | ||
| 4. Restart your Rocket.Chat server | ||
| 1. Go to **Administration** > **Workspace** > **Settings** > **SlackBridge**. | ||
| 2. Enable SlackBridge. | ||
| 3. Add the API Token that you got from your custom bot configuration. | ||
| 4. You can define values for other settings according to your requirements. | ||
| 5. Once you are done, click **Save changes**. | ||
|
|
||
| When done, you can now invite/add the bot to the channel or private group you want to mirror from | ||
| You can now add the bot to the channels or private groups you want to mirror from. |