Skip to content

Commit 82ac01c

Browse files
committed
Add details of configuration options for synapse module
1 parent c36dfab commit 82ac01c

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

synapse/README.rst

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ This is an implementation of `MSC3886
55
<https://github.com/matrix-org/matrix-spec-proposals/pull/3886>`_ for `Synapse
66
<https://github.com/matrix-org/synapse>`_.
77

8-
=====
8+
-----
99
Usage
10-
=====
10+
-----
1111

1212
1. Install the module to make it available to your Synapse environment::
1313

@@ -28,3 +28,24 @@ Usage
2828
4. Run Synapse with the asyncio reactor enabled::
2929

3030
SYNAPSE_ASYNC_IO_REACTOR=1 python -m synapse.app.homeserver
31+
32+
---------------------
33+
Configuration options
34+
---------------------
35+
36+
Apart from the `prefix` the following config options are available:
37+
38+
- `ttl`: The time-to-live of the rendezvous session in seconds. Defaults to 60.
39+
- `max_bytes`: The maximum number of bytes that can be sent in a single request. Defaults to 4096.
40+
41+
An example configuration setting these and a custom prefix would like::
42+
43+
modules:
44+
- module: matrix_http_rendezvous_synapse.SynapseRendezvousModule
45+
config:
46+
prefix: /rendezvous
47+
ttl: 15 # seconds
48+
max_bytes: 10240 # 10 KiB
49+
50+
experimental_features:
51+
msc3886_endpoint: /rendezvous # this should match above

0 commit comments

Comments
 (0)