Skip to content

Commit d2e0236

Browse files
committed
Improve readme for Synapse module
1 parent a5c4726 commit d2e0236

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

synapse/README.rst

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
1-
==============================================
2-
Matrix Synapse module which implements MSC3886
3-
==============================================
1+
Matrix Synapse module which implements MSC3886 Simple HTTP rendezvous server
2+
============================================================================
43

5-
Usage::
4+
This is an implementation of `MSC3886
5+
<https://github.com/matrix-org/matrix-spec-proposals/pull/3886>`_ for `Synapse
6+
<https://github.com/matrix-org/synapse>`_.
7+
8+
=====
9+
Usage
10+
=====
11+
12+
1. Install the module to make it available to your Synapse environment::
613

714
pip install matrix-http-rendezvous-synapse
815

9-
In your homeserver.yaml::
16+
2. Enable the module in your homeserver.yaml::
1017

1118
modules:
1219
- module: matrix_http_rendezvous_synapse.SynapseRendezvousModule
1320
config:
14-
prefix: /rendezvous
21+
prefix: /_synapse/client/org.matrix.msc3886/rendezvous
22+
23+
3. Make the module available at the actual API endpoint in the Client-Server API by adding this to your homeserver.yaml::
24+
25+
experimental_features:
26+
msc3886_endpoint: /_synapse/client/org.matrix.msc3886/rendezvous
27+
28+
4. Run Synapse with the asyncio reactor enabled::
29+
30+
SYNAPSE_ASYNC_IO_REACTOR=1 python -m synapse.app.homeserver

0 commit comments

Comments
 (0)