Synapse: Matrix reference homeserver
Go to file
Paarth Shah 670d590f8a
Pin pydantic to <2.0.0 (#15862)
Signed-off-by: Paarth Shah <>
2023-07-04 09:33:24 +02:00
.ci Relax poetry-core lower bound to 1.1.0 (#15571) 2023-05-12 11:21:11 +01:00
.github Fix Sytest environmental variable evaluation in CI (#15804) 2023-06-20 07:55:46 -07:00
changelog.d Pin pydantic to <2.0.0 (#15862) 2023-07-04 09:33:24 +02:00
contrib Switch from matrix:// to matrix-federation:// scheme for internal Synapse routing of outbound federation traffic (#15806) 2023-06-20 10:05:31 +01:00
debian Prepare changelog for v1.87.0rc1 2023-06-27 10:29:20 -05:00
demo Suppress the trusted key server warning for in the demo scripts (#15527) 2023-05-03 12:07:49 +00:00
dev-docs Add developer documentation for the Federation Sender and add a documentation mechanism using Sphinx. (#15265) 2023-03-24 16:41:10 +00:00
docker Remove experimental MSC2716 implementation to incrementally import history into existing rooms (#15748) 2023-06-16 14:12:24 -05:00
docs Split out 2022 changes from the changelog (#15846) 2023-06-28 15:10:33 -05:00
rust push rules: fix internal conversion from _type to value (#15781) 2023-06-16 14:17:02 +02:00
scripts-dev Switch from matrix:// to matrix-federation:// scheme for internal Synapse routing of outbound federation traffic (#15806) 2023-06-20 10:05:31 +01:00
stubs Stabilize support for MSC3952: Intentional mentions. (#15520) 2023-06-06 09:11:07 +01:00
synapse devices: use combined ANY clause for faster cleanup (#15861) 2023-07-03 16:39:38 +02:00
synmark Bump black from 22.12.0 to 23.1.0 (#15103) 2023-02-22 15:29:09 -05:00
tests Add login spam checker API (#15838) 2023-06-26 14:12:20 +00:00
.codecov.yml Disable codecov reports to GH comments. 2019-07-31 10:56:02 +01:00
.coveragerc Fix coverage in sytest and use plugins for buildkite (#5922) 2019-08-29 22:19:57 +10:00
.dockerignore Fix pinning Rust deps in docker images (#14129) 2022-10-11 10:53:34 +00:00
.editorconfig Apply correct editorconfig to .pyi files (#14526) 2022-11-22 18:33:28 +00:00
.git-blame-ignore-revs Update .git-blame-ignore-revs for #15103. 2023-02-22 15:30:41 -05:00
.gitignore Fix the devenv up configuration which was ignoring the config overrides. (#15854) 2023-07-03 11:39:52 +01:00
.rustfmt.toml Port the push rule classes to Rust. (#13768) 2022-09-20 12:10:31 +01:00
AUTHORS.rst Automatically delete empty groups/communities (#6453) 2019-12-16 12:12:40 +00:00
book.toml Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 2021-06-03 17:20:40 +01:00 Always build Rust extension in release mode (#14009) 2022-10-03 11:20:18 +01:00
Cargo.lock Bump serde_json from 1.0.97 to 1.0.99 (#15832) 2023-06-26 15:36:33 +01:00
Cargo.toml Add a stub Rust crate (#12595) 2022-09-06 19:01:37 +01:00 Split out 2022 changes from the changelog (#15846) 2023-06-28 15:10:33 -05:00 Advertise docs (#10595) 2021-08-31 11:29:27 +01:00
flake.lock Switch back to upstream devenv flake (#15533) 2023-05-03 14:40:10 +00:00
flake.nix Fix the devenv up configuration which was ignoring the config overrides. (#15854) 2023-07-03 11:39:52 +01:00 Fix broken links in (#10331) 2021-07-08 15:46:13 +01:00
LICENSE Reference Matrix Home Server 2014-08-12 15:10:52 +01:00
mypy.ini Add stubs package for lxml. (#15697) 2023-05-31 17:06:57 +00:00
poetry.lock Pin pydantic to <2.0.0 (#15862) 2023-07-04 09:33:24 +02:00
pylint.cfg Added pylint config file: ignore missing-docstring messages. 2014-10-24 10:22:09 +01:00
pyproject.toml Pin pydantic to <2.0.0 (#15862) 2023-07-04 09:33:24 +02:00
README.rst fix grammar 2022-09-03 11:08:28 +01:00
sytest-blacklist Back out implementation of MSC2314 (#12474) 2022-04-19 11:17:29 +00:00
tox.ini Run lints under poetry in CI; remove lint tox jobs (#12434) 2022-04-12 17:35:48 +01:00
UPGRADE.rst fix broken link to upgrade notes (#10631) 2021-08-18 12:38:37 +01:00

Synapse |support| |development| |documentation| |license| |pypi| |python|

Synapse is an open-source `Matrix <>`_ homeserver written and
maintained by the Foundation. We began rapid development in 2014,
reaching v1.0.0 in 2019. Development on Synapse and the Matrix protocol itself continues
in earnest today.

Briefly, Matrix is an open standard for communications on the internet, supporting
federation, encryption and VoIP. has more to say about the `goals of the
Matrix project <>`_, and the `formal specification
<>`_ describes the technical details.

.. contents::

Installing and configuration

The Synapse documentation describes `how to install Synapse <>`_. We recommend using
`Docker images <>`_ or `Debian packages from

.. _federation:

Synapse has a variety of `config options
which can be used to customise its behaviour after installation.
There are additional details on how to `configure Synapse for federation here

.. _reverse-proxy:

Using a reverse proxy with Synapse

It is recommended to put a reverse proxy such as
`nginx <>`_,
`Apache <>`_,
`Caddy <>`_,
`HAProxy <>`_ or
`relayd <>`_ in front of Synapse. One advantage of
doing so is that it means that you can expose the default https port (443) to
Matrix clients without needing to run Synapse with root privileges.
For information on configuring one, see `the reverse proxy docs

Upgrading an existing Synapse

The instructions for upgrading Synapse are in `the upgrade notes`_.
Please check these instructions as upgrading may require extra steps for some
versions of Synapse.

.. _the upgrade notes:

Platform dependencies

Synapse uses a number of platform dependencies such as Python and PostgreSQL,
and aims to follow supported upstream versions. See the
`deprecation policy <>`_
for more details.

Security note

Matrix serves raw, user-supplied data in some APIs -- specifically the `content
repository endpoints`_.

.. _content repository endpoints:

Whilst we make a reasonable effort to mitigate against XSS attacks (for
instance, by using `CSP`_), a Matrix homeserver should not be hosted on a
domain hosting other web applications. This especially applies to sharing
the domain with Matrix web clients and other sensitive applications like
webmail. See for more

.. _CSP:

Ideally, the homeserver should not simply be on a different subdomain, but on
a completely different `registered domain`_ (also known as top-level site or
eTLD+1). This is because `some attacks`_ are still possible as long as the two
applications share the same registered domain.

.. _registered domain:

.. _some attacks:

To illustrate this with an example, if your Element Web or other sensitive web
application is hosted on ````, you should ideally host Synapse on
````. Some amount of protection is offered by hosting on
```` instead, so this is also acceptable in some scenarios.
However, you should *not* host your Synapse on ````.

Note that all of the above refers exclusively to the domain used in Synapse's
``public_baseurl`` setting. In particular, it has no bearing on the domain
mentioned in MXIDs hosted on that server.

Following this advice ensures that even if an XSS is found in Synapse, the
impact to other applications will be minimal.

Testing a new installation

The easiest way to try out your new Synapse installation is by connecting to it
from a web client.

Unless you are running a test instance of Synapse on your local machine, in
general, you will need to enable TLS support before you can successfully
connect from a client: see
`TLS certificates <>`_.

An easy way to get started is to login or register via Element at or respectively.
You will need to change the server you are logging into from ````
and instead specify a Homeserver URL of ``https://<server_name>:8448``
(or just ``https://<server_name>`` if you are using a reverse proxy).
If you prefer to use another client, refer to our
`client breakdown <>`_.

If all goes well you should at least be able to log in, create a room, and
start sending messages.

.. _`client-user-reg`:

Registering a new user from a client

By default, registration of new users via Matrix clients is disabled. To enable

1. In the
   `registration config section <>`_
   set ``enable_registration: true`` in ``homeserver.yaml``.
2. Then **either**:

   a. set up a `CAPTCHA <>`_, or
   b. set ``enable_registration_without_verification: true`` in ``homeserver.yaml``.

We **strongly** recommend using a CAPTCHA, particularly if your homeserver is exposed to
the public internet. Without it, anyone can freely register accounts on your homeserver.
This can be exploited by attackers to create spambots targetting the rest of the Matrix

Your new user name will be formed partly from the ``server_name``, and partly
from a localpart you specify when you create the account. Your name will take
the form of::

(pronounced "at localpart on my dot domain dot name").

As when logging in, you will need to specify a "Custom server".  Specify your
desired ``localpart`` in the 'User name' box.

Troubleshooting and support

The `Admin FAQ <>`_
includes tips on dealing with some common problems. For more details, see
`Synapse's wider documentation <>`_.

For additional support installing or managing Synapse, please ask in the community
support room |room|_ (from a account if necessary). We do not use GitHub
issues for support requests, only for bug reports and feature requests.

.. |room| replace:: ````
.. _room:

.. |docs| replace:: ``docs``
.. _docs: docs

Identity Servers

Identity servers have the job of mapping email addresses and other 3rd Party
IDs (3PIDs) to Matrix user IDs, as well as verifying the ownership of 3PIDs
before creating that mapping.

**They are not where accounts or credentials are stored - these live on home
servers. Identity Servers are just for mapping 3rd party IDs to matrix IDs.**

This process is very security-sensitive, as there is obvious risk of spam if it
is too easy to sign up for Matrix accounts or harvest 3PID data. In the longer
term, we hope to create a decentralised system to manage it (`matrix-doc #712
<>`_), but in the meantime,
the role of managing trusted identity in the Matrix ecosystem is farmed out to
a cluster of known trusted ecosystem partners, who run 'Matrix Identity
Servers' such as `Sydent <>`_, whose role
is purely to authenticate and track 3PID logins and publish end-user public

You can host your own copy of Sydent, but this will prevent you reaching other
users in the Matrix ecosystem via their email address, and prevent them finding
you. We therefore recommend that you use one of the centralised identity servers
at ```` or ```` for now.

To reiterate: the Identity server will only be used if you choose to associate
an email address with your account, or send an invite to another user via their
email address.


We welcome contributions to Synapse from the community!
The best place to get started is our
`guide for contributors <>`_.
This is part of our larger `documentation <>`_, which includes

information for Synapse developers as well as Synapse administrators.
Developers might be particularly interested in:

* `Synapse's database schema <>`_,
* `notes on Synapse's implementation details <>`_, and
* `how we use git <>`_.

Alongside all that, join our developer community on Matrix:
` <>`_, featuring real humans!

.. |support| image::
  :alt: (get support on

.. |development| image::
  :alt: (discuss development on

.. |documentation| image::
  :alt: (Rendered documentation on GitHub Pages)

.. |license| image::
  :alt: (check license in LICENSE file)
  :target: LICENSE

.. |pypi| image::
  :alt: (latest version released on PyPi)

.. |python| image::
  :alt: (supported python versions)