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.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 199782fd64b48ca1dce6e6195732f12266c6451e98b89620506af2e862c6fad5 |
|
MD5 | d9fc7f974a8dd8be9966cc58d6524170 |
|
BLAKE2b-256 | 00956e6ddfeed8c4a94ebe9c6cadadfa3fb5201bbca2dfa3bddee686e962943e |
Hashes for matrix_http_rendezvous_synapse-0.1.10-cp37-abi3-musllinux_1_2_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3de099f455f2f49b849c09e96a76e10543331dc9a0d843daa612a6cfad40d2c0 |
|
MD5 | 91dbb7a7a6a53c7f899d7faca460298a |
|
BLAKE2b-256 | 538712e0badaa70353c986fccbf36a65b1b3b2693c17cdd19ec78f860be7b00c |
Hashes for matrix_http_rendezvous_synapse-0.1.10-cp37-abi3-musllinux_1_2_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e715abeb4f07221129e176aa7a763e9e9abce05e44600a354a85f61dace336e |
|
MD5 | 66f5361dd41268f8a75479222f19f6e9 |
|
BLAKE2b-256 | 00f1825eeca5a96a513f4c612555f3ca3a984b986af4ff1c085e97ada2bb8c1b |
Hashes for matrix_http_rendezvous_synapse-0.1.10-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38095d9702ee99d4ce5b257a17b395a52168f72f2d715ee6d160a97ca0759fba |
|
MD5 | 253129db52b74a68a37ad2c5e1f2dc60 |
|
BLAKE2b-256 | 1a6ec09433f0c909d1e3ced1b4928563c0dca1f4caef0451bef9e6cb48154909 |
Hashes for matrix_http_rendezvous_synapse-0.1.10-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f78035340ae2c09440a224c45d36d0446a4aeb09fa1d5670cdb1dae345ac608 |
|
MD5 | 283db8224330d88e3b80bbe26a45917b |
|
BLAKE2b-256 | b90ff81c5bd48ccb6971ec52079d9e1c2b692003b1d3f88673a511b6b6d384c7 |
Hashes for matrix_http_rendezvous_synapse-0.1.10-cp37-abi3-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eabb5d5fe7e100f2df51a2162686ca96535e899ce6ae88cfa32d8a5c9db89c3a |
|
MD5 | d53e750e0cdd9adf3755115ceafa0513 |
|
BLAKE2b-256 | eb57a70af3338ce42712833ee2889b40276b1d5f7408d396d318ddffc1540fdb |
Hashes for matrix_http_rendezvous_synapse-0.1.10-cp37-abi3-macosx_10_7_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f6fedf3010bb098eb9a15bdc02160f1e9f168fed5bde684dad6162adbe98e504 |
|
MD5 | ebde17a18b61b0f294001d23b9f32d6b |
|
BLAKE2b-256 | b456142f2983653f02f9a98fd6dbc25aae3b07beea66b92335f16ddffa2a9bce |