Awesome-Technologies / slack-matrix-migration

A tool to import a Slack export into a Matrix homeserver

Slack to Matrix Migration

Migrates Users, Channels and all the conversations from a Slack export to Matrix Warning: It's not recommended to use anything but a fresh/empty Synapse instance for migration

However, you can configure it to import the Slack workspace to an empty federated server and use that to effectively migrate rooms to an existing Matrix server via federation. See 'Federated setup (import to an existing Matrix server)' below.

Do migration

Prerequisites

1. Set up a Synapse Homeserver
2. Create an admin user on the Homeserver (make sure the username of the admin user does not match any existing slack user id)
3. Copy conf/matrix/migration_service.yaml to somewhere reachable by your Homeserver
4. Replace the as_token and hs_token in the conf/matrix/migration_service.yaml with a random string
5. Add the Application Service to your homeserver.yaml:

app_service_config_files:
  - /<path to the yaml file>/migration_service.yaml

6. Restart Synapse

Notes:

• Make sure the migration script can access the /_matrix/client api and the /_synapse admin api
• Other Homeserver implementations may not support timestamped massaging, see https://matrix.org/docs/spec/application_service/r0.1.0#timestamp-massaging
• You may have to increase your homeserver rate limits (although application services should not have a rate limit)

1. Install Python 3.7 with pip

Federated setup (import to an existing Matrix server)

The idea is to migrate Slack to a fresh/empty Synapse instance, that is federated with your existing Matrix homeserver. All imported Slack users will be kicked after the migration is done, leaving only the admin user in the migrated rooms. Invite any users from your existing Matrix homeserver to the rooms manually using the admin user.

You will need the following configuration:

# Set to 'True' to invite all users to all rooms
invite-all: True
# Set to 'True' to invite the admin user to all rooms
create-as-admin: True
# Set to 'True' to kick all imported users from imported rooms
kick-imported-users: True
# Set to 'True' to allow rooms to be joined from other homeservers
federate-rooms: True
# Append room and displayname suffixes
room-suffix: " (slack import)"
name-suffix: " (slack import)"

Running the migration

Local

1. Install Python 3.9 with pip
2. Run pip3 install -r required.txt
3. Get a zipped Export of your Slack Workspace (https://slack.com/help/articles/201658943) and put in data/
4. Copy config/config_example.yaml to config/config.yaml and edit to your needs (use the as_token from your migration_service.yaml)
5. Run python3 slack-matrix-migration/slack-matrix-migration/migrate.py

Local (with development setup)

1. Set developing enviroment
2. Activate Conda and Pipenv
3. Get a zipped Export of your Slack Workspace (https://slack.com/help/articles/201658943) and put in data/
4. Copy config/config_example.yaml to config/config.yaml and edit to your needs (use the as_token from your migration_service.yaml)
5. Run python3 slack-matrix-migration/slack-matrix-migration/migrate.py

Run in Docker

Set Enviroment variables

Fill the .env file

#LOG_LEVEL=DEBUG
LOG_LEVEL=INFO
ADMIN_USER_MATRIX = changeme
ADMIN_PASS_MATRIX = changeme
PYTHONWARNINGS="ignore:Unverified HTTPS request"

1. Get a zipped Export of your Slack Workspace (https://slack.com/help/articles/201658943) and put in data/
2. Copy config/config_example.yaml to config/config.yaml and edit to your needs (use the as_token from your migration_service.yaml)
3. Run Docker

docker run --env-file .env -v $(pwd)/log:/app/log -v $(pwd)/data:/app/data -v $(pwd)/run:/app/run -v $(pwd)/conf:/app/conf --rm -it slack-matrix-migration slack-matrix-migration:latest

Cleanup

1. Remove the Application Service from your homeserver.yaml
2. Delete the migration_service.yaml
3. Reset any increased rate limits
4. Restart Synapse

Build and Push to docker registry

version=0.1.1
docker build --build-arg BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ') --build-arg VCS_REF=$(git rev-parse --short HEAD)  -t sapian/slack-matrix-migration:latest -t sapian/slack-matrix-migration:${version} --build-arg VERSION=${version} .

build multiarch and push

version=0.1.1
docker build build --push \
      --platform linux/arm64/v8,linux/amd64,linux/arm/v7 \
      --build-arg BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ') \
      --build-arg VCS_REF=$(git rev-parse --short HEAD) \
      --tag custom/slack-matrix-migration:latest \
      --tag quay.io/custom/slack-matrix-migration:latest \
      --tag custom/slack-matrix-migration:${version} \
      --tag quay.io/custom/slack-matrix-migration:${version} \
      .

Set up a development environment

conda create -n slack-matrix-migration python=3.9
/opt/$USER/anaconda3/envs/slack-matrix-migration/bin/pip install pipenv
/opt/$USER/anaconda3/envs/slack-matrix-migration/bin/pipenv --python=/opt/$USER/anaconda3/envs/slack-matrix-migration/bin/python install
/opt/$USER/anaconda3/envs/slack-matrix-migration/bin/pipenv --python=/opt/$USER/anaconda3/envs/slack-matrix-migration/bin/python install --dev

Ipyhon

cd ~/Workspace/slack-matrix-migration/
conda activate slack-matrix-migration
/opt/$USER/anaconda3/envs/slack-matrix-migration/bin/pipenv run ipython

Activate Conda and Pipenv

cd ~/Workspace/slack-matrix-migration/
conda activate slack-matrix-migration
/opt/$USER/anaconda3/envs/slack-matrix-migration/bin/pipenv shell