xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

matrix: Edit matrix.org README further.

Browse source 
The README is still pretty rough, but this cleans it up a bit.
This commit is contained in:
Tim Abbott 2018-05-22 14:00:54 -07:00
parent 4c9134815c
commit efcdc712bf
1 changed files with 13 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
zulip/integrations/matrix/README.md
View file

@ -1,6 +1,7 @@
# Matrix <--> Zulip bridge # 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 ## Usage
@ -18,23 +19,25 @@ Hence, this can also be used as a IRC <--> Zulip bridge.
## Steps to configure the Matrix bridge ## Steps to configure the Matrix bridge
### 1. Zulip endpoint ### 1. Zulip endpoint
1. Create a generic Zulip bot preferable with a formal name similar to `irc-bot`. 1. Create a generic Zulip bot, with a full name like `IRC Bot`.
2. (Don't forget this step!) Make sure the bot is subscribed to the relevant stream 2. Subscribe the bot user to the stream you'd like to mirror your IRC
3. Enter the bot's email and `api_key` into `matrix_bridge_config.py` 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` 4. Enter the destination topic, stream and site in `matrix_bridge_config.py`
### 2. Matrix endpoint ### 2. Matrix endpoint
1. Create a user on [matrix.org](https://matrix.org/) preferably with a formal name 1. Create a user on [matrix.org](https://matrix.org/), preferably with
similar to `zulip-bot`. a formal name like to `zulip-bot`.
2. Enter the user's username and password into `matrix_bridge_config.py` 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` 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 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 There are certain
[IRC channels](https://github.com/matrix-org/matrix-appservice-irc/wiki/Channels-from-which-the-IRC-bridge-is-banned) [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 where the Matrix.org IRC bridge has been banned for technical reasons.
IRC due to a ban on the Matrix bot. You can't mirror those IRC channels using this integration.