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.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f772e3443f60b1d9663be6c6b3457ea104ad70d0fbff1a48bf9dc1427e0deeea |
|
MD5 | e89ee26aea312628c9362f3e7719822a |
|
BLAKE2b-256 | aea0b9b5b5d418720b59daffd68a172a8e12d7b60555c77f4aefdf79c0a7529f |
Hashes for matrix_http_rendezvous_synapse-0.1.9-cp37-abi3-musllinux_1_2_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 635a4d17fad753af28cdba64e5709f635200b24591f3b71bf605e09f5c8738fe |
|
MD5 | 7ddc6bacebb1101cd0c5f87a6bbed334 |
|
BLAKE2b-256 | ab09fa4d0cd11efde549d40ffbea60240b0d39b5e3a12a4861203b9b73b82b5a |
Hashes for matrix_http_rendezvous_synapse-0.1.9-cp37-abi3-musllinux_1_2_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7d85c23d99da8b8e32c7d5834def8e221c8225eaa52ea6f3d83b92ec54451ba |
|
MD5 | 63cebd2aa09b03391892ebc7d7261588 |
|
BLAKE2b-256 | d1d833b53fa9918bf97b7a48584c21d6e70c87eff07cab3b1c4622bd521eb898 |
Hashes for matrix_http_rendezvous_synapse-0.1.9-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15c8fec14260ce9a4b2e2cc0183636753fb944aea4a50efb262c4af705ac9f07 |
|
MD5 | 5a866627fadf6064d30cd19e136714d4 |
|
BLAKE2b-256 | a481dcd08032fd572975d22aac134d66fb82e61c5944035c868c10562d22cb08 |
Hashes for matrix_http_rendezvous_synapse-0.1.9-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8195bf023d9fb8866e31d6134301ee39a1f8bff37feacb99e8fa5a5349ca7aeb |
|
MD5 | 5457fb81ed58140f665590ad6aa36760 |
|
BLAKE2b-256 | bc510600a78e3ad4c37cb883d2310449211c841b41647531cca2720d447aeaac |
Hashes for matrix_http_rendezvous_synapse-0.1.9-cp37-abi3-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8cc96554e8a1f619aa12126d5ec22971d2951a892366df7ef767704c803fd55 |
|
MD5 | aa10a2159a2c5a28d1974b161020f519 |
|
BLAKE2b-256 | 6e100f960c5317394c36421cac03532bb4e2dafdfd8b3471edee57e1ec345fae |
Hashes for matrix_http_rendezvous_synapse-0.1.9-cp37-abi3-macosx_10_7_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b16539fac0fa27af1fa367090d37b0dfc11543b7c14077a38d7e3b9f7362414 |
|
MD5 | 8ece6494e79f85c2ae47118339a9a455 |
|
BLAKE2b-256 | 89d4386be9bdf076ea08f8db5cb500e2c87004462f09305a390c746daa259f56 |