Skip to content
This repository has been archived by the owner on May 10, 2022. It is now read-only.

Latest commit

 

History

History
33 lines (22 loc) · 1.42 KB

README.md

File metadata and controls

33 lines (22 loc) · 1.42 KB
Raw

Group/Community to Space converter bot

Converts groups (legacy, aka "communities") to Spaces on demand.

⚠ Officially deprecated

Now that Spaces have been around for a while and the groups API is no longer readily available on Synapse, this project is now officially deprecated. It may still work for you, but it is not supported.

Usage

  1. DM @spacebot:t2bot.io
  2. Say !convert +group:example.org to start the conversion.
  3. Give the bot a minute to figure things out.
  4. You should receive an invite to your newly created Space, though your community members won't be invited.
  5. Make any changes you like to the Space (it's yours).
  6. Advertise the space within your community so people can join, or invite the people that need to be there.

If you run into issues, visit #help:t2bot.io on Matrix.

Running / Building yourself

For help and support running this bot, visit #spacebot:t2bot.io on Matrix.

The basic steps are:

npm install
cp config/default.yaml config/production.yaml
nano config/production.yaml  # or whatever editor you like
NODE_ENV=production npm run start:dev

A Docker image is also available to make quick work of the deployment. Map a volume to /data which contains the config and storage directories and have at it.