mirror of
https://github.com/zulip/zulip.git
synced 2025-10-26 09:34:02 +00:00
integrations: Update Matrix and IRC docs.
This commit is contained in:
@@ -2,42 +2,40 @@
|
||||
|
||||
1. {!create-stream.md!}
|
||||
|
||||
1. On your {{ settings_html|safe }}, create a **Generic** bot for
|
||||
{{ integration_display_name }}. Subscribe this bot to the stream
|
||||
created in step 1.
|
||||
1. [Create a bot](/help/add-a-bot-or-integration), using **Generic bot** for
|
||||
the bot type. Subscribe this bot to the stream you just created.
|
||||
|
||||
1. Open `zulip/integrations/matrix/matrix_bridge_config.py` with your
|
||||
favorite editor, and change the following lines in the `zulip`
|
||||
section:
|
||||
1. Open `zulip/integrations/matrix/matrix_bridge_config.py` in your cloned
|
||||
repository, and update the following section:
|
||||
|
||||
```
|
||||
"zulip": {
|
||||
"email": "matrix-bot@chat.zulip.org",
|
||||
"api_key": "your_key",
|
||||
"site": "https://chat.zulip.org",
|
||||
"stream": "Stream which acts as the bridge",
|
||||
"topic": "Topic of the stream"
|
||||
}
|
||||
('zulip', OrderedDict((
|
||||
('email', 'glitch-bot@chat.zulip.org'),
|
||||
('api_key', 'aPiKeY'),
|
||||
('site', 'https://chat.zulip.org'),
|
||||
('stream', 'test here'),
|
||||
('topic', 'matrix'),
|
||||
))),
|
||||
```
|
||||
|
||||
**email**, **api_key**, and **site** should come from your
|
||||
{{ integration_display_name }} bot's `zuliprc` file. Set **stream**
|
||||
to the name of the stream created in step 1, and set **topic** to
|
||||
a topic of your choice.
|
||||
Replace the **email**, **api_key**, and **site** values with those from
|
||||
your bot's `zuliprc` file, and set **stream** to the name of the stream
|
||||
created in step 1. Set **topic** to a topic of your choice, like
|
||||
`IRC mirror`.
|
||||
|
||||
1. Create a user on [matrix.org](https://matrix.org/), preferably
|
||||
with a descriptive name such as `zulip-bot`.
|
||||
|
||||
1. Open `matrix_bridge_config.py`, and provide your Matrix credentials
|
||||
in the `matrix` section:
|
||||
1. Open `zulip/integrations/matrix/matrix_bridge_config.py` again, and update
|
||||
the following section with your Matrix credentials:
|
||||
|
||||
```
|
||||
"matrix": {
|
||||
"host": "https://matrix.org",
|
||||
"username": "username of matrix.org user",
|
||||
"password": "password of matrix.org user",
|
||||
"room_id": "#room:matrix.org"
|
||||
}
|
||||
('matrix', OrderedDict((
|
||||
('host', 'https://matrix.org'),
|
||||
('username', 'username'),
|
||||
('password', 'password'),
|
||||
('room_id', '#zulip:matrix.org'),
|
||||
))),
|
||||
```
|
||||
|
||||
{% if 'IRC' in integration_display_name %}
|
||||
@@ -50,12 +48,11 @@
|
||||
|
||||
{% endif %}
|
||||
|
||||
1. Run `python matrix_bridge.py` to start mirroring content.
|
||||
1. Run `python matrix_bridge.py` from inside the Python virtual environment
|
||||
to start mirroring content.
|
||||
|
||||
!!! tip ""
|
||||
|
||||
If you want to customize the message formatting, you can do so by
|
||||
editing the variables `MATRIX_MESSAGE_TEMPLATE` and `ZULIP_MESSAGE_TEMPLATE`
|
||||
in `zulip/integrations/matrix/matrix_bridge.py`.
|
||||
|
||||
**Congratulations! You have created the bridge successfully!**
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
### Install the bridge software
|
||||
|
||||
1. Clone the Zulip API repository, and install its dependencies:
|
||||
1. Clone the Zulip API repository, and install its dependencies.
|
||||
|
||||
```
|
||||
git clone https://github.com/zulip/python-zulip-api.git
|
||||
@@ -8,15 +8,14 @@
|
||||
python3 ./tools/provision
|
||||
```
|
||||
|
||||
1. Activate the virtualenv by running the `source` command printed
|
||||
at the end of the `provision` output.
|
||||
This will create a new Python virtualenv. You'll run the bridge service
|
||||
inside this virtualenv.
|
||||
|
||||
1. To install the Matrix bridge software in your virtualenv, run:
|
||||
1. Activate the virtualenv by running the `source` command printed
|
||||
at the end of the output of the previous step.
|
||||
|
||||
1. Install the Matrix bridge software in your virtualenv, by running:
|
||||
|
||||
```
|
||||
pip install -r zulip/integrations/matrix/requirements.txt
|
||||
```
|
||||
|
||||
This will create a new Python virtual environment, with all the
|
||||
dependences for this bridge installed. You'll want to run the bridge
|
||||
service inside this virtualenv.
|
||||
|
||||
@@ -1,19 +1,22 @@
|
||||
A bridge for exchanging messages between IRC and Zulip, powered by
|
||||
[the Zulip Matrix integration](/integrations/doc/matrix).
|
||||
Mirror an IRC channel in Zulip!
|
||||
|
||||
This integration is powered by the [Zulip Matrix integration](/integrations/doc/matrix).
|
||||
|
||||
{!install-matrix.md!}
|
||||
|
||||
{!configure-matrix-bridge.md!}
|
||||
|
||||
Your Zulip notifications may look like:
|
||||
**Congratulations! You're done!**
|
||||
|
||||
Your Zulip messages may look like:
|
||||
|
||||

|
||||
|
||||
Your IRC notifications may look like:
|
||||
Your IRC messages may look like:
|
||||
|
||||

|
||||
|
||||
**Note**: There are certain
|
||||
**Note**: There are a handful of
|
||||
[IRC channels](https://github.com/matrix-org/matrix-appservice-irc/wiki/Channels-from-which-the-IRC-bridge-is-banned)
|
||||
where the Matrix.org IRC bridge has been banned for technical reasons.
|
||||
You can't mirror those IRC channels using this integration.
|
||||
that have temporarily banned the Matrix.org IRC bridge.
|
||||
You can't currently mirror those channels using this integration.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
A bridge for exchanging messages between [matrix.org](https://matrix.org) and Zulip!
|
||||
Exchange messages between [matrix.org](https://matrix.org) and Zulip!
|
||||
|
||||
{!install-matrix.md!}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user