[{"_1":2,"_171":-5,"_172":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_150":151},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":85,"_105":106,"_143":-5,"_144":11,"_145":17,"_146":11,"_147":-5,"_148":149},"canonicalUrl","https://hub.docker.com/r/c4dt/synapse/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","c4dt","reponame","synapse","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2019-09-27T14:09:01.030824Z","description","Experiments on matrixdotorg/synapse","is_private","last_updated","2019-10-29T13:30:52.043273Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",1348,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description",".. contents::\n\nIntroduction\n============\n\nMatrix is an ambitious new ecosystem for open federated Instant Messaging and\nVoIP. The basics you need to know to get up and running are:\n\n- Everything in Matrix happens in a room. Rooms are distributed and do not\n exist on any single server. Rooms can be located using convenience aliases\n like ``#matrix:matrix.org`` or ``#test:localhost:8448``.\n\n- Matrix user IDs look like ``@matthew:matrix.org`` (although in the future\n you will normally refer to yourself and others using a third party identifier\n (3PID): email address, phone number, etc rather than manipulating Matrix user IDs)\n\nThe overall architecture is::\n\n client <----> homeserver <=====================> homeserver <----> client\n https://somewhere.org/_matrix https://elsewhere.net/_matrix\n\n``#matrix:matrix.org`` is the official support room for Matrix, and can be\naccessed by any client from https://matrix.org/docs/projects/try-matrix-now.html or\nvia IRC bridge at irc://irc.freenode.net/matrix.\n\nSynapse is currently in rapid development, but as of version 0.5 we believe it\nis sufficiently stable to be run as an internet-facing service for real usage!\n\nAbout Matrix\n============\n\nMatrix specifies a set of pragmatic RESTful HTTP JSON APIs as an open standard,\nwhich handle:\n\n- Creating and managing fully distributed chat rooms with no\n single points of control or failure\n- Eventually-consistent cryptographically secure synchronisation of room\n state across a global open network of federated servers and services\n- Sending and receiving extensible messages in a room with (optional)\n end-to-end encryption[1]\n- Inviting, joining, leaving, kicking, banning room members\n- Managing user accounts (registration, login, logout)\n- Using 3rd Party IDs (3PIDs) such as email addresses, phone numbers,\n Facebook accounts to authenticate, identify and discover users on Matrix.\n- Placing 1:1 VoIP and Video calls\n\nThese APIs are intended to be implemented on a wide range of servers, services\nand clients, letting developers build messaging and VoIP functionality on top\nof the entirely open Matrix ecosystem rather than using closed or proprietary\nsolutions. The hope is for Matrix to act as the building blocks for a new\ngeneration of fully open and interoperable messaging and VoIP apps for the\ninternet.\n\nSynapse is a reference \"homeserver\" implementation of Matrix from the core\ndevelopment team at matrix.org, written in Python/Twisted. It is intended to\nshowcase the concept of Matrix and let folks see the spec in the context of a\ncodebase and let you run your own homeserver and generally help bootstrap the\necosystem.\n\nIn Matrix, every user runs one or more Matrix clients, which connect through to\na Matrix homeserver. The homeserver stores all their personal chat history and\nuser account information - much as a mail client connects through to an\nIMAP/SMTP server. Just like email, you can either run your own Matrix\nhomeserver and control and own your own communications and history or use one\nhosted by someone else (e.g. matrix.org) - there is no single point of control\nor mandatory service provider in Matrix, unlike WhatsApp, Facebook, Hangouts,\netc.\n\nWe'd like to invite you to join #matrix:matrix.org (via\nhttps://matrix.org/docs/projects/try-matrix-now.html), run a homeserver, take a look\nat the `Matrix spec `_, and experiment with the\n`APIs `_ and `Client SDKs\n`_.\n\nThanks for using Matrix!\n\n[1] End-to-end encryption is currently in beta: `blog post `_.\n\n\nSynapse Installation\n====================\n\n.. _federation:\n\n* For details on how to install synapse, see ``_.\n* For specific details on how to configure Synapse for federation see `docs/federate.md `_\n\n\nConnecting to Synapse from a client\n===================================\n\nThe easiest way to try out your new Synapse installation is by connecting to it\nfrom a web client.\n\nUnless you are running a test instance of Synapse on your local machine, in\ngeneral, you will need to enable TLS support before you can successfully\nconnect from a client: see ``_.\n\nAn easy way to get started is to login or register via Riot at\nhttps://riot.im/app/#/login or https://riot.im/app/#/register respectively.\nYou will need to change the server you are logging into from ``matrix.org``\nand instead specify a Homeserver URL of ``https://:8448``\n(or just ``https://`` if you are using a reverse proxy).\n(Leave the identity server as the default - see `Identity servers`_.)\nIf you prefer to use another client, refer to our\n`client breakdown `_.\n\nIf all goes well you should at least be able to log in, create a room, and\nstart sending messages.\n\n.. _`client-user-reg`:\n\nRegistering a new user from a client\n------------------------------------\n\nBy default, registration of new users via Matrix clients is disabled. To enable\nit, specify ``enable_registration: true`` in ``homeserver.yaml``. (It is then\nrecommended to also set up CAPTCHA - see ``_.)\n\nOnce ``enable_registration`` is set to ``true``, it is possible to register a\nuser via `riot.im `_ or other Matrix clients.\n\nYour new user name will be formed partly from the ``server_name``, and partly\nfrom a localpart you specify when you create the account. Your name will take\nthe form of::\n\n @localpart:my.domain.name\n\n(pronounced \"at localpart on my dot domain dot name\").\n\nAs when logging in, you will need to specify a \"Custom server\". Specify your\ndesired ``localpart`` in the 'User name' box.\n\nACME setup\n==========\n\nFor details on having Synapse manage your federation TLS certificates\nautomatically, please see ``_.\n\n\nSecurity Note\n=============\n\nMatrix serves raw user generated data in some APIs - specifically the `content\nrepository endpoints `_.\n\nWhilst we have tried to mitigate against possible XSS attacks (e.g.\nhttps://github.com/matrix-org/synapse/pull/1021) we recommend running\nmatrix homeservers on a dedicated domain name, to limit any malicious user generated\ncontent served to web browsers a matrix API from being able to attack webapps hosted\non the same domain. This is particularly true of sharing a matrix webclient and\nserver on the same domain.\n\nSee https://github.com/vector-im/riot-web/issues/1977 and\nhttps://developer.github.com/changes/2014-04-25-user-content-security for more details.\n\n\nUpgrading an existing Synapse\n=============================\n\nThe instructions for upgrading synapse are in `UPGRADE.rst`_.\nPlease check these instructions as upgrading may require extra steps for some\nversions of synapse.\n\n.. _UPGRADE.rst: UPGRADE.rst\n\n\nUsing PostgreSQL\n================\n\nSynapse offers two database engines:\n * `SQLite `_\n * `PostgreSQL `_\n\nBy default Synapse uses SQLite in and doing so trades performance for convenience.\nSQLite is only recommended in Synapse for testing purposes or for servers with\nlight workloads.\n\nAlmost all installations should opt to use PostreSQL. Advantages include:\n\n* significant performance improvements due to the superior threading and\n caching model, smarter query optimiser\n* allowing the DB to be run on separate hardware\n* allowing basic active/backup high-availability with a \"hot spare\" synapse\n pointing at the same DB master, as well as enabling DB replication in\n synapse itself.\n\nFor information on how to install and use PostgreSQL, please see\n`docs/postgres.rst `_.\n\n.. _reverse-proxy:\n\nUsing a reverse proxy with Synapse\n==================================\n\nIt is recommended to put a reverse proxy such as\n`nginx `_,\n`Apache `_,\n`Caddy `_ or\n`HAProxy `_ in front of Synapse. One advantage of\ndoing so is that it means that you can expose the default https port (443) to\nMatrix clients without needing to run Synapse with root privileges.\n\nFor information on configuring one, see ``_.\n\nIdentity Servers\n================\n\nIdentity servers have the job of mapping email addresses and other 3rd Party\nIDs (3PIDs) to Matrix user IDs, as well as verifying the ownership of 3PIDs\nbefore creating that mapping.\n\n**They are not where accounts or credentials are stored - these live on home\nservers. Identity Servers are just for mapping 3rd party IDs to matrix IDs.**\n\nThis process is very security-sensitive, as there is obvious risk of spam if it\nis too easy to sign up for Matrix accounts or harvest 3PID data. In the longer\nterm, we hope to create a decentralised system to manage it (`matrix-doc #712\n`_), but in the meantime,\nthe role of managing trusted identity in the Matrix ecosystem is farmed out to\na cluster of known trusted ecosystem partners, who run 'Matrix Identity\nServers' such as `Sydent `_, whose role\nis purely to authenticate and track 3PID logins and publish end-user public\nkeys.\n\nYou can host your own copy of Sydent, but this will prevent you reaching other\nusers in the Matrix ecosystem via their email address, and prevent them finding\nyou. We therefore recommend that you use one of the centralised identity servers\nat ``https://matrix.org`` or ``https://vector.im`` for now.\n\nTo reiterate: the Identity server will only be used if you choose to associate\nan email address with your account, or send an invite to another user via their\nemail address.\n\n\nPassword reset\n==============\n\nIf a user has registered an email address to their account using an identity\nserver, they can request a password-reset token via clients such as Riot.\n\nA manual password reset can be done via direct database access as follows.\n\nFirst calculate the hash of the new password::\n\n $ ~/synapse/env/bin/hash_password\n Password:\n Confirm password:\n $2a$12$xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n\nThen update the `users` table in the database::\n\n UPDATE users SET password_hash='$2a$12$xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'\n WHERE name='@test:test.com';\n\n\nSynapse Development\n===================\n\nBefore setting up a development environment for synapse, make sure you have the\nsystem dependencies (such as the python header files) installed - see\n`Installing from source `_.\n\nTo check out a synapse for development, clone the git repo into a working\ndirectory of your choice::\n\n git clone https://github.com/matrix-org/synapse.git\n cd synapse\n\nSynapse has a number of external dependencies, that are easiest\nto install using pip and a virtualenv::\n\n virtualenv -p python3 env\n source env/bin/activate\n python -m pip install --no-use-pep517 -e .[all]\n\nThis will run a process of downloading and installing all the needed\ndependencies into a virtual env.\n\nOnce this is done, you may wish to run Synapse's unit tests, to\ncheck that everything is installed as it should be::\n\n python -m twisted.trial tests\n\nThis should end with a 'PASSED' result::\n\n Ran 143 tests in 0.601s\n\n PASSED (successes=143)\n\nRunning the Integration Tests\n=============================\n\nSynapse is accompanied by `SyTest `_,\na Matrix homeserver integration testing suite, which uses HTTP requests to\naccess the API as a Matrix client would. It is able to run Synapse directly from\nthe source tree, so installation of the server is not required.\n\nTesting with SyTest is recommended for verifying that changes related to the\nClient-Server API are functioning correctly. See the `installation instructions\n`_ for details.\n\nBuilding Internal API Documentation\n===================================\n\nBefore building internal API documentation install sphinx and\nsphinxcontrib-napoleon::\n\n pip install sphinx\n pip install sphinxcontrib-napoleon\n\nBuilding internal API documentation::\n\n python setup.py build_sphinx\n\nTroubleshooting\n===============\n\nRunning out of File Handles\n---------------------------\n\nIf synapse runs out of file handles, it typically fails badly - live-locking\nat 100% CPU, and/or failing to accept new TCP connections (blocking the\nconnecting client). Matrix currently can legitimately use a lot of file handles,\nthanks to busy rooms like #matrix:matrix.org containing hundreds of participating\nservers. The first time a server talks in a room it will try to connect\nsimultaneously to all participating servers, which could exhaust the available\nfile descriptors between DNS queries & HTTPS sockets, especially if DNS is slow\nto respond. (We need to improve the routing algorithm used to be better than\nfull mesh, but as of March 2019 this hasn't happened yet).\n\nIf you hit this failure mode, we recommend increasing the maximum number of\nopen file handles to be at least 4096 (assuming a default of 1024 or 256).\nThis is typically done by editing ``/etc/security/limits.conf``\n\nSeparately, Synapse may leak file handles if inbound HTTP requests get stuck\nduring processing - e.g. blocked behind a lock or talking to a remote server etc.\nThis is best diagnosed by matching up the 'Received request' and 'Processed request'\nlog lines and looking for any 'Processed request' lines which take more than\na few seconds to execute. Please let us know at #synapse:matrix.org if\nyou see this failure mode so we can help debug it, however.\n\nHelp!! Synapse is slow and eats all my RAM/CPU!\n-----------------------------------------------\n\nFirst, ensure you are running the latest version of Synapse, using Python 3\nwith a PostgreSQL database.\n\nSynapse's architecture is quite RAM hungry currently - we deliberately\ncache a lot of recent room data and metadata in RAM in order to speed up\ncommon requests. We'll improve this in the future, but for now the easiest\nway to either reduce the RAM usage (at the risk of slowing things down)\nis to set the almost-undocumented ``SYNAPSE_CACHE_FACTOR`` environment\nvariable. The default is 0.5, which can be decreased to reduce RAM usage\nin memory constrained enviroments, or increased if performance starts to\ndegrade.\n\nHowever, degraded performance due to a low cache factor, common on\nmachines with slow disks, often leads to explosions in memory use due\nbacklogged requests. In this case, reducing the cache factor will make\nthings worse. Instead, try increasing it drastically. 2.0 is a good\nstarting value.\n\nUsing `libjemalloc `_ can also yield a significant\nimprovement in overall memory use, and especially in terms of giving back\nRAM to the OS. To use it, the library must simply be put in the\nLD_PRELOAD environment variable when launching Synapse. On Debian, this\ncan be done by installing the ``libjemalloc1`` package and adding this\nline to ``/etc/default/matrix-synapse``::\n\n LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.1\n\nThis can make a significant difference on Python 2.7 - it's unclear how\nmuch of an improvement it provides on Python 3.x.\n\nIf you're encountering high CPU use by the Synapse process itself, you\nmay be affected by a bug with presence tracking that leads to a\nmassive excess of outgoing federation requests (see `discussion\n`_). If metrics\nindicate that your server is also issuing far more outgoing federation\nrequests than can be accounted for by your users' activity, this is a\nlikely cause. The misbehavior can be worked around by setting\n``use_presence: false`` in the Synapse config file.\n\nPeople can't accept room invitations from me\n--------------------------------------------\n\nThe typical failure mode here is that you send an invitation to someone \nto join a room or direct chat, but when they go to accept it, they get an\nerror (typically along the lines of \"Invalid signature\"). They might see\nsomething like the following in their logs::\n\n 2019-09-11 19:32:04,271 - synapse.federation.transport.server - 288 - WARNING - GET-11752 - authenticate_request failed: 401: Invalid signature for server with key ed25519:a_EqML: Unable to verify signature for \n\nThis is normally caused by a misconfiguration in your reverse-proxy. See\n``_ and double-check that your settings are correct.\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",312970714,"orgData",{"_86":87,"_88":89,"_90":91,"_92":29,"_93":94,"_95":94,"_96":97,"_98":94,"_99":100,"_101":94,"_102":94,"_103":94,"_104":17},"id","e2ad06bcdb38410b941010ba75697c38","uuid","e2ad06bc-db38-410b-9410-10ba75697c38","type","organization","orgname","full_name","","location","company","EPFL","profile_url","date_joined","2019-04-11T12:53:54.379462Z","gravatar_url","gravatar_email","badge","is_active","recentTags",[107],{"_108":40,"_109":110,"_111":112,"_86":113,"_114":115,"_46":132,"_133":110,"_134":29,"_135":52,"_53":136,"_137":138,"_139":123,"_140":132,"_141":62,"_142":17},"content_type","creator",6022955,"full_size",74483248,70424178,"images",[116],{"_117":118,"_119":120,"_121":94,"_122":123,"_124":125,"_126":127,"_128":94,"_129":-5,"_130":112,"_59":62,"_131":-5},"architecture","amd64","digest","sha256:0bb3decdf984de03aa526d62fc303266d7bf64b1835c6db32ef3106f80be414f","features","last_pulled","2026-09-16T13:04:54.552939317Z","last_pushed","2019-10-29T13:30:51Z","os","linux","os_features","os_version","size","variant","2019-10-29T13:30:50.941316Z","last_updater","last_updater_username","media_type","latest","repository",7768350,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":152,"_159":160,"_148":169,"_170":11},{"_36":153,"_38":154,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":155,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":156,"_75":11,"_76":158,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":157},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_161":60,"_162":-5,"_163":-5,"_164":165},"count","next","previous","results",[166],{"_108":40,"_109":110,"_111":112,"_86":113,"_114":167,"_46":132,"_133":110,"_134":29,"_135":52,"_53":136,"_137":138,"_139":123,"_140":132,"_141":62,"_142":17},[168],{"_117":118,"_119":120,"_121":94,"_122":123,"_124":125,"_126":127,"_128":94,"_129":-5,"_130":112,"_59":62,"_131":-5},[],"canDeleteTags","actionData","errors"]

c4dt/synapse

Tags for c4dt/synapse