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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 620605422e40e02fcb0acafccc9dce836cf2deb1b7e616ec1142a2c1ba335ba9 |
|
MD5 | 3cbe6df63ca3bd483ed35c36c4091bb4 |
|
BLAKE2b-256 | 577648efceafdf868ec398de08806b07b7d3e6a40349d3d76aa4cb5a088681f5 |
Hashes for matrix_http_rendezvous_synapse-0.1.7-cp37-abi3-musllinux_1_2_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 281b29c9c89b7ef783f9f35dfc588bdcf28321b0b7dbfdde7b54e1414dff1692 |
|
MD5 | ff1f4d47874abdb0385c39b4edc4d48f |
|
BLAKE2b-256 | c074356ab56bf3d3637a63cee26a48c67c06c4744b2cffe3ee3140fbae6e5fc1 |
Hashes for matrix_http_rendezvous_synapse-0.1.7-cp37-abi3-musllinux_1_2_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c6fccb3304c28bb2eb1e4be307415fb499745f9ec69a13a157d39fd9c77fb49e |
|
MD5 | d87996f73b719e99ad67498494597117 |
|
BLAKE2b-256 | f8168074261768b8ee967fabae49a1f9a2132af5b8a7f18bc508c22351785be3 |
Hashes for matrix_http_rendezvous_synapse-0.1.7-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e59e89e959b48ea9816fa5401426512cb64bd367f268acf0ffcf326a2680af08 |
|
MD5 | 6a35468dbd462cfb89d84ae41b659c86 |
|
BLAKE2b-256 | 818bc7416de96979a5fbfe6935739b760dd26672c3c7c29f373f6ba6f35ac5f9 |
Hashes for matrix_http_rendezvous_synapse-0.1.7-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9bdba271e8f7fe51e4fd0667f8174c8fe5e96bd8138dd04ba169f09485d289a |
|
MD5 | ca27fafde3063d5e9bac40358adf38a8 |
|
BLAKE2b-256 | f6e09b1bd8dbf75f2bf5b32ee62bc04cc05d2992644a6fef6c4a7008317324ee |
Hashes for matrix_http_rendezvous_synapse-0.1.7-cp37-abi3-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89b0185f4ea904bad9259ca3a023fa227c3305c95bd48967ed04b51c21500e28 |
|
MD5 | d92bca47656ac74158686349f190a895 |
|
BLAKE2b-256 | 878a7ebd9520bb0e85e6d2a512f2564a322e1a64a6091306ed5cfa8d0a5f8e15 |
Hashes for matrix_http_rendezvous_synapse-0.1.7-cp37-abi3-macosx_10_7_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 867ac249996b27fb0c15ea8dee48c2942fb8fa78fd073ece3d11f3a6c388679e |
|
MD5 | b2d3b719086d29e3e80846e05e63ade0 |
|
BLAKE2b-256 | e0e92b75ed4291031ee9ea452b2798e17090c7a39a4131cf0bd64a657ced9ace |