mirror of https://github.com/zulip/zulip.git
Matrix: Create 'install-matrix' macro.
'install-matrix' is used twice, in 'integrations/irc.md' and 'integrations/matrix.md'. Hence we create a macro for it.
This commit is contained in:
parent
dffb23afc2
commit
25ac6e812f
|
@ -0,0 +1,25 @@
|
||||||
|
### Install the bridge software
|
||||||
|
|
||||||
|
You can install the bridge software as follows:
|
||||||
|
|
||||||
|
1. First, clone the Zulip API and install its dependencies:
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://github.com/zulip/python-zulip-api.git
|
||||||
|
cd python-zulip-api
|
||||||
|
python3 ./tools/provision
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Next, enter the virtualenv, by running the `source` command printed
|
||||||
|
at the end of the `provision` output.
|
||||||
|
|
||||||
|
1. Then, run this to install the Matrix bridge software in your virtualenv.
|
||||||
|
|
||||||
|
```
|
||||||
|
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. If you later need to enter the
|
||||||
|
virtualenv (from e.g. a new shell), you can use the `source` command.
|
|
@ -1,31 +1,7 @@
|
||||||
A bridge for exchanging messages between IRC and Zulip, powered by
|
A bridge for exchanging messages between IRC and Zulip, powered by
|
||||||
[the Zulip Matrix integration](/integrations/doc/matrix).
|
[the Zulip Matrix integration](/integrations/doc/matrix).
|
||||||
|
|
||||||
### Install the bridge software
|
{!install-matrix.md!}
|
||||||
|
|
||||||
You can install the bridge software as follows:
|
|
||||||
|
|
||||||
1. First, clone the Zulip API and install its dependencies:
|
|
||||||
|
|
||||||
```
|
|
||||||
git clone https://github.com/zulip/python-zulip-api.git
|
|
||||||
cd python-zulip-api
|
|
||||||
python3 ./tools/provision
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Next, enter the virtualenv, by running the `source` command printed
|
|
||||||
at the end of the `provision` output.
|
|
||||||
|
|
||||||
1. Then, run this to install the Matrix bridge software in your virtualenv.
|
|
||||||
|
|
||||||
```
|
|
||||||
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. If you later need to enter the
|
|
||||||
virtualenv (from e.g. a new shell), you can use the `source` command.
|
|
||||||
|
|
||||||
### Configure the bridge
|
### Configure the bridge
|
||||||
|
|
||||||
|
|
|
@ -1,30 +1,6 @@
|
||||||
A bridge for exchanging messages between [matrix.org](https://matrix.org) and Zulip!
|
A bridge for exchanging messages between [matrix.org](https://matrix.org) and Zulip!
|
||||||
|
|
||||||
### Install the bridge software
|
{!install-matrix.md!}
|
||||||
|
|
||||||
You can install the bridge software as follows:
|
|
||||||
|
|
||||||
1. First, clone the Zulip API and install its dependencies:
|
|
||||||
|
|
||||||
```
|
|
||||||
git clone https://github.com/zulip/python-zulip-api.git
|
|
||||||
cd python-zulip-api
|
|
||||||
python3 ./tools/provision
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Next, enter the virtualenv, by running the `source` command printed
|
|
||||||
at the end of the `provision` output.
|
|
||||||
|
|
||||||
1. Then, run this to install the Matrix bridge software in your virtualenv.
|
|
||||||
|
|
||||||
```
|
|
||||||
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. If you later need to enter the
|
|
||||||
virtualenv (from e.g. a new shell), you can use the `source` command.
|
|
||||||
|
|
||||||
### Configure the bridge
|
### Configure the bridge
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue