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.12.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e698927d9bb1037e6abb7bfe2b9df9ab4f1b21130424c6d05bbea537d1d977b |
|
MD5 | 27a70bb00b1e3fbce328d41712fc5aa5 |
|
BLAKE2b-256 | 2f23288b0e1ef16d72dd6758a2b6952a55f0c858a66f4c693f2240ae81227c8f |
Hashes for matrix_http_rendezvous_synapse-0.1.12-cp37-abi3-musllinux_1_2_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a0c375677273ee57c23d8d89753128e4a9a1826b333b8ac4181cb19b48f5a9f |
|
MD5 | 0bb2a9286f1d2ce331a0f746a97a1e6b |
|
BLAKE2b-256 | 0341aae0799c0f4e1acfb53b5f0d78e43cf18d99530aa38b4fa788a0b9f4575c |
Hashes for matrix_http_rendezvous_synapse-0.1.12-cp37-abi3-musllinux_1_2_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99ab39ba3fe503969ebde3717c7a41a23f4725dfda0fb3f6ff3930cb1835cdcc |
|
MD5 | 97eb00f00afc293ab402b0e001cc4dbe |
|
BLAKE2b-256 | 7476cb81f6946cf6c7290517993ee86823ddb6405f74f161e39aca70a0c4d63f |
Hashes for matrix_http_rendezvous_synapse-0.1.12-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f928f126f88edbdf90ecbd60c8f17a34d4e7063849d541a13f0bd7a6c0f6aba4 |
|
MD5 | e52d57459f37d557d26519b32e61dd37 |
|
BLAKE2b-256 | e3d7fcdbf1db3d398f7fe67a2374048a386c8a750c7cd5b80dbc95ffc53d9d7d |
Hashes for matrix_http_rendezvous_synapse-0.1.12-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe308d1a40351ddd3bb1b04a6a4e51cdca96277945434e37eb51b13e25f7bc8a |
|
MD5 | c99d930c1373dd6dac93628e3d7817c5 |
|
BLAKE2b-256 | cbd308fe0d8430c9b079a343b8eacf67a5037559ca79b1b10713f0fe27f27036 |
Hashes for matrix_http_rendezvous_synapse-0.1.12-cp37-abi3-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa876e741e8e2ccecfec4f375b5267ba80104785a23a572d26458a11de7441fc |
|
MD5 | 3cea369be57885cf35ebe4589939d8d6 |
|
BLAKE2b-256 | 322061eb8f217674ebcef91e1fb608d04b27fb8cace755a3b8ec6ac32653d9a5 |
Hashes for matrix_http_rendezvous_synapse-0.1.12-cp37-abi3-macosx_10_7_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 07e2ec3119a238c4d9b1889c285a0f247d0a30101ef144c032d1aed929c4f171 |
|
MD5 | 189e6d2b36a0d1202cff387e82550660 |
|
BLAKE2b-256 | 25a0a2e08997edbadd3ae5d555ba5c08b608e4371faa9cdc6345a99f4a48b26c |