Element Synapse - Matrix homeserver implementation
(discuss development on #synapse-dev:matrix.org) (check license in LICENSE file) (supported python versions)
Synapse is an open source Element. Subscription alternative
Alternatively, for those that need an enterprise-ready solution, Element Server Suite (ESS) is 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.
Contents
The Synapse documentation describes Docker images or config options which can be used to customise its behaviour after installation. There are additional details on how to Using a reverse proxy with Synapse
It is recommended to put a reverse proxy such as Apache, HAProxy or the reverse proxy docs.
The instructions for upgrading Synapse are in Platform dependencies
Synapse uses a number of platform dependencies such as Python and PostgreSQL, and aims to follow supported upstream versions. See the Security note
Matrix serves raw, user-supplied data in some APIs -- specifically the 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 registered domain (also known as top-level site or eTLD+1). This is because 🧪 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 https://app.element.io/#/login or client breakdown.
If all goes well you should at least be able to log in, create a room, and start sending messages.
By default, registration of new users via Matrix clients is disabled. To enable it:
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.
Enterprise quality support for Synapse including SLAs is available as part of an support request and access the 🤝 Community support
The Synapse's wider documentation.
For additional support installing or managing Synapse, please ask in the community support room 🪪 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 (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.
We welcome contributions to Synapse from the community! The best place to get started is our documentation, which includes
information for Synapse developers as well as Synapse administrators. Developers might be particularly interested in:
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。