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.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a0f66b3d952a0aac3b50b38398a554f2aab1dc26c3ee06e8a6db9fc96ba25ee |
|
MD5 | ef9ffadb6b40ee57cb07936286967ef0 |
|
BLAKE2b-256 | 15c2d4fe2fd96065d6da00410c133478b7bf071c05ca686fad4ea28400c1ed7e |
Hashes for matrix_http_rendezvous_synapse-0.1.8-cp37-abi3-musllinux_1_2_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a346ee999f25a5fb6a8f690476bf2cecceb2d242c6b2629abe9661b880650e6 |
|
MD5 | aadf1c7e2a23c99bb80592bb59fdc730 |
|
BLAKE2b-256 | b1b3e3a26d4958d13b3d5d661dd8dc429f47fa10191281aa033ca8cbdf1336d2 |
Hashes for matrix_http_rendezvous_synapse-0.1.8-cp37-abi3-musllinux_1_2_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70cf452a0e81ec80861ef9f4e809d748b44c0e8bc051b1cfba82b330c7ecf7ef |
|
MD5 | 409cce81cd43761e24439de37b49eea4 |
|
BLAKE2b-256 | 3f331884ba1579bdbcb63860c87b2255a24b8f204f0cf6b4ea474bfed4e7a5b9 |
Hashes for matrix_http_rendezvous_synapse-0.1.8-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8487d4ead0eae1e2b1633d63f7bb85d8f7786f6667e5f178f8340db103010019 |
|
MD5 | 042e23b992af21104edf23a0e09944c1 |
|
BLAKE2b-256 | 7668f84dd7bfe480f75d2d893797a9c77927ce2ef6507907c6046314246792f4 |
Hashes for matrix_http_rendezvous_synapse-0.1.8-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f73e80ece2ac8390313624c56ee0f4ad4aa795a50e588472ed25589001108c4e |
|
MD5 | 56c143aa0dfa9843c9f6ed5aa211606f |
|
BLAKE2b-256 | fb5379daead1a6d4f768bb61368c3a172027bcadf8cf69114f3e8d9daf1f0a6d |
Hashes for matrix_http_rendezvous_synapse-0.1.8-cp37-abi3-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27a46dbf73d5a32c25224d9c15af8013aef5a8364fbddb69abadf8329c339558 |
|
MD5 | a3857026d8e94e95a289b4247f3088e7 |
|
BLAKE2b-256 | 1926b2cc3ecf675b9d837a5cb181a3bde89b22c4b5d2ba044987dc5bfa0e0f65 |
Hashes for matrix_http_rendezvous_synapse-0.1.8-cp37-abi3-macosx_10_7_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 113bb2bf6b12b52fced201859b8146c11f55a2e06c08ce268ea39a738869bb9b |
|
MD5 | c887774573bc279c550a7eb9b8e59a15 |
|
BLAKE2b-256 | f722c81ad504f5b4825e94bf953edb08f2307137d8d6aaa8f2fb14d5bcb5402b |