A Matrix Synapse module which implements MSC3886
Project description
This is an implementation of MSC3886 for Synapse.
Usage
Install the module to make it available to your Synapse environment:
pip install matrix-http-rendezvous-synapse
Enable the module in your homeserver.yaml:
modules: - module: matrix_http_rendezvous_synapse.SynapseRendezvousModule config: prefix: /_synapse/client/org.matrix.msc3886/rendezvous
Make the module available at the actual API endpoint in the Client-Server API by adding this to your homeserver.yaml:
experimental_features: msc3886_endpoint: /_synapse/client/org.matrix.msc3886/rendezvous
Run Synapse with the asyncio reactor enabled:
SYNAPSE_ASYNC_IO_REACTOR=1 python -m synapse.app.homeserver
Configuration options
Apart from the prefix the following config options are available:
ttl: The time-to-live of the rendezvous session. Defaults to 60s.
max_bytes: The maximum number of bytes that can be sent in a single request. Defaults to 4096 bytes.
max_entries: The maximum number of entries to keep. Defaults to 10 000.
An example configuration setting these and a custom prefix would like:
modules: - module: matrix_http_rendezvous_synapse.SynapseRendezvousModule config: prefix: /rendezvous ttl: 15s max_bytes: 10KiB max_entries: 50000 experimental_features: msc3886_endpoint: /rendezvous # this should match above
Memory usage
max_entries and max_bytes allow to tune how much memory the module may take. There is a constant overhead of approximately 1KiB per entry, so with the default config (max_bytes = 4KiB, max_entries = 10000), the maximum theorical memory footprint of the module is (4KiB + ~1KiB) * 10000 ~= 50MiB.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for matrix_http_rendezvous_synapse-0.1.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e110609025f304dbf25e9e02fe37cfb2ba88a9f1b84b4e0a421a6442510603ad |
|
MD5 | 5a451d57c94f61e4c79f37d0ab0e5702 |
|
BLAKE2b-256 | 983a0351f6d6839cd6dcca2dac1b945e976557c0b2d3ae6658379124594d7c67 |
Hashes for matrix_http_rendezvous_synapse-0.1.6-cp37-abi3-musllinux_1_2_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b809df85b6f571e61d03332da918af6c551560d7403e7d202f99d0931da805d |
|
MD5 | 79a56c5d9cdec586f557d4004e9fcd26 |
|
BLAKE2b-256 | cf5e8a98fcf26e3f18a60d53e1671dd6b573498ba6972f1a23ef5addcecddf83 |
Hashes for matrix_http_rendezvous_synapse-0.1.6-cp37-abi3-musllinux_1_2_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 041ded4bebf5dc366f80fd6c10613b0e0875cac34797124f9142a29e464cd0a1 |
|
MD5 | 0f5781cf7c497a0ddb2679b9b32deb06 |
|
BLAKE2b-256 | 928e85a4c8fc543af15cf3dd704c6e9c8d297477b2dd1a4596757fc82eea6e1d |
Hashes for matrix_http_rendezvous_synapse-0.1.6-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7e304cb9ad0655ba25fb75022997c68497b4e5f11e9021a814fa4147c955ee2 |
|
MD5 | e1c81914a0ff4e366d93adbf33f501b7 |
|
BLAKE2b-256 | 6e06424c5bd23ff30e94bd2e6e3e4cbbb333f6cb0fc8298b611efd394ec472cf |
Hashes for matrix_http_rendezvous_synapse-0.1.6-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17c05137744038e49ef1016f974f4b8f756cf5d32856808650a74dca300ddc27 |
|
MD5 | ad3d1c481fa892eec8f58f56222cc23b |
|
BLAKE2b-256 | e2ca52d974269518ee83194c2a096867cf34c3a62a8119a6e6049f3c64857c66 |
Hashes for matrix_http_rendezvous_synapse-0.1.6-cp37-abi3-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4df07018373489503ae8a79b32d79148cc4a3d8540c8857c592034b76146ffb9 |
|
MD5 | f9ee15d96765309e150b013848255974 |
|
BLAKE2b-256 | 72c592b39b72367d0e8dfb2f82ac5c8f81e4636dd7cdf8f1d5ea4d4811e5ef72 |
Hashes for matrix_http_rendezvous_synapse-0.1.6-cp37-abi3-macosx_10_7_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e990061566cee057152b729bcae91b329a04b5483fc02354d2284aeda22cebe |
|
MD5 | c24d53d316845816790bd8c61ff865cb |
|
BLAKE2b-256 | bf50e9babddc877d40d917a1292a421a1915828f0b2f0589996486621908dbd2 |