Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/matrix-org/matrix-appservice-slack

A Matrix <--> Slack bridge
https://github.com/matrix-org/matrix-appservice-slack

bridge hacktoberfest matrix slack stable

Last synced: about 21 hours ago
JSON representation

A Matrix <--> Slack bridge

Awesome Lists containing this project

README

        

# matrix-appservice-slack

[![Docker Automated build](https://img.shields.io/docker/cloud/build/matrixdotorg/matrix-appservice-slack.svg)](https://hub.docker.com/r/matrixdotorg/matrix-appservice-slack)
[![#slack:half-shot.uk](https://img.shields.io/matrix/slack:half-shot.uk.svg?server_fqdn=chaotic.half-shot.uk&label=%23slack:half-shot.uk&logo=matrix)](https://matrix.to/#/#slack:half-shot.uk)
[![Documentation Status](https://readthedocs.org/projects/matrix-appservice-slack/badge/?version=latest)](https://matrix-appservice-slack.readthedocs.io/en/latest/?badge=latest)

A bridge that connects [Matrix](https://matrix.org) and [Slack](https://slack.com).
The bridge is considered **stable** and mature for use in production
environments.

![Screenshot](screenshot.png)

## Requirements

Hosting this bridge requires you to have a Matrix homeserver. In order to
connect a Slack Workspace to your bridge, you will need permission to add bots
to it. You will also need Node.JS 16+ or Docker on your system.

**NOTE:** Slack has introduced a new type of 'Slack App', which is not compatible with this bridge. Instead, you will need to [create a "Classic Slack App"](https://api.slack.com/apps?new_classic_app=1) for this bridge. Existing installations will not need to modify their setups, as all pre-existing Slack apps became Classic Slack apps. We are looking to make the bridge compatible with both types, but in the meantime please only use Classic Slack Apps.

## Setting up

See [the getting started docs](https://matrix-appservice-slack.rtfd.io/en/latest/getting_started)
for instructions on how to set up the bridge.

## Helping out

This bridge is a community project and welcomes issues and PRs from anyone who
has the time to spare. If you want to work on the bridge, please see
[CONTRIBUTING.md](https://github.com/matrix-org/matrix-appservice-slack/blob/develop/CONTRIBUTING.md).