Skip to main content

Homeserver for the Matrix decentralised comms protocol

Project description

./docs/element_logo_white_bg.svg

Element Synapse - Matrix homeserver implementation

(get community support in #synapse:matrix.org) (discuss development on #synapse-dev:matrix.org) (Rendered documentation on GitHub Pages) (check license in LICENSE file) (latest version released on PyPi) (supported python versions)

Synapse is an open source Matrix homeserver implementation, written and maintained by Element. Matrix is the open standard for secure and interoperable real time communications. You can directly run and manage the source code in this repository, available under an AGPL license (or alternatively under a commercial license from Element). There is no support provided by Element unless you have a subscription from Element.

Subscription

For those that need an enterprise-ready solution, Element Server Suite (ESS) is available via subscription. ESS builds on Synapse to offer a complete Matrix-based backend including the full Admin Console product, giving admins the power to easily manage an organization-wide deployment. It includes advanced identity management, auditing, moderation and data retention options as well as Long Term Support and SLAs. ESS can be used to support any Matrix-based frontend client.

🛠️ Installing and configuration

The Synapse documentation describes how to install Synapse. We recommend using Docker images or Debian packages from Matrix.org.

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.

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.

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.

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 https://developer.github.com/changes/2014-04-25-user-content-security for more information.

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.

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

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 https://app.element.io/#/login or https://app.element.io/#/register respectively. You will need to change the server you are logging into from matrix.org 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.

Registering a new user from a client

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

  1. In the registration config section set enable_registration: true in homeserver.yaml.

  2. Then either:

    1. set up a CAPTCHA, or

    2. 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 targeting the rest of the Matrix federation.

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:

@localpart:my.domain.name

(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

🚀 Professional support

Enterprise quality support for Synapse including SLAs is available as part of an Element Server Suite (ESS) subscription.

If you are an existing ESS subscriber then you can raise a support request and access the knowledge base.

🤝 Community 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 #synapse:matrix.org (from a matrix.org account if necessary). We do not use GitHub issues for support requests, only for bug reports and feature requests.

🪪 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 keys.

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 https://matrix.org or https://vector.im 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.

🛠️ Development

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:

Alongside all that, join our developer community on Matrix: #synapse-dev:matrix.org, featuring real humans!

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

matrix_synapse-1.133.0.tar.gz (3.8 MB view details)

Uploaded Source

Built Distributions

matrix_synapse-1.133.0-pp311-pypy311_pp73-manylinux_2_28_x86_64.whl (6.2 MB view details)

Uploaded PyPymanylinux: glibc 2.28+ x86-64

matrix_synapse-1.133.0-pp311-pypy311_pp73-macosx_10_15_x86_64.whl (5.8 MB view details)

Uploaded PyPymacOS 10.15+ x86-64

matrix_synapse-1.133.0-pp310-pypy310_pp73-manylinux_2_28_x86_64.whl (6.2 MB view details)

Uploaded PyPymanylinux: glibc 2.28+ x86-64

matrix_synapse-1.133.0-pp310-pypy310_pp73-macosx_10_15_x86_64.whl (5.8 MB view details)

Uploaded PyPymacOS 10.15+ x86-64

matrix_synapse-1.133.0-cp39-abi3-musllinux_1_2_x86_64.whl (6.2 MB view details)

Uploaded CPython 3.9+musllinux: musl 1.2+ x86-64

matrix_synapse-1.133.0-cp39-abi3-manylinux_2_28_x86_64.whl (6.2 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.28+ x86-64

matrix_synapse-1.133.0-cp39-abi3-manylinux_2_28_aarch64.whl (6.1 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.28+ ARM64

matrix_synapse-1.133.0-cp39-abi3-macosx_10_9_x86_64.whl (5.8 MB view details)

Uploaded CPython 3.9+macOS 10.9+ x86-64

File details

Details for the file matrix_synapse-1.133.0.tar.gz.

File metadata

  • Download URL: matrix_synapse-1.133.0.tar.gz
  • Upload date:
  • Size: 3.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for matrix_synapse-1.133.0.tar.gz
Algorithm Hash digest
SHA256 1f1a13c6b4996672984aa6aa4fc26d59d72e4284a1fb7458ab229fb2e383f2da
MD5 df9a618d601cad3e37d121c8cc3a5cb5
BLAKE2b-256 32afe47fe123b3a04ddd9ca471126a0cc840f9887101ceb0a5af3c20c7094e75

See more details on using hashes here.

File details

Details for the file matrix_synapse-1.133.0-pp311-pypy311_pp73-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for matrix_synapse-1.133.0-pp311-pypy311_pp73-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 d8d247d58a56cb6d4c6ae83e419da3196f93695b04a9a18681a251af3136279e
MD5 6d05120689b20735fac6cfedaa2907c2
BLAKE2b-256 79cac776a252af6ae539f72f70c78d1cfd6e11fa343c3e25a14abf7b2c1d48d1

See more details on using hashes here.

File details

Details for the file matrix_synapse-1.133.0-pp311-pypy311_pp73-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for matrix_synapse-1.133.0-pp311-pypy311_pp73-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 6b1f4d7bdf252cc7a5fe7a6e771eb7a2aec75705fe02df4e925bc5e8f42e9ec6
MD5 02d6d267815551e8e79b44fa7afc4276
BLAKE2b-256 97e84f4521ed3ddecbd92ad7caf934f4195001509611fcba8b204f11ccbf2be7

See more details on using hashes here.

File details

Details for the file matrix_synapse-1.133.0-pp310-pypy310_pp73-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for matrix_synapse-1.133.0-pp310-pypy310_pp73-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 269b58dc51966245030d4a47ad19f212e762076d1265465ac18220547135bbd8
MD5 bcb36faf3c167ffe73e9548422cbcd6a
BLAKE2b-256 bff8d2d5f65794e1b72f62775a6fcb91b8f943ab8023f65fc46e5700ec58f1ec

See more details on using hashes here.

File details

Details for the file matrix_synapse-1.133.0-pp310-pypy310_pp73-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for matrix_synapse-1.133.0-pp310-pypy310_pp73-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 855538edecd6a00fb0728a062b2fd36d1f9f635ed55479bfee1daaea3f64c276
MD5 43d10806d65002c62b1603930e193daf
BLAKE2b-256 4cd0565a54d2d15a8516c63d91fa9d9c1a1234d61917d173977732afdfb28057

See more details on using hashes here.

File details

Details for the file matrix_synapse-1.133.0-cp39-abi3-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for matrix_synapse-1.133.0-cp39-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 6e6b2155281bc1062f8431b01183ea415fe76d8349a1a9fa3dee1ad289af704b
MD5 86f17ba68be197e455669b115d419c88
BLAKE2b-256 9bb7181baaeb205b408fb88c977f84aa38374f2512a7b156e60198e6579fe4ea

See more details on using hashes here.

File details

Details for the file matrix_synapse-1.133.0-cp39-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for matrix_synapse-1.133.0-cp39-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 ae717330a7578bbddf88f5b1e76082373d9f5c62f3cb7a8cfb2f03d3ba793427
MD5 380f112732727a95ab2446e58a27f8a0
BLAKE2b-256 42688047c837bf41e4fe7c7fc107ff75e5cd640035cc5130c3f6271a34ca4321

See more details on using hashes here.

File details

Details for the file matrix_synapse-1.133.0-cp39-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for matrix_synapse-1.133.0-cp39-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 a14145062ea148fb6d2983bf64555559605a0cf8c79746ce797abd8e015700d8
MD5 506517fa96b925a71d10ce042c20d844
BLAKE2b-256 11dc629687c635fb81bda85d37de2b35495b248c1d604d04645a84e1a9d74f50

See more details on using hashes here.

File details

Details for the file matrix_synapse-1.133.0-cp39-abi3-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for matrix_synapse-1.133.0-cp39-abi3-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 1315cbb7a5f61c94c7bdd0a04c0a50ea7d6ab34b3dc9d4c21177095341b016ea
MD5 9a68d852810e6edd842e8af528bdaa50
BLAKE2b-256 85ed4fb0b103f756617cc1691a5d95b0cdc58a984da49160e7eccd3c1e588764

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page