matrix-synapse 1.142.0rc3__cp314-abi3-musllinux_1_2_aarch64.whl

matrix_synapse-1.142.0rc3.dist-info/METADATA

@@ -0,0 +1,375 @@
+Metadata-Version: 2.3
+Name: matrix-synapse
+Version: 1.142.0rc3
+Summary: Homeserver for the Matrix decentralised comms protocol
+License: AGPL-3.0-or-later OR LicenseRef-Element-Commercial
+Author: Matrix.org Team and Contributors
+Author-email: packages@matrix.org
+Requires-Python: >=3.10.0,<4.0.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications :: Chat
+Provides-Extra: all
+Provides-Extra: cache-memory
+Provides-Extra: jwt
+Provides-Extra: matrix-synapse-ldap3
+Provides-Extra: oidc
+Provides-Extra: opentracing
+Provides-Extra: postgres
+Provides-Extra: redis
+Provides-Extra: saml2
+Provides-Extra: sentry
+Provides-Extra: systemd
+Provides-Extra: test
+Provides-Extra: url-preview
+Requires-Dist: Jinja2 (>=3.0)
+Requires-Dist: Pillow (>=10.0.1)
+Requires-Dist: PyYAML (>=5.3)
+Requires-Dist: Pympler ; extra == "cache-memory" or extra == "all"
+Requires-Dist: Twisted[tls] (>=21.2.0)
+Requires-Dist: attrs (>=19.2.0,!=21.1.0)
+Requires-Dist: authlib (>=0.15.1) ; extra == "oidc" or extra == "jwt" or extra == "all"
+Requires-Dist: bcrypt (>=3.1.7)
+Requires-Dist: bleach (>=3.2.0)
+Requires-Dist: canonicaljson (>=2.0.0,<3.0.0)
+Requires-Dist: cryptography (>=3.4.7)
+Requires-Dist: hiredis ; extra == "redis" or extra == "all"
+Requires-Dist: idna (>=2.5) ; extra == "test"
+Requires-Dist: ijson (>=3.1.4)
+Requires-Dist: immutabledict (>=2.0)
+Requires-Dist: jaeger-client (>=4.2.0) ; extra == "opentracing" or extra == "all"
+Requires-Dist: jsonschema (>=3.0.0)
+Requires-Dist: lxml (>=4.6.3) ; extra == "url-preview" or extra == "all"
+Requires-Dist: matrix-common (>=1.3.0,<2.0.0)
+Requires-Dist: matrix-synapse-ldap3 (>=0.1) ; extra == "matrix-synapse-ldap3" or extra == "all"
+Requires-Dist: msgpack (>=0.5.2)
+Requires-Dist: netaddr (>=0.7.18)
+Requires-Dist: opentracing (>=2.2.0) ; extra == "opentracing" or extra == "all"
+Requires-Dist: packaging (>=20.0)
+Requires-Dist: parameterized (>=0.7.4) ; extra == "test"
+Requires-Dist: phonenumbers (>=8.2.0)
+Requires-Dist: prometheus-client (>=0.6.0)
+Requires-Dist: psycopg2 (>=2.8) ; (platform_python_implementation != "PyPy") and (extra == "postgres" or extra == "all")
+Requires-Dist: psycopg2cffi (>=2.8) ; (platform_python_implementation == "PyPy") and (extra == "postgres" or extra == "all")
+Requires-Dist: psycopg2cffi-compat (==1.1) ; (platform_python_implementation == "PyPy") and (extra == "postgres" or extra == "all")
+Requires-Dist: pyOpenSSL (>=16.0.0)
+Requires-Dist: pyasn1 (>=0.1.9)
+Requires-Dist: pyasn1-modules (>=0.0.7)
+Requires-Dist: pydantic (>=2.12,<3.0) ; python_version >= "3.14"
+Requires-Dist: pydantic (>=2.8,<3.0) ; python_version < "3.14"
+Requires-Dist: pymacaroons (>=0.13.0)
+Requires-Dist: pysaml2 (>=4.5.0) ; extra == "saml2" or extra == "all"
+Requires-Dist: python-multipart (>=0.0.9)
+Requires-Dist: rpds-py (>=0.25.0)
+Requires-Dist: sentry-sdk (>=0.7.2) ; extra == "sentry" or extra == "all"
+Requires-Dist: service-identity (>=18.1.0)
+Requires-Dist: setuptools_rust (>=1.3)
+Requires-Dist: signedjson (>=1.1.0,<2.0.0)
+Requires-Dist: sortedcontainers (>=2.0.5)
+Requires-Dist: systemd-python (>=231) ; extra == "systemd"
+Requires-Dist: treq (>=21.5.0)
+Requires-Dist: txredisapi (>=1.4.7) ; extra == "redis" or extra == "all"
+Requires-Dist: typing-extensions (>=4.14.1)
+Requires-Dist: unpaddedbase64 (>=2.1.0)
+Project-URL: Repository, https://github.com/element-hq/synapse
+Description-Content-Type: text/x-rst
+
+.. image:: ./docs/element_logo_white_bg.svg
+   :height: 60px
+
+**Element Synapse - Matrix homeserver implementation**
+
+|support| |development| |documentation| |license| |pypi| |python|
+
+Synapse is an open source `Matrix <https://matrix.org>`__ homeserver
+implementation, written and maintained by `Element <https://element.io>`_.
+`Matrix <https://github.com/matrix-org>`__ 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 <https://element.io/pricing>`_.
+ESS builds on Synapse to offer a complete Matrix-based backend including the full
+`Admin Console product <https://element.io/enterprise-functionality/admin-console>`_,
+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 supports any Matrix-compatible client.
+
+.. contents::
+
+🛠️ Installation and configuration
+==================================
+
+The Synapse documentation describes `how to install Synapse <https://element-hq.github.io/synapse/latest/setup/installation.html>`_. We recommend using
+`Docker images <https://element-hq.github.io/synapse/latest/setup/installation.html#docker-images-and-ansible-playbooks>`_ or `Debian packages from Matrix.org
+<https://element-hq.github.io/synapse/latest/setup/installation.html#matrixorg-packages>`_.
+
+.. _federation:
+
+Synapse has a variety of `config options
+<https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html>`_
+which can be used to customise its behaviour after installation.
+There are additional details on how to `configure Synapse for federation here
+<https://element-hq.github.io/synapse/latest/federate.html>`_.
+
+.. _reverse-proxy:
+
+Using a reverse proxy with Synapse
+----------------------------------
+
+It is recommended to put a reverse proxy such as
+`nginx <https://nginx.org/en/docs/http/ngx_http_proxy_module.html>`_,
+`Apache <https://httpd.apache.org/docs/current/mod/mod_proxy_http.html>`_,
+`Caddy <https://caddyserver.com/docs/quick-starts/reverse-proxy>`_,
+`HAProxy <https://www.haproxy.org/>`_ or
+`relayd <https://man.openbsd.org/relayd.8>`_ 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
+<https://element-hq.github.io/synapse/latest/reverse_proxy.html>`_.
+
+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: https://element-hq.github.io/synapse/develop/upgrade.html
+
+
+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 <https://element-hq.github.io/synapse/latest/deprecation_policy.html>`_
+for more details.
+
+
+Security note
+-------------
+
+Matrix serves raw, user-supplied data in some APIs -- specifically the `content
+repository endpoints`_.
+
+.. _content repository endpoints: https://matrix.org/docs/spec/client_server/latest.html#get-matrix-media-r0-download-servername-mediaid
+
+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.
+
+.. _CSP: https://github.com/matrix-org/synapse/pull/1021
+
+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: https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-2.3
+
+.. _some attacks: https://en.wikipedia.org/wiki/Session_fixation#Attacks_using_cross-subdomain_cookie
+
+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 <https://element-hq.github.io/synapse/latest/setup/installation.html#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 <https://matrix.org/ecosystem/clients/>`_.
+
+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
+it:
+
+1. In the
+   `registration config section <https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#registration>`_
+   set ``enable_registration: true`` in ``homeserver.yaml``.
+2. Then **either**:
+
+   a. set up a `CAPTCHA <https://element-hq.github.io/synapse/latest/CAPTCHA_SETUP.html>`_, 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 targeting the rest of the Matrix
+federation.
+
+Your new Matrix ID will be formed partly from the ``server_name``, and partly
+from a localpart you specify when you create the account in 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 'Username' box.
+
+🎯 Troubleshooting and support
+==============================
+
+🚀 Professional support
+-----------------------
+
+Enterprise quality support for Synapse including SLAs is available as part of an
+`Element Server Suite (ESS) <https://element.io/pricing>`_ subscription.
+
+If you are an existing ESS subscriber then you can raise a `support request <https://ems.element.io/support>`_
+and access the `knowledge base <https://ems-docs.element.io>`_.
+
+🤝 Community support
+--------------------
+
+The `Admin FAQ <https://element-hq.github.io/synapse/latest/usage/administration/admin_faq.html>`_
+includes tips on dealing with some common problems. For more details, see
+`Synapse's wider documentation <https://element-hq.github.io/synapse/latest/>`_.
+
+For additional support installing or managing Synapse, please ask in the community
+support room |room|_ (from a matrix.org account if necessary). We do not use GitHub
+issues for support requests, only for bug reports and feature requests.
+
+.. |room| replace:: ``#synapse:matrix.org``
+.. _room: https://matrix.to/#/#synapse:matrix.org
+
+.. |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.
+
+**Identity servers do not store accounts or credentials - these are stored and managed on homeservers.
+Identity Servers are just for mapping 3rd Party IDs to Matrix IDs.**
+
+This process is highly security-sensitive, as there is an 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
+<https://github.com/matrix-org/matrix-doc/issues/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 <https://github.com/matrix-org/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 <https://element-hq.github.io/synapse/latest/development/contributing_guide.html>`_.
+This is part of our broader `documentation <https://element-hq.github.io/synapse/latest>`_, which includes
+information for Synapse developers as well as Synapse administrators.
+
+Developers might be particularly interested in:
+
+* `Synapse's database schema <https://element-hq.github.io/synapse/latest/development/database_schema.html>`_,
+* `notes on Synapse's implementation details <https://element-hq.github.io/synapse/latest/development/internal_documentation/index.html>`_, and
+* `how we use git <https://element-hq.github.io/synapse/latest/development/git.html>`_.
+
+Alongside all that, join our developer community on Matrix:
+`#synapse-dev:matrix.org <https://matrix.to/#/#synapse-dev:matrix.org>`_, featuring real humans!
+
+Copyright and Licensing
+=======================
+
+| Copyright 2014-2017 OpenMarket Ltd
+| Copyright 2017 Vector Creations Ltd
+| Copyright 2017-2025 New Vector Ltd
+|
+
+This software is dual-licensed by New Vector Ltd (Element). It can be used either:
+
+(1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR
+
+(2) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to).
+
+Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.
+
+Please contact `licensing@element.io <mailto:licensing@element.io>`_ to purchase an Element commercial license for this software.
+
+
+.. |support| image:: https://img.shields.io/badge/matrix-community%20support-success
+  :alt: (get community support in #synapse:matrix.org)
+  :target: https://matrix.to/#/#synapse:matrix.org
+
+.. |development| image:: https://img.shields.io/matrix/synapse-dev:matrix.org?label=development&logo=matrix
+  :alt: (discuss development on #synapse-dev:matrix.org)
+  :target: https://matrix.to/#/#synapse-dev:matrix.org
+
+.. |documentation| image:: https://img.shields.io/badge/documentation-%E2%9C%93-success
+  :alt: (Rendered documentation on GitHub Pages)
+  :target: https://element-hq.github.io/synapse/latest/
+
+.. |license| image:: https://img.shields.io/github/license/element-hq/synapse
+  :alt: (check license in LICENSE file)
+  :target: LICENSE
+
+.. |pypi| image:: https://img.shields.io/pypi/v/matrix-synapse
+  :alt: (latest version released on PyPi)
+  :target: https://pypi.org/project/matrix-synapse
+
+.. |python| image:: https://img.shields.io/pypi/pyversions/matrix-synapse
+  :alt: (supported python versions)
+  :target: https://pypi.org/project/matrix-synapse
+