zulip/templates/zerver/help/include/configure-matrix-bridge.md

Configure the bridge

1. In Zulip, create a bot, using Generic bot for the bot type. Download the bot's zuliprc configuration file to your computer.

2. Subscribe the bot to the Zulip stream that will contain the mirror.

3. Inside the virtualenv you created above, run

   python matrix_bridge.py --write-sample-config matrix_bridge.conf --from-zuliprc <path/to/zuliprc>
   

   where <path/to/zuliprc> is the path to the zuliprc file you downloaded.

4. Create a user on matrix.org or another matrix server, preferably with a descriptive name like zulip-bot.

5. Edit matrix_bridge.conf to look like this:

   [zulip]
   email = bridge-bot@chat.zulip.org
   api_key = aPiKeY
   site = https://chat.zulip.org
   stream = "stream name"
   topic = "{{ integration_display_name }} mirror"
   [matrix]
   host = https://matrix.org
   username = <your matrix username>
   password = <your matrix password>
   room_id = #room:matrix.org
   

   The first three values should already be there; the rest you'll have to fill in. Make sure stream is set to the stream the bot is subscribed to.

   {% if 'IRC' in integration_display_name %}

   NOTE: For matrix.org, the room_id generally takes the form #<irc_network>_#<channel>:matrix.org. You can see the format for several popular IRC networks here, under the "Room alias format" column.

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

   {% endif %}

6. Run the following command to start the matrix bridge:

   python matrix_bridge.py -c matrix_bridge.conf
   

!!! tip ""

You can customize the message formatting by
editing the variables `MATRIX_MESSAGE_TEMPLATE` and `ZULIP_MESSAGE_TEMPLATE`
in `zulip/integrations/matrix/matrix_bridge.py`.