From efcdc712bfda8b26bb9fd0a110ab009bfe65f4a6 Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Tue, 22 May 2018 14:00:54 -0700 Subject: [PATCH] matrix: Edit matrix.org README further. The README is still pretty rough, but this cleans it up a bit. --- zulip/integrations/matrix/README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/zulip/integrations/matrix/README.md b/zulip/integrations/matrix/README.md index 67477b9..dce60a7 100644 --- a/zulip/integrations/matrix/README.md +++ b/zulip/integrations/matrix/README.md @@ -1,6 +1,7 @@ # Matrix <--> Zulip bridge -This acts as a bridge between Matrix and Zulip. It also enables a Zulip topic to be federated. +This acts as a bridge between Matrix and Zulip. It also enables a +Zulip topic to be federated between two Zulip servers. ## Usage @@ -18,23 +19,25 @@ 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` +1. Create a generic Zulip bot, with a full name like `IRC Bot`. +2. Subscribe the bot user to the stream you'd like to mirror your IRC + channel into. +3. Enter the bot's `zuliprc` details (`email`, `api_key`, and `site`) + 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](https://matrix.org/) preferably with a formal name -similar to `zulip-bot`. +1. Create a user on [matrix.org](https://matrix.org/), preferably with + a formal name like 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. +start the mirroring service. -## Note +## Caveats for IRC mirroring There are certain [IRC channels](https://github.com/matrix-org/matrix-appservice-irc/wiki/Channels-from-which-the-IRC-bridge-is-banned) -where the messages from Zulip cannot be forwarded to -IRC due to a ban on the Matrix bot. +where the Matrix.org IRC bridge has been banned for technical reasons. +You can't mirror those IRC channels using this integration.