python-zulip-api/zulip/integrations/matrix/README.md

Matrix <--> Zulip bridge

This acts as a bridge between Matrix and Zulip. It also enables a Zulip topic to be federated.

Usage

For IRC bridges

Matrix has been bridged to the listed IRC networks, where the 'Room alias format' refers to the room_id for the corresponding IRC channel.

For example, for the freenode channel #zulip-test, the room_id would be #freenode_#zulip-test:matrix.org.

Hence, this can also be used as a IRC <--> Zulip bridge.

Steps to configure the Matrix bridge

1. Zulip endpoint

1. Create a generic Zulip bot preferable with a formal name similar to irc-bot.
2. (Don't forget this step!) Make sure the bot is subscribed to the relevant stream
3. Enter the bot's email and api_key into matrix_bridge_config.py
4. Enter the destination topic, stream and site in matrix_bridge_config.py

2. Matrix endpoint

1. Create a user on matrix.org preferably with a formal name similar to zulip-bot.
2. Enter the user's username and password into matrix_bridge_config.py
3. Enter the host and room_id into matrix_bridge_config.py

After the steps above have been completed, run python matrix_bridge.py to start the mirroring.

Note

There are certain IRC channels where the messages from Zulip cannot be forwarded to IRC due to a ban on the Matrix bot.